org.kuali.rice.kim.service.impl
Class PersonServiceImpl

java.lang.Object
  org.kuali.rice.kim.service.impl.PersonServiceImpl

All Implemented Interfaces:

PersonService<PersonImpl>

public class PersonServiceImpl
extends Object
implements PersonService<PersonImpl>

This is a description of what this class does - kellerj don't forget to fill this in.

Author:

Kuali Rice Team (rice.collab@kuali.org)

Field Summary

protected Map<String,String>	baseLookupCriteria
private BusinessObjectMetaDataService	businessObjectMetaDataService
protected Map<String,String>	criteriaConversion
protected static String	ENTITY_ADDRESS_PROPERTY_PREFIX
protected static String	ENTITY_AFFILIATION_PROPERTY_PREFIX
protected static String	ENTITY_EMAIL_PROPERTY_PREFIX
protected static String	ENTITY_EMPLOYEE_ID_PROPERTY_PREFIX
protected static String	ENTITY_EXT_ID_PROPERTY_PREFIX
protected static String	ENTITY_NAME_PROPERTY_PREFIX
protected static String	ENTITY_PHONE_PROPERTY_PREFIX
protected static String	ENTITY_TYPE_PROPERTY_PREFIX
protected static String	EXTENSION
private IdentityManagementService	identityManagementService
private static org.apache.log4j.Logger	LOG
private MaintenanceDocumentDictionaryService	maintenanceDocumentDictionaryService
protected Map<String,MaxAgeSoftReference<PersonImpl>>	personCache
protected int	personCacheMaxAgeSeconds
protected int	personCacheMaxSize
protected ArrayList<String>	personCachePropertyNames
protected List<String>	personEntityTypeCodes
private String	personEntityTypeLookupCriteria
protected static String	PRINCIPAL_PROPERTY_PREFIX
private RoleManagementService	roleManagementService

Constructor Summary

PersonServiceImpl()

Method Summary

protected void	addPersonImplToCache(PersonImpl person)
protected PersonImpl	convertEntityToPerson(KimEntityDefaultInfo entity, KimPrincipal principal)
Map<String,String>	convertPersonPropertiesToEntityProperties(Map<String,String> criteria)
List<PersonImpl>	findPeople(Map<String,String> criteria) Perform an unbounded search for person records.
List<PersonImpl>	findPeople(Map<String,String> criteria, boolean unbounded) Perform a Person lookup.
protected List<PersonImpl>	findPeopleInternal(Map<String,String> criteria, boolean unbounded)
void	flushPersonCaches() Flush all of the role-related caches.
protected BusinessObjectMetaDataService	getBusinessObjectMetaDataService()
protected IdentityManagementService	getIdentityManagementService()
protected MaintenanceDocumentDictionaryService	getMaintenanceDocumentDictionaryService()
private Map<String,String>	getNonPersonSearchCriteria(BusinessObject bo, Map<String,String> fieldValues) Builds a map containing entries from the passed in Map that do NOT represent properties on an embedded Person object.
protected List<PersonImpl>	getPeople(Collection<String> principalIds)
PersonImpl	getPerson(String principalId) Retrieve a single Person object by Principal ID.
PersonImpl	getPersonByEmployeeId(String employeeId) Gets a single Person by their employee id.
List<PersonImpl>	getPersonByExternalIdentifier(String externalIdentifierTypeCode, String externalId) Retrieve a person by an arbitrary external identifier.
PersonImpl	getPersonByPrincipalName(String principalName) Gets a single Person by their principal name (user ID).
List<String>	getPersonEntityTypeCodes() Get the entityTypeCode that can be associated with a Person.
Class<? extends Person>	getPersonImplementationClass() Get the class object which points to the class used by the underlying implementation.
protected PersonImpl	getPersonImplFromEmployeeIdCache(String principalId)
protected PersonImpl	getPersonImplFromPrincipalIdCache(String principalId)
protected PersonImpl	getPersonImplFromPrincipalNameCache(String principalName)
protected RoleManagementService	getRoleManagementService()
boolean	hasPersonProperty(Class<? extends BusinessObject> businessObjectClass, Map<String,String> fieldValues) Checks whether the given set of search criteria contain any non-blank properties which need to be applied against a related Person object.
protected boolean	isAddressEntityCriteria(String propertyName)
protected boolean	isAffiliationEntityCriteria(String propertyName)
protected boolean	isEmailEntityCriteria(String propertyName)
protected boolean	isEmployeeIdEntityCriteria(String propertyName)
protected boolean	isExternalIdentifierEntityCriteria(String propertyName)
protected boolean	isNameEntityCriteria(String propertyName)
private boolean	isPersonProperty(BusinessObject bo, String propertyName)
protected boolean	isPhoneEntityCriteria(String propertyName)
protected List<String>	peopleToPrincipalIds(List<? extends Person> people)
Map<String,String>	resolvePrincipalNamesToPrincipalIds(BusinessObject businessObject, Map<String,String> fieldValues) This method takes a map on its way to populate a business object and replaces all user identifiers with their corresponding universal users
void	setPersonCacheMaxAgeSeconds(int personCacheMaxAgeSeconds)
void	setPersonCacheMaxSize(int personCacheMaxSize)
void	setPersonEntityTypeCodes(List<String> personEntityTypeCodes)
Person	updatePersonIfNecessary(String sourcePrincipalId, Person currentPerson) Compares the Principal ID passed in with that in the Person object.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

LOG

private static org.apache.log4j.Logger LOG

ENTITY_EXT_ID_PROPERTY_PREFIX

protected static final String ENTITY_EXT_ID_PROPERTY_PREFIX

See Also:

Constant Field Values

ENTITY_AFFILIATION_PROPERTY_PREFIX

protected static final String ENTITY_AFFILIATION_PROPERTY_PREFIX

See Also:

Constant Field Values

ENTITY_TYPE_PROPERTY_PREFIX

protected static final String ENTITY_TYPE_PROPERTY_PREFIX

See Also:

Constant Field Values

ENTITY_EMAIL_PROPERTY_PREFIX

protected static final String ENTITY_EMAIL_PROPERTY_PREFIX

See Also:

Constant Field Values

ENTITY_PHONE_PROPERTY_PREFIX

protected static final String ENTITY_PHONE_PROPERTY_PREFIX

See Also:

Constant Field Values

ENTITY_ADDRESS_PROPERTY_PREFIX

protected static final String ENTITY_ADDRESS_PROPERTY_PREFIX

See Also:

Constant Field Values

ENTITY_NAME_PROPERTY_PREFIX

protected static final String ENTITY_NAME_PROPERTY_PREFIX

See Also:

Constant Field Values

PRINCIPAL_PROPERTY_PREFIX

protected static final String PRINCIPAL_PROPERTY_PREFIX

See Also:

Constant Field Values

ENTITY_EMPLOYEE_ID_PROPERTY_PREFIX

protected static final String ENTITY_EMPLOYEE_ID_PROPERTY_PREFIX

See Also:

Constant Field Values

EXTENSION

protected static final String EXTENSION

See Also:

Constant Field Values

identityManagementService

private IdentityManagementService identityManagementService

roleManagementService

private RoleManagementService roleManagementService

businessObjectMetaDataService

private BusinessObjectMetaDataService businessObjectMetaDataService

maintenanceDocumentDictionaryService

private MaintenanceDocumentDictionaryService maintenanceDocumentDictionaryService

personCacheMaxSize

protected int personCacheMaxSize

personCacheMaxAgeSeconds

protected int personCacheMaxAgeSeconds

personCache

protected Map<String,MaxAgeSoftReference<PersonImpl>> personCache

personEntityTypeCodes

protected List<String> personEntityTypeCodes

personEntityTypeLookupCriteria

private String personEntityTypeLookupCriteria

baseLookupCriteria

protected Map<String,String> baseLookupCriteria

criteriaConversion

protected Map<String,String> criteriaConversion

personCachePropertyNames

protected ArrayList<String> personCachePropertyNames

Constructor Detail

PersonServiceImpl

public PersonServiceImpl()

Method Detail

getPerson

public PersonImpl getPerson(String principalId)

Description copied from interface: PersonService

Retrieve a single Person object by Principal ID.

Specified by:

getPerson in interface PersonService<PersonImpl>

See Also:

PersonService.getPerson(java.lang.String)

convertEntityToPerson

protected PersonImpl convertEntityToPerson(KimEntityDefaultInfo entity,
                                           KimPrincipal principal)

getPersonImplFromPrincipalNameCache

protected PersonImpl getPersonImplFromPrincipalNameCache(String principalName)

getPersonImplFromPrincipalIdCache

protected PersonImpl getPersonImplFromPrincipalIdCache(String principalId)

getPersonImplFromEmployeeIdCache

protected PersonImpl getPersonImplFromEmployeeIdCache(String principalId)

addPersonImplToCache

protected void addPersonImplToCache(PersonImpl person)

flushPersonCaches

public void flushPersonCaches()

Description copied from interface: PersonService

Flush all of the role-related caches.

Specified by:

flushPersonCaches in interface PersonService<PersonImpl>

getPersonByPrincipalName

public PersonImpl getPersonByPrincipalName(String principalName)

Description copied from interface: PersonService

Gets a single Person by their principal name (user ID).

Specified by:

getPersonByPrincipalName in interface PersonService<PersonImpl>

See Also:

PersonService.getPersonByPrincipalName(java.lang.String)

getPersonByEmployeeId

public PersonImpl getPersonByEmployeeId(String employeeId)

Description copied from interface: PersonService

Gets a single Person by their employee id.

Specified by:

getPersonByEmployeeId in interface PersonService<PersonImpl>

findPeople

public List<PersonImpl> findPeople(Map<String,String> criteria)

Description copied from interface: PersonService

Perform an unbounded search for person records.

Specified by:

findPeople in interface PersonService<PersonImpl>

See Also:

PersonService.findPeople(Map)

findPeople

public List<PersonImpl> findPeople(Map<String,String> criteria,
                                   boolean unbounded)

Description copied from interface: PersonService

Perform a Person lookup. If bounded, it will follow the configured KNS lookup limit.

Specified by:

findPeople in interface PersonService<PersonImpl>

See Also:

PersonService.findPeople(java.util.Map, boolean)

findPeopleInternal

protected List<PersonImpl> findPeopleInternal(Map<String,String> criteria,
                                              boolean unbounded)

convertPersonPropertiesToEntityProperties

public Map<String,String> convertPersonPropertiesToEntityProperties(Map<String,String> criteria)

isNameEntityCriteria

protected boolean isNameEntityCriteria(String propertyName)

isAddressEntityCriteria

protected boolean isAddressEntityCriteria(String propertyName)

isPhoneEntityCriteria

protected boolean isPhoneEntityCriteria(String propertyName)

isEmailEntityCriteria

protected boolean isEmailEntityCriteria(String propertyName)

isEmployeeIdEntityCriteria

protected boolean isEmployeeIdEntityCriteria(String propertyName)

isAffiliationEntityCriteria

protected boolean isAffiliationEntityCriteria(String propertyName)

isExternalIdentifierEntityCriteria

protected boolean isExternalIdentifierEntityCriteria(String propertyName)

getPersonEntityTypeCodes

public List<String> getPersonEntityTypeCodes()

Get the entityTypeCode that can be associated with a Person. This will determine where EntityType-related data is pulled from within the KimEntity object. The codes in the list will be examined in the order present.

setPersonEntityTypeCodes

public void setPersonEntityTypeCodes(List<String> personEntityTypeCodes)

getPeople

protected List<PersonImpl> getPeople(Collection<String> principalIds)

peopleToPrincipalIds

protected List<String> peopleToPrincipalIds(List<? extends Person> people)

getPersonByExternalIdentifier

public List<PersonImpl> getPersonByExternalIdentifier(String externalIdentifierTypeCode,
                                                      String externalId)

Description copied from interface: PersonService

Retrieve a person by an arbitrary external identifier. This method could potentially return multiple results as there is no guarantee of uniqueness for external identifiers.

Specified by:

getPersonByExternalIdentifier in interface PersonService<PersonImpl>

Parameters:

externalIdentifierTypeCode - Type of external identifier to search for.

externalId - The external identifier.

Returns:

List of Person objects.

See Also:

PersonService.getPersonByExternalIdentifier(java.lang.String, java.lang.String)

updatePersonIfNecessary

public Person updatePersonIfNecessary(String sourcePrincipalId,
                                      Person currentPerson)

Description copied from interface: PersonService

Compares the Principal ID passed in with that in the Person object. If they are the same, it returns the original object. Otherwise, it pulls the Person from KIM based on the sourcePrincipalId.

Specified by:

updatePersonIfNecessary in interface PersonService<PersonImpl>

See Also:

PersonService.updatePersonIfNecessary(java.lang.String, org.kuali.rice.kim.bo.Person)

getNonPersonSearchCriteria

private Map<String,String> getNonPersonSearchCriteria(BusinessObject bo,
                                                      Map<String,String> fieldValues)

Builds a map containing entries from the passed in Map that do NOT represent properties on an embedded Person object.

isPersonProperty

private boolean isPersonProperty(BusinessObject bo,
                                 String propertyName)

hasPersonProperty

public boolean hasPersonProperty(Class<? extends BusinessObject> businessObjectClass,
                                 Map<String,String> fieldValues)

Description copied from interface: PersonService

Checks whether the given set of search criteria contain any non-blank properties which need to be applied against a related Person object. This would be used by the lookup service to determine if special steps need to be taken when performing a search.

Specified by:

hasPersonProperty in interface PersonService<PersonImpl>

See Also:

PersonService.hasPersonProperty(java.lang.Class, java.util.Map)

resolvePrincipalNamesToPrincipalIds

public Map<String,String> resolvePrincipalNamesToPrincipalIds(BusinessObject businessObject,
                                                              Map<String,String> fieldValues)

Description copied from interface: PersonService

This method takes a map on its way to populate a business object and replaces all user identifiers with their corresponding universal users

Specified by:

resolvePrincipalNamesToPrincipalIds in interface PersonService<PersonImpl>

See Also:

PersonService.resolvePrincipalNamesToPrincipalIds(org.kuali.rice.kns.bo.BusinessObject, java.util.Map)

getIdentityManagementService

protected IdentityManagementService getIdentityManagementService()

getRoleManagementService

protected RoleManagementService getRoleManagementService()

getPersonImplementationClass

public Class<? extends Person> getPersonImplementationClass()

Description copied from interface: PersonService

Get the class object which points to the class used by the underlying implementation. This can be used by implementors who may need to construct Person objects without wishing to bind their code to a specific implementation.

Specified by:

getPersonImplementationClass in interface PersonService<PersonImpl>

getBusinessObjectMetaDataService

protected BusinessObjectMetaDataService getBusinessObjectMetaDataService()

getMaintenanceDocumentDictionaryService

protected MaintenanceDocumentDictionaryService getMaintenanceDocumentDictionaryService()

setPersonCacheMaxSize

public void setPersonCacheMaxSize(int personCacheMaxSize)

setPersonCacheMaxAgeSeconds

public void setPersonCacheMaxAgeSeconds(int personCacheMaxAgeSeconds)