Merged BRANCHES/DEV/V4.1-BUG-FIX to HEAD

47670: ALF-18245 - BM-0013: Soak: Run 06: Search population of ScriptNode is expensive
          - Optimizations to improve the performance of the repository when retrieving the populating data needed for Share Search results
          - Additional service method to PersonService to allow retrieval of a person or null in a single operation - rather than exists() followed get()
          - Improvements to generate of full name strings for a Person - only retrieve minimum needed properties rather than allprops from cm:person
          - Improvements to generation of DisplayPath to avoid multiple permission checks

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@47674 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261
This commit is contained in:
Kevin Roast
2013-03-06 16:52:09 +00:00
parent 6652e37815
commit 80887b8462
7 changed files with 122 additions and 25 deletions

View File

@@ -863,6 +863,7 @@
<property name="objectDefinitionSource">
<value>
org.alfresco.service.cmr.security.PersonService.getPerson=ACL_ALLOW,AFTER_ACL_NODE.sys:base.ReadProperties
org.alfresco.service.cmr.security.PersonService.getPersonOrNull=ACL_ALLOW,AFTER_ACL_NODE.sys:base.ReadProperties
org.alfresco.service.cmr.security.PersonService.personExists=ACL_ALLOW
org.alfresco.service.cmr.security.PersonService.createMissingPeople=ACL_ALLOW
org.alfresco.service.cmr.security.PersonService.setCreateMissingPeople=ACL_METHOD.ROLE_ADMINISTRATOR

View File

@@ -67,6 +67,7 @@
<property name="serviceRegistry">
<ref bean="ServiceRegistry"/>
</property>
<property name="nodeService" ref="nodeService"/>
</bean>
<bean id="testScript" parent="baseJavaScriptExtension" class="org.alfresco.repo.jscript.ScriptTestUtils">

View File

@@ -838,22 +838,40 @@ public final class People extends BaseScopableProcessorExtension implements Init
return people;
}
/**
* Gets the Person given the username
*
* @param username the username of the person to get
* @return the person node (type cm:person) or null if no such person exists
*/
public ScriptNode getPerson(String username)
public ScriptNode getPerson(final String username)
{
ParameterCheck.mandatoryString("Username", username);
ScriptNode person = null;
if (personService.personExists(username))
{
NodeRef personRef = personService.getPerson(username);
person = new ScriptNode(personRef, services, getScope());
final NodeRef personRef = personService.getPerson(username, false);
return new ScriptNode(personRef, services, getScope());
}
return person;
/**
* Faster helper when the script just wants to build the Full name for a person.
* Avoids complete getProperties() retrieval for a cm:person.
*
* @param username the username of the person to get Full name for
* @return full name for a person or null if the user does not exist in the system.
*/
public String getPersonFullName(final String username)
{
String name = null;
ParameterCheck.mandatoryString("Username", username);
final NodeRef personRef = personService.getPersonOrNull(username);
if (personRef != null)
{
final NodeService nodeService = services.getNodeService();
final String firstName = (String)nodeService.getProperty(personRef, ContentModel.PROP_FIRSTNAME);
final String lastName = (String)nodeService.getProperty(personRef, ContentModel.PROP_LASTNAME);
name = (firstName != null ? firstName + " " : "") + (lastName != null ? lastName : "");
}
return name;
}
/**

View File

@@ -22,10 +22,12 @@ import java.util.Date;
import java.util.Locale;
import java.util.Map;
import org.alfresco.repo.security.permissions.noop.PermissionServiceNOOPImpl;
import org.alfresco.service.ServiceRegistry;
import org.alfresco.service.cmr.module.ModuleDetails;
import org.alfresco.service.cmr.module.ModuleService;
import org.alfresco.service.cmr.repository.NodeRef;
import org.alfresco.service.cmr.repository.NodeService;
import org.alfresco.service.namespace.NamespaceService;
import org.alfresco.service.namespace.QName;
import org.alfresco.util.ScriptPagingDetails;
@@ -44,6 +46,9 @@ public class ScriptUtils extends BaseScopableProcessorExtension
/** Services */
private ServiceRegistry services;
private NodeService unprotNodeService;
/**
* Sets the service registry
*
@@ -54,6 +59,26 @@ public class ScriptUtils extends BaseScopableProcessorExtension
this.services = services;
}
/**
* @param nodeService the NodeService to set
*/
public void setNodeService(NodeService nodeService)
{
this.unprotNodeService = nodeService;
}
/**
* Function to return the cm:name display path for a node with minimum performance overhead.
*
* @param node ScriptNode
* @return cm:name based human readable display path for the give node.
*/
public String displayPath(ScriptNode node)
{
return this.unprotNodeService.getPath(node.nodeRef).toDisplayPath(
this.unprotNodeService, new PermissionServiceNOOPImpl());
}
/**
* Function to pad a string with zero '0' characters to the required length
*

View File

@@ -417,22 +417,53 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per
/**
* {@inheritDoc}
*/
public NodeRef getPerson(final String userName, final boolean autoCreateHomeFolderAndMissingPersonIfAllowed)
public NodeRef getPersonOrNull(String userName)
{
return getPersonImpl(userName, autoCreateHomeFolderAndMissingPersonIfAllowed);
return getPerson(userName, false, false);
}
private NodeRef getPersonImpl(String userName, boolean autoCreateHomeFolderAndMissingPersonIfAllowed)
/**
* {@inheritDoc}
*/
public NodeRef getPerson(final String userName, final boolean autoCreateHomeFolderAndMissingPersonIfAllowed)
{
if(userName == null)
return getPerson(userName, autoCreateHomeFolderAndMissingPersonIfAllowed, true);
}
private NodeRef getPerson(
final String userName,
final boolean autoCreateHomeFolderAndMissingPersonIfAllowed,
final boolean exceptionOrNull)
{
// MT share - for activity service system callback
if (tenantService.isEnabled() && (AuthenticationUtil.SYSTEM_USER_NAME.equals(AuthenticationUtil.getRunAsUser())) && tenantService.isTenantUser(userName))
{
final String tenantDomain = tenantService.getUserDomain(userName);
return AuthenticationUtil.runAs(new AuthenticationUtil.RunAsWork<NodeRef>()
{
public NodeRef doWork() throws Exception
{
return getPersonImpl(userName, autoCreateHomeFolderAndMissingPersonIfAllowed, exceptionOrNull);
}
}, tenantService.getDomainUser(AuthenticationUtil.getSystemUserName(), tenantDomain));
}
else
{
return getPersonImpl(userName, autoCreateHomeFolderAndMissingPersonIfAllowed, exceptionOrNull);
}
}
private NodeRef getPersonImpl(
final String userName,
final boolean autoCreateHomeFolderAndMissingPersonIfAllowed,
final boolean exceptionOrNull)
{
if (userName == null || userName.length() == 0)
{
return null;
}
if(userName.length() == 0)
{
return null;
}
NodeRef personNode = getPersonOrNull(userName);
final NodeRef personNode = getPersonOrNullImpl(userName);
if (personNode == null)
{
TxnReadState txnReadState = AlfrescoTransactionSupport.getTransactionReadState();
@@ -443,10 +474,13 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per
return createMissingPerson(userName, true);
}
else
{
if (exceptionOrNull)
{
throw new NoSuchPersonException(userName);
}
}
}
else if (autoCreateHomeFolderAndMissingPersonIfAllowed)
{
makeHomeFolderIfRequired(personNode);
@@ -459,10 +493,10 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per
*/
public boolean personExists(String caseSensitiveUserName)
{
return getPersonOrNull(caseSensitiveUserName) != null;
return getPersonOrNullImpl(caseSensitiveUserName) != null;
}
private NodeRef getPersonOrNull(String searchUserName)
private NodeRef getPersonOrNullImpl(String searchUserName)
{
Set<NodeRef> allRefs = getFromCache(searchUserName);
boolean addToCache = false;
@@ -738,7 +772,7 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per
*/
public void setPersonProperties(String userName, Map<QName, Serializable> properties, boolean autoCreateHomeFolder)
{
NodeRef personNode = getPersonOrNull(userName);
NodeRef personNode = getPersonOrNullImpl(userName);
if (personNode == null)
{
if (createMissingPeople())
@@ -1077,7 +1111,7 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per
return;
}
NodeRef personRef = getPersonOrNull(userName);
NodeRef personRef = getPersonOrNullImpl(userName);
deletePersonImpl(userName, personRef);
}
@@ -1715,7 +1749,7 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per
private void putToCache(String userName, Set<NodeRef> refs)
{
String key = userName.toLowerCase();
if(AlfrescoTransactionSupport.getTransactionId() != null && !TransactionalResourceHelper.getSet(DELETING_PERSON_SET_RESOURCE).contains(key))
if (AlfrescoTransactionSupport.getTransactionId() != null && !TransactionalResourceHelper.getSet(DELETING_PERSON_SET_RESOURCE).contains(key))
{
this.personCache.put(key, refs);
}
@@ -1733,7 +1767,7 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per
*/
public String getUserIdentifier(String caseSensitiveUserName)
{
NodeRef nodeRef = getPersonOrNull(caseSensitiveUserName);
NodeRef nodeRef = getPersonOrNullImpl(caseSensitiveUserName);
if ((nodeRef != null) && nodeService.exists(nodeRef))
{
String realUserName = DefaultTypeConverter.INSTANCE.convert(String.class, nodeService.getProperty(nodeRef, ContentModel.PROP_USERNAME));
@@ -1857,7 +1891,7 @@ public class PersonServiceImpl extends TransactionListenerAdapter implements Per
return;
}
// Get the person
NodeRef personNodeRef = getPersonOrNull(userName);
NodeRef personNodeRef = getPersonOrNullImpl(userName);
if (personNodeRef == null)
{
// Don't attempt to maintain enabled/disabled flag

View File

@@ -362,6 +362,8 @@ public class PersonTest extends TestCase
}
personService.createPerson(createDefaultProperties("andy", "Andy", "Hind", "andy@hind", "alfresco", rootNodeRef));
personService.getPerson("andy");
// test getting with getPersonOrNull
assertNotNull(personService.getPersonOrNull("andy"));
personService.deletePerson("andy");
try
{
@@ -372,6 +374,8 @@ public class PersonTest extends TestCase
{
}
// test getting with getPersonOrNull - no exception, just null returned
assertNull(personService.getPersonOrNull("andy"));
}
public void testCreateMissingPeople1()

View File

@@ -66,6 +66,20 @@ public interface PersonService
@Auditable(parameters = {"userName"})
public NodeRef getPerson(String userName);
/**
* Get a person by userName. The person is store in the repository. No missing
* person objects will be created as a side effect of this call. If the person
* is missing from the repository null will be returned.
*
* @param userName -
* the userName key to find the person
* @return Returns the existing person node, or null if does not exist.
*
* @see #createMissingPeople()
*/
@Auditable(parameters = {"userName"})
public NodeRef getPersonOrNull(String userName);
/**
* Retrieve the person NodeRef for a {@code username}, optionally creating
* the home folder if it does not exist and optionally creating the person