Merged 5.2.N (5.2.1) to HEAD (5.2)

132107 gjames: SEARCH-227: Adding additional display information for facetting api


git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@132335 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/rest/api/lookups/MimeTypePropertyLookup.java

@@ -0,0 +1,71 @@
+/*-
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.api.lookups;
+
+import org.alfresco.service.ServiceRegistry;
+import org.alfresco.service.namespace.NamespaceService;
+import org.alfresco.service.namespace.QName;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Looks up mimetype values
+ * Pass in a mimetype value and a display string is returned.
+ * @author Gethin James
+ */
+public class MimeTypePropertyLookup implements PropertyLookup<String>
+{
+    private Set<String> supported = new HashSet<>();
+    private ServiceRegistry serviceRegistry;
+
+    @Override
+    public String lookup(String propertyValue)
+    {
+        Map<String,String> mimetypes = serviceRegistry.getMimetypeService().getDisplaysByMimetype();
+        return mimetypes.get(propertyValue);
+    }
+
+    @Override
+    public Set<String> supports()
+    {
+        return supported;
+    }
+
+    public void setServiceRegistry(ServiceRegistry serviceRegistry)
+    {
+        this.serviceRegistry = serviceRegistry;
+    }
+
+    public void setSupported(List<String> supported)
+    {
+        this.supported.add(QName.createQName(NamespaceService.CONTENT_MODEL_1_0_URI, "content.mimetype").toString());
+        this.supported.addAll(supported);
+    }
+
+}

source/java/org/alfresco/rest/api/lookups/PersonPropertyLookup.java

@@ -0,0 +1,76 @@
+/*-
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+package org.alfresco.rest.api.lookups;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.repo.transaction.TransactionalResourceHelper;
+import org.alfresco.rest.api.impl.NodesImpl;
+import org.alfresco.rest.api.model.Node;
+import org.alfresco.rest.api.model.UserInfo;
+import org.alfresco.service.ServiceRegistry;
+
+import java.util.HashSet;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Looks up information about a person.
+ * Pass in a userId and the display name is returned.
+ *
+ * @author Gethin James
+ */
+public class PersonPropertyLookup implements PropertyLookup<String>
+{
+    private Set<String> supported = new HashSet<>();
+    private ServiceRegistry serviceRegistry;
+
+    @Override
+    public String lookup(String propertyValue)
+    {
+        Map<String, UserInfo> mapUserInfo = TransactionalResourceHelper.getMap("PERSON_PROPERTY_LOOKUP_USER_INFO_CACHE");
+        UserInfo user = Node.lookupUserInfo(propertyValue, mapUserInfo, serviceRegistry.getPersonService());
+        if (user != null) return user.getDisplayName();
+        return null;
+    }
+
+    @Override
+    public Set<String> supports()
+    {
+        return supported;
+    }
+
+    public void setSupported(List<String> supported)
+    {
+        NodesImpl.PROPS_USERLOOKUP.forEach(entry -> this.supported.add(entry.toString()));
+        this.supported.addAll(supported);
+    }
+
+    public void setServiceRegistry(ServiceRegistry serviceRegistry)
+    {
+        this.serviceRegistry = serviceRegistry;
+    }
+}

source/java/org/alfresco/rest/api/lookups/PropertyLookup.java

@@ -0,0 +1,52 @@
+/*-
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+
+package org.alfresco.rest.api.lookups;
+
+
+import java.util.List;
+import java.util.Set;
+
+/**
+ * Looks up property values for the api
+ *
+ * @author Gethin James
+ */
+public interface PropertyLookup<T extends Object>
+{
+    /**
+     * The list of property keys that are supported by this class
+     * @return Set<String> property keys
+     */
+    public Set<String> supports();
+
+    /**
+     * Lookup the property value with a new value.
+     * @param propertyValue
+     * @return a new value or null if the property value isn't found.
+     */
+    public T lookup(String propertyValue);
+}

source/java/org/alfresco/rest/api/lookups/PropertyLookupRegistry.java

@@ -0,0 +1,88 @@
+/*-
+ * #%L
+ * Alfresco Remote API
+ * %%
+ * Copyright (C) 2005 - 2016 Alfresco Software Limited
+ * %%
+ * This file is part of the Alfresco software. 
+ * If the software was purchased under a paid Alfresco license, the terms of 
+ * the paid license agreement will prevail.  Otherwise, the software is 
+ * provided under the following open source license terms:
+ * 
+ * Alfresco is free software: you can redistribute it and/or modify
+ * it under the terms of the GNU Lesser General Public License as published by
+ * the Free Software Foundation, either version 3 of the License, or
+ * (at your option) any later version.
+ * 
+ * Alfresco is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+ * GNU Lesser General Public License for more details.
+ * 
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with Alfresco. If not, see <http://www.gnu.org/licenses/>.
+ * #L%
+ */
+
+package org.alfresco.rest.api.lookups;
+
+
+import org.apache.commons.logging.Log;
+import org.apache.commons.logging.LogFactory;
+import org.springframework.context.ApplicationContext;
+import org.springframework.context.ApplicationEvent;
+import org.springframework.context.event.ContextRefreshedEvent;
+import org.springframework.extensions.surf.util.AbstractLifecycleBean;
+
+import java.util.HashMap;
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+/**
+ * Acts as a central point for property lookups
+ *
+ * @author Gethin James
+ */
+public class PropertyLookupRegistry
+{
+    private static Log logger = LogFactory.getLog(PropertyLookupRegistry.class);
+    Map<String, PropertyLookup> propertyLookups = new HashMap<>();
+
+    /**
+     * Set the supported property lookup classes.
+     * @param lookups
+     */
+    public void setLookups(List<PropertyLookup> lookups)
+    {
+        lookups.forEach(entry ->
+        {
+            entry.supports().forEach( propKey -> propertyLookups.put((String) propKey, entry) );
+        });
+    }
+
+    /**
+     * The list of property keys that are supported by this class
+     * @return Set<String> property keys
+     */
+    public Set<String> supports()
+    {
+        return propertyLookups.keySet();
+    }
+
+    /**
+     * Looks up the property value using a PropertyLookup
+     * @param propertyName the property name/type
+     * @param propertyValue the value to lookup
+     * @return Object to be serialized as json
+     */
+    public Object lookup(String propertyName, String propertyValue)
+    {
+        PropertyLookup lookup = propertyLookups.get(propertyName);
+        if (lookup != null)
+        {
+            return lookup.lookup(propertyValue);
+        }
+        return null;
+    }
+}