Transactional safe cache added to PersonServiceImpl to cache person NodeRefs against usernames.

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

config/alfresco/authentication-services-context.xml

@@ -173,26 +173,30 @@
     -->
     
 
-
-
     <!-- The person service.                                                -->
 
-    <bean id="personService" class="org.alfresco.repo.security.person.PersonServiceImpl">
+    <bean id="personService" class="org.alfresco.repo.security.person.PersonServiceImpl" init-method="init">
-		<property name="nodeService">
+        <property name="nodeService">
-		    <ref bean="nodeService" />
+            <ref bean="nodeService" />
-		</property>
+        </property>
-		<property name="searchService">
+        <property name="searchService">
-		    <ref bean="admSearchService" />
+            <ref bean="admSearchService" />
-		</property>
+        </property>
-		<property name="permissionServiceSPI">
+        <property name="permissionServiceSPI">
-			<ref bean="permissionServiceImpl" />
+            <ref bean="permissionServiceImpl" />
-		</property>
+        </property>
         <property name="authorityService">
            <ref bean="authorityService" />
         </property>
-		<property name="namespacePrefixResolver">
+        <property name="namespacePrefixResolver">
-			<ref bean="namespaceService" />
+            <ref bean="namespaceService" />
-		</property>
+        </property>
+        <property name="policyComponent">
+            <ref bean="policyComponent"/>
+        </property>
+        <property name="personCache">
+            <ref bean="personCache" />
+        </property>
         <!-- Configurable properties.                                 -->
         <!--                                                          -->
         <!-- TODO:                                                    -->
@@ -214,7 +218,7 @@
         <property name="createMissingPeople">
            <value>${server.transaction.allow-writes}</value>
         </property>
-		<property name="userNamesAreCaseSensitive">
+        <property name="userNamesAreCaseSensitive">
           <value>${user.name.caseSensitive}</value>
         </property>
         <!-- New properties after 1.4.0 to deal with duplicate user ids when found -->
@@ -235,20 +239,20 @@
 
     <bean name="homeFolderManager" class="org.alfresco.repo.security.person.HomeFolderManager">
         <property name="nodeService">
-		    <ref bean="nodeService" />
+            <ref bean="nodeService" />
-		</property>
+        </property>
         <property name="policyComponent">
-		    <ref bean="policyComponent" />
+            <ref bean="policyComponent" />
-		</property>
+        </property>
         <property name="defaultProvider">
-		    <ref bean="personalHomeFolderProvider" />
+            <ref bean="personalHomeFolderProvider" />
-		</property>
+        </property>
     </bean>
     
     <bean name="companyHomeFolderProvider" class="org.alfresco.repo.security.person.ExistingPathBasedHomeFolderProvider">
         <property name="serviceRegistry">
-		    <ref bean="ServiceRegistry" />
+            <ref bean="ServiceRegistry" />
-		</property>
+        </property>
         <property name="path">
            <value>/${spaces.company_home.childname}</value>
         </property>
@@ -256,14 +260,14 @@
            <value>${spaces.store}</value>
         </property>
         <property name="homeFolderManager">
-			<ref bean="homeFolderManager" />
+            <ref bean="homeFolderManager" />
-		</property>
+        </property>
     </bean>
     
     <bean name="guestHomeFolderProvider" class="org.alfresco.repo.security.person.ExistingPathBasedHomeFolderProvider">
         <property name="serviceRegistry">
-		    <ref bean="ServiceRegistry" />
+            <ref bean="ServiceRegistry" />
-		</property>
+        </property>
         <property name="path">
            <value>/${spaces.company_home.childname}/${spaces.guest_home.childname}</value>
         </property>
@@ -271,8 +275,8 @@
            <value>${spaces.store}</value>
         </property>
         <property name="homeFolderManager">
-			<ref bean="homeFolderManager" />
+            <ref bean="homeFolderManager" />
-		</property>
+        </property>
         <property name="userPemissions">
             <set>
                 <value>Consumer</value>
@@ -282,14 +286,14 @@
     
     <bean name="bootstrapHomeFolderProvider" class="org.alfresco.repo.security.person.BootstrapHomeFolderProvider">
         <property name="homeFolderManager">
-			<ref bean="homeFolderManager" />
+            <ref bean="homeFolderManager" />
-		</property>
+        </property>
     </bean>
     
     <bean name="personalHomeFolderProvider" class="org.alfresco.repo.security.person.UIDBasedHomeFolderProvider">
         <property name="serviceRegistry">
-		    <ref bean="ServiceRegistry" />
+            <ref bean="ServiceRegistry" />
-		</property>
+        </property>
         <property name="path">
            <value>/${spaces.company_home.childname}</value>
         </property>
@@ -297,8 +301,8 @@
            <value>${spaces.store}</value>
         </property>
         <property name="homeFolderManager">
-			<ref bean="homeFolderManager" />
+            <ref bean="homeFolderManager" />
-		</property>
+        </property>
         <property name="inheritsPermissionsOnCreate">
             <value>false</value>
         </property>
@@ -313,11 +317,11 @@
             </set>
         </property>
     </bean>
-	
+    
-	<bean name="userHomesHomeFolderProvider" class="org.alfresco.repo.security.person.UIDBasedHomeFolderProvider">
+    <bean name="userHomesHomeFolderProvider" class="org.alfresco.repo.security.person.UIDBasedHomeFolderProvider">
         <property name="serviceRegistry">
-		    <ref bean="ServiceRegistry" />
+            <ref bean="ServiceRegistry" />
-		</property>
+        </property>
         <property name="path">
            <value>/${spaces.company_home.childname}/${spaces.user_homes.childname}</value>
         </property>
@@ -325,8 +329,8 @@
            <value>${spaces.store}</value>
         </property>
         <property name="homeFolderManager">
-			<ref bean="homeFolderManager" />
+            <ref bean="homeFolderManager" />
-		</property>
+        </property>
         <property name="inheritsPermissionsOnCreate">
             <value>false</value>
         </property>

config/alfresco/cache-context.xml

@@ -207,5 +207,42 @@
          <value>10</value>
       </property>
    </bean>
+   
+   <!-- ===================================== -->
+   <!-- Person username to NodeRef cache      -->
+   <!-- ===================================== -->
+
+   <!-- The cross-transaction shared cache for Person -->
+   
+   <bean name="personSharedCache" class="org.alfresco.repo.cache.EhCacheAdapter">
+      <property name="cache">
+         <bean class="org.springframework.cache.ehcache.EhCacheFactoryBean" >
+            <property name="cacheManager">
+               <ref bean="internalEHCacheManager" />
+            </property>
+            <property name="cacheName">
+               <value>org.alfresco.cache.personCache</value>
+            </property>
+         </bean>
+      </property>
+   </bean>
+   
+   <!-- The transactional cache for Person -->
+   
+   <bean name="personCache" class="org.alfresco.repo.cache.TransactionalCache">
+      <property name="sharedCache">
+         <ref bean="personSharedCache" />
+      </property>
+      <property name="cacheManager" >
+         <ref bean="transactionalEHCacheManager" />
+      </property>
+      <!-- Eh cache area -->
+      <property name="name">
+         <value>org.alfresco.personTransactionalCache</value>
+      </property>
+      <property name="maxCacheSize">
+         <value>1000</value>
+      </property>
+   </bean>
 
 </beans>

source/java/org/alfresco/repo/security/person/PersonServiceImpl.java

@@ -35,8 +35,12 @@ import java.util.Set;
 
 import org.alfresco.error.AlfrescoRuntimeException;
 import org.alfresco.model.ContentModel;
-import org.alfresco.repo.security.authentication.ldap.LDAPPersonExportSource;
+import org.alfresco.repo.cache.SimpleCache;
+import org.alfresco.repo.node.NodeServicePolicies;
+import org.alfresco.repo.policy.JavaBehaviour;
+import org.alfresco.repo.policy.PolicyComponent;
 import org.alfresco.repo.security.permissions.PermissionServiceSPI;
+import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.NodeService;
 import org.alfresco.service.cmr.repository.StoreRef;
@@ -49,12 +53,14 @@ import org.alfresco.service.cmr.security.AuthorityService;
 import org.alfresco.service.cmr.security.NoSuchPersonException;
 import org.alfresco.service.cmr.security.PersonService;
 import org.alfresco.service.namespace.NamespacePrefixResolver;
+import org.alfresco.service.namespace.NamespaceService;
 import org.alfresco.service.namespace.QName;
 import org.alfresco.util.GUID;
 import org.apache.commons.logging.Log;
 import org.apache.commons.logging.LogFactory;
 
-public class PersonServiceImpl implements PersonService
+public class PersonServiceImpl implements PersonService,
+    NodeServicePolicies.OnCreateNodePolicy, NodeServicePolicies.BeforeDeleteNodePolicy
 {
     private static Log s_logger = LogFactory.getLog(PersonServiceImpl.class);
 
@@ -81,6 +87,8 @@ public class PersonServiceImpl implements PersonService
     private PermissionServiceSPI permissionServiceSPI;
 
     private NamespacePrefixResolver namespacePrefixResolver;
+    
+    private PolicyComponent policyComponent;
 
     private boolean createMissingPeople;
 
@@ -97,6 +105,9 @@ public class PersonServiceImpl implements PersonService
     private boolean lastIsBest = true;
 
     private boolean includeAutoCreated = false;
+    
+    /** a transactionally-safe cache to be injected */
+    private SimpleCache<String, NodeRef> personCache;
 
     static
     {
@@ -110,9 +121,19 @@ public class PersonServiceImpl implements PersonService
         mutableProperties = Collections.unmodifiableSet(props);
     }
 
-    public PersonServiceImpl()
+    /**
+     * Spring bean init method
+     */
+    public void init()
     {
-        super();
+        this.policyComponent.bindClassBehaviour(
+                QName.createQName(NamespaceService.ALFRESCO_URI, "onCreateNode"),
+                ContentModel.TYPE_PERSON,
+                new JavaBehaviour(this, "onCreateNode"));
+        this.policyComponent.bindClassBehaviour(
+                QName.createQName(NamespaceService.ALFRESCO_URI, "beforeDeleteNode"),
+                ContentModel.TYPE_PERSON,
+                new JavaBehaviour(this, "beforeDeleteNode"));
     }
 
     public boolean getUserNamesAreCaseSensitive()
@@ -149,7 +170,27 @@ public class PersonServiceImpl implements PersonService
     {
         this.processDuplicates = processDuplicates;
     }
+    
+    /**
+     * Set the username to person cache.
+     * 
+     * @param personCache     a transactionally safe cache
+     */
+    public void setPersonCache(SimpleCache<String, NodeRef> personCache)
+    {
+        this.personCache = personCache;
+    }
 
+    /**
+     * Retrieve the person NodeRef for a username key. Depending on configuration missing people
+     * will be created if not found, else a NoSuchPersonException exception will be thrown.
+     * 
+     * @param userName of the person NodeRef to retrieve
+     * 
+     * @return NodeRef of the person as specified by the username
+     * 
+     * @throws NoSuchPersonException
+     */
     public NodeRef getPerson(String userName)
     {
         NodeRef personNode = getPersonOrNull(userName);
@@ -163,7 +204,6 @@ public class PersonServiceImpl implements PersonService
             {
                 throw new NoSuchPersonException(userName);
             }
-
         }
         else
         {
@@ -176,83 +216,86 @@ public class PersonServiceImpl implements PersonService
         return getPersonOrNull(caseSensitiveUserName) != null;
     }
 
-    public NodeRef getPersonOrNull(String searchUserName)
+    private NodeRef getPersonOrNull(String searchUserName)
     {
-        NodeRef returnRef = null;
+        NodeRef returnRef = this.personCache.get(searchUserName);
-
+        if (returnRef == null)
-        SearchParameters sp = new SearchParameters();
-        sp.setLanguage(SearchService.LANGUAGE_LUCENE);
-        sp.setQuery("TYPE:\\{http\\://www.alfresco.org/model/content/1.0\\}person +@cm\\:userName:\""
-                + searchUserName + "\"");
-        sp.addStore(storeRef);
-        sp.excludeDataInTheCurrentTransaction(false);
-
-        ResultSet rs = null;
-
-        boolean singleton = true;
-
-        try
         {
-            rs = searchService.query(sp);
+            SearchParameters sp = new SearchParameters();
-
+            sp.setLanguage(SearchService.LANGUAGE_LUCENE);
-            for (ResultSetRow row : rs)
+            sp.setQuery("@cm\\:userName:\"" + searchUserName + "\"");
+            sp.addStore(storeRef);
+            sp.excludeDataInTheCurrentTransaction(false);
+    
+            ResultSet rs = null;
+    
+            boolean singleton = true;
+    
+            try
             {
-
+                rs = searchService.query(sp);
-                NodeRef nodeRef = row.getNodeRef();
+    
-                if (nodeService.exists(nodeRef))
+                for (ResultSetRow row : rs)
                 {
-                    String realUserName = DefaultTypeConverter.INSTANCE.convert(String.class, nodeService.getProperty(
+                    NodeRef nodeRef = row.getNodeRef();
-                            nodeRef, ContentModel.PROP_USERNAME));
+                    if (nodeService.exists(nodeRef))
-
-                    if (userNamesAreCaseSensitive)
                     {
-                        if (realUserName.equals(searchUserName))
+                        String realUserName = DefaultTypeConverter.INSTANCE.convert(String.class, nodeService.getProperty(
+                                nodeRef, ContentModel.PROP_USERNAME));
+    
+                        if (userNamesAreCaseSensitive)
                         {
-                            if (returnRef == null)
+                            if (realUserName.equals(searchUserName))
                             {
-                                returnRef = nodeRef;
+                                if (returnRef == null)
-                            }
+                                {
-                            else
+                                    returnRef = nodeRef;
-                            {
+                                }
-                                singleton = false;
+                                else
-                                break;
+                                {
+                                    singleton = false;
+                                    break;
+                                }
                             }
                         }
-                    }
+                        else
-                    else
-                    {
-                        if (realUserName.equalsIgnoreCase(searchUserName))
                         {
-                            if (returnRef == null)
+                            if (realUserName.equalsIgnoreCase(searchUserName))
                             {
-                                returnRef = nodeRef;
+                                if (returnRef == null)
-                            }
+                                {
-                            else
+                                    returnRef = nodeRef;
-                            {
+                                }
-                                singleton = false;
+                                else
-                                break;
+                                {
+                                    singleton = false;
+                                    break;
+                                }
                             }
                         }
                     }
                 }
             }
-        }
+            finally
-        finally
-        {
-            if (rs != null)
             {
-                rs.close();
+                if (rs != null)
+                {
+                    rs.close();
+                }
             }
+            if (singleton)
+            {
+                returnRef = returnRef;
+            }
+            else
+            {
+                returnRef = handleDuplicates(searchUserName);
+            }
+            
+            // add to cache
+            this.personCache.put(searchUserName, returnRef);
         }
-
+        return returnRef;
-        if (singleton)
-        {
-            return returnRef;
-        }
-        else
-        {
-            return handleDuplicates(searchUserName);
-        }
     }
 
     private NodeRef handleDuplicates(String searchUserName)
@@ -298,8 +341,7 @@ public class PersonServiceImpl implements PersonService
     {
         SearchParameters sp = new SearchParameters();
         sp.setLanguage(SearchService.LANGUAGE_LUCENE);
-        sp.setQuery("TYPE:\\{http\\://www.alfresco.org/model/content/1.0\\}person +@cm\\:userName:\""
+        sp.setQuery("@cm\\:userName:\"" + searchUserName + "\"");
-                + searchUserName + "\"");
         sp.addStore(storeRef);
         sp.excludeDataInTheCurrentTransaction(false);
 
@@ -349,8 +391,7 @@ public class PersonServiceImpl implements PersonService
     {
         SearchParameters sp = new SearchParameters();
         sp.setLanguage(SearchService.LANGUAGE_LUCENE);
-        sp.setQuery("TYPE:\\{http\\://www.alfresco.org/model/content/1.0\\}person +@cm\\:userName:\""
+        sp.setQuery("@cm\\:userName:\"" + searchUserName + "\"");
-                + searchUserName + "\"");
         sp.addStore(storeRef);
         sp.excludeDataInTheCurrentTransaction(false);
 
@@ -402,8 +443,7 @@ public class PersonServiceImpl implements PersonService
     {
         SearchParameters sp = new SearchParameters();
         sp.setLanguage(SearchService.LANGUAGE_LUCENE);
-        sp.setQuery("TYPE:\\{http\\://www.alfresco.org/model/content/1.0\\}person +@cm\\:userName:\""
+        sp.setQuery("@cm\\:userName:\"" + searchUserName + "\"");
-                + searchUserName + "\"");
         sp.addStore(storeRef);
         sp.excludeDataInTheCurrentTransaction(false);
         if (lastIsBest)
@@ -646,7 +686,30 @@ public class PersonServiceImpl implements PersonService
         }
         return nodes;
     }
+    
+    // Policies
 
+    /* (non-Javadoc)
+     * @see org.alfresco.repo.node.NodeServicePolicies.OnCreateNodePolicy#onCreateNode(org.alfresco.service.cmr.repository.ChildAssociationRef)
+     */
+    public void onCreateNode(ChildAssociationRef childAssocRef)
+    {
+        NodeRef personRef = childAssocRef.getChildRef();
+        String username = (String)this.nodeService.getProperty(personRef, ContentModel.PROP_USERNAME);
+        this.personCache.put(username, personRef);
+    }
+    
+    /* (non-Javadoc)
+     * @see org.alfresco.repo.node.NodeServicePolicies.BeforeDeleteNodePolicy#beforeDeleteNode(org.alfresco.service.cmr.repository.NodeRef)
+     */
+    public void beforeDeleteNode(NodeRef nodeRef)
+    {
+        String username = (String)this.nodeService.getProperty(nodeRef, ContentModel.PROP_USERNAME);
+        this.personCache.remove(username);
+    }
+
+    // IOC Setters
+    
     public void setCreateMissingPeople(boolean createMissingPeople)
     {
         this.createMissingPeople = createMissingPeople;
@@ -676,6 +739,11 @@ public class PersonServiceImpl implements PersonService
     {
         this.searchService = searchService;
     }
+    
+    public void setPolicyComponent(PolicyComponent policyComponent)
+    {
+        this.policyComponent = policyComponent;
+    }
 
     public void setStoreUrl(String storeUrl)
     {
@@ -693,7 +761,4 @@ public class PersonServiceImpl implements PersonService
         }
         return null;
     }
-
-    // IOC Setters
-
 }