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

java.lang.Object
  extended by org.kuali.rice.kim.impl.identity.IdentityServiceImpl
      extended by org.kuali.rice.kim.service.impl.LdapIdentityDelegateServiceImpl
All Implemented Interfaces:
IdentityService

public class LdapIdentityDelegateServiceImpl
extends IdentityServiceImpl

Implementation of IdentityService that communicates with and serves information from the UA Enterprise Directory Service.

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

Constructor Summary
LdapIdentityDelegateServiceImpl()
           
 
Method Summary
 Entity getEntity(String entityId)
          Gets a Entity from an id.
 Entity getEntityByPrincipalId(String principalId)
          Overridden to populate this information from the LdapPrincipalDao
 Entity getEntityByPrincipalName(String principalName)
          Gets a Entity from a principalName.
 EntityDefault getEntityDefault(String entityId)
          Gets a EntityDefault from an id.
 EntityDefault getEntityDefaultByPrincipalId(String principalId)
          Gets a EntityDefault from an principalId.
 EntityDefault getEntityDefaultByPrincipalName(String principalName)
          Gets a EntityDefault from an principalName.
 EntityPrivacyPreferences getEntityPrivacyPreferences(String entityId)
          Gets a EntityPrivacyPreferences for a given id.
 Principal getPrincipal(String principalId)
          Gets a Principal from an principalId.
 Principal getPrincipalByPrincipalName(String principalName)
          Gets a Principal from an principalName.
 Principal getPrincipalByPrincipalNameAndPassword(String principalName, String password)
          Deprecated. 
 LdapPrincipalDao getPrincipalDao()
           
 List<Principal> getPrincipals(List<String> principalIds)
          Gets a list of Principal from a string list of principalId.
 void setPrincipalDao(LdapPrincipalDao principalDao)
           
 
Methods inherited from class org.kuali.rice.kim.impl.identity.IdentityServiceImpl
addAddressToEntity, addAffiliationToEntity, addBioDemographicsToEntity, addCitizenshipToEntity, addEmailToEntity, addEmploymentToEntity, addEntityTypeContactInfoToEntity, addEthnicityToEntity, addExternalIdentifierToEntity, addNameToEntity, addPhoneToEntity, addPrincipalToEntity, addPrivacyPreferencesToEntity, addResidencyToEntity, addVisaToEntity, createEntity, findAllAddressTypes, findAllAffiliationTypes, findAllCitizenshipStatuses, findAllEmailTypes, findAllEmploymentStatuses, findAllEmploymentTypes, findAllEntityTypes, findAllExternalIdendtifierTypes, findAllNameTypes, findAllPhoneTypes, findEntities, findEntityDefaults, findNames, findPrincipals, getAddressType, getAffiliationType, getCitizenshipStatus, getDefaultNamesForPrincipalId, getEmailType, getEmploymentStatus, getEmploymentType, getEntityBoByEmployeeId, getEntityBoByPrincipalId, getEntityBoByPrincipalName, getEntityByEmployeeId, getEntityByKeyValue, getEntityDefaultByEmployeeId, getEntityType, getExternalIdentifierType, getNameType, getPhoneType, getPrincipalsByEmployeeId, getPrincipalsByEntityId, inactivateAddress, inactivateAffiliation, inactivateCitizenship, inactivateEmail, inactivateEmployment, inactivateEntity, inactivateEntityTypeContactInfo, inactivateName, inactivatePhone, inactivatePrincipal, inactivatePrincipalByName, setBusinessObjectService, setCriteriaLookupService, updateAddress, updateAffiliation, updateBioDemographics, updateCitizenship, updateEmail, updateEmployment, updateEntity, updateEntityTypeContactInfo, updateEthnicity, updateExternalIdentifier, updateName, updatePhone, updatePrincipal, updatePrivacyPreferences, updateResidency, updateVisa
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

LdapIdentityDelegateServiceImpl

public LdapIdentityDelegateServiceImpl()
Method Detail

getEntity

public Entity getEntity(String entityId)
Description copied from interface: IdentityService
Gets a Entity from an id.

This method will return null if the Entity does not exist.

Specified by:
getEntity in interface IdentityService
Overrides:
getEntity in class IdentityServiceImpl
Parameters:
entityId - the unique id to retrieve the entity by. cannot be null.
Returns:
a Entity or null

getEntityByPrincipalId

public Entity getEntityByPrincipalId(String principalId)
Overridden to populate this information from the LdapPrincipalDao

Specified by:
getEntityByPrincipalId in interface IdentityService
Overrides:
getEntityByPrincipalId in class IdentityServiceImpl
Parameters:
principalId - the unique id to retrieve the entity by. cannot be null.
Returns:
a Entity or null

getEntityByPrincipalName

public Entity getEntityByPrincipalName(String principalName)
Description copied from interface: IdentityService
Gets a Entity from a principalName.

This method will return null if the Entity does not exist.

Specified by:
getEntityByPrincipalName in interface IdentityService
Overrides:
getEntityByPrincipalName in class IdentityServiceImpl
Parameters:
principalName - the unique id to retrieve the entity by. cannot be null.
Returns:
a Entity or null

getEntityDefault

public EntityDefault getEntityDefault(String entityId)
Description copied from interface: IdentityService
Gets a EntityDefault from an id. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Specified by:
getEntityDefault in interface IdentityService
Overrides:
getEntityDefault in class IdentityServiceImpl
Parameters:
entityId - the unique id to retrieve the entity by. cannot be null.
Returns:
a EntityDefault or null

getEntityDefaultByPrincipalId

public EntityDefault getEntityDefaultByPrincipalId(String principalId)
Description copied from interface: IdentityService
Gets a EntityDefault from an principalId. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Specified by:
getEntityDefaultByPrincipalId in interface IdentityService
Overrides:
getEntityDefaultByPrincipalId in class IdentityServiceImpl
Parameters:
principalId - the unique id to retrieve the entity by. cannot be null.
Returns:
a EntityDefault or null

getEntityDefaultByPrincipalName

public EntityDefault getEntityDefaultByPrincipalName(String principalName)
Description copied from interface: IdentityService
Gets a EntityDefault from an principalName. EntityDefault is a condensed version of Entity that contains default values of its subclasses

This method will return null if the Entity does not exist.

Specified by:
getEntityDefaultByPrincipalName in interface IdentityService
Overrides:
getEntityDefaultByPrincipalName in class IdentityServiceImpl
Parameters:
principalName - the unique id to retrieve the entity by. cannot be null.
Returns:
a EntityDefault or null

getPrincipalByPrincipalNameAndPassword

@Deprecated
public Principal getPrincipalByPrincipalNameAndPassword(String principalName,
                                                                   String password)
Deprecated. 

Password lookups not supported by EDS. Use Natural Authentication strategies instead of this if that's what you need.

Specified by:
getPrincipalByPrincipalNameAndPassword in interface IdentityService
Overrides:
getPrincipalByPrincipalNameAndPassword in class IdentityServiceImpl
Parameters:
principalName - the unique id to retrieve the principal by. cannot be null.
password - the password for the principal
Returns:
a Principal or null

getEntityPrivacyPreferences

public EntityPrivacyPreferences getEntityPrivacyPreferences(String entityId)
Description copied from interface: IdentityService
Gets a EntityPrivacyPreferences for a given id.

This method will return null if the EntityPrivacyPreferences does not exist.

Specified by:
getEntityPrivacyPreferences in interface IdentityService
Overrides:
getEntityPrivacyPreferences in class IdentityServiceImpl
Parameters:
entityId - the unique id to retrieve the EntityPrivacyPreferences by. Cannot be null.
Returns:
a EntityPrivacyPreferences or null

getPrincipal

public Principal getPrincipal(String principalId)
Description copied from interface: IdentityService
Gets a Principal from an principalId.

This method will return null if the Principal does not exist.

Specified by:
getPrincipal in interface IdentityService
Overrides:
getPrincipal in class IdentityServiceImpl
Parameters:
principalId - the unique id to retrieve the principal by. cannot be null.
Returns:
a Principal or null

getPrincipals

public List<Principal> getPrincipals(List<String> principalIds)
Gets a list of Principal from a string list of principalId.

This method will only return principals that exist. It will return null if the none of the principals exist.

Specified by:
getPrincipals in interface IdentityService
Overrides:
getPrincipals in class IdentityServiceImpl
Parameters:
principalIds - the unique id to retrieve the principal by. cannot be null.
Returns:
a list of Principal or null
Throws:
RiceIllegalArgumentException - if the principalId is blank

getPrincipalByPrincipalName

public Principal getPrincipalByPrincipalName(String principalName)
Description copied from interface: IdentityService
Gets a Principal from an principalName.

This method will return null if the Principal does not exist.

Specified by:
getPrincipalByPrincipalName in interface IdentityService
Overrides:
getPrincipalByPrincipalName in class IdentityServiceImpl
Parameters:
principalName - the unique id to retrieve the principal by. cannot be null.
Returns:
a Principal or null

setPrincipalDao

public void setPrincipalDao(LdapPrincipalDao principalDao)

getPrincipalDao

public LdapPrincipalDao getPrincipalDao()


Copyright © 2005-2014 The Kuali Foundation. All Rights Reserved.