org.kuali.rice.kim.dao.impl

Class LdapPrincipalDaoImpl

java.lang.Object

org.kuali.rice.kim.dao.impl.LdapPrincipalDaoImpl

All Implemented Interfaces:

LdapPrincipalDao

public class LdapPrincipalDaoImpl
extends Object
implements LdapPrincipalDao

Integrated Data Access via LDAP to EDS. Provides implementation to interface method for using Spring-LDAP to communicate with EDS.

Author:

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

Constructor Summary

Constructors

Constructor and Description
LdapPrincipalDaoImpl()

Method Summary

Modifier and Type	Method and Description
Map<String,org.springframework.ldap.core.ContextMapper>	getContextMappers()
Map<String,org.kuali.rice.kim.api.identity.principal.EntityNamePrincipalName>	getDefaultNamesForEntityIds(List<String> entityIds)
Map<String,org.kuali.rice.kim.api.identity.principal.EntityNamePrincipalName>	getDefaultNamesForPrincipalIds(List<String> principalIds)
org.kuali.rice.kim.api.identity.entity.Entity	getEntity(String entityId) FIND entity objects based on the given criteria.
org.kuali.rice.kim.api.identity.entity.Entity	getEntityByPrincipalId(String principalId) Fetches full entity info, populated from EDS, based on the Entity's principal id
org.kuali.rice.kim.api.identity.entity.Entity	getEntityByPrincipalName(String principalName)
org.kuali.rice.kim.api.identity.entity.EntityDefault	getEntityDefault(String entityId) Find entity objects based on the given criteria.
org.kuali.rice.kim.api.identity.entity.EntityDefault	getEntityDefaultByPrincipalId(String principalId) entityid and principalId are treated as the same.
org.kuali.rice.kim.api.identity.entity.EntityDefault	getEntityDefaultByPrincipalName(String principalName)
org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences	getEntityPrivacyPreferences(String entityId)
protected Matcher	getKimAttributeMatcher(String kimAttribute)
Constants	getKimConstants()
protected String	getLdapAttribute(String kimAttribute)
protected Map<String,Object>	getLdapLookupCriteria(Map<String,String> searchCriteria) Converts Kuali Lookup parameters into LDAP query parameters
org.springframework.ldap.core.LdapTemplate	getLdapTemplate()
protected Object	getLdapValue(String kimAttribute)
org.kuali.rice.coreservice.framework.parameter.ParameterService	getParameterService()
org.kuali.rice.kim.api.identity.principal.Principal	getPrincipal(String principalId) In EDS, the principalId, principalName, and entityId will all be the same.
org.kuali.rice.kim.api.identity.principal.Principal	getPrincipalByName(String principalName) Assuming he principalId, principalName, and entityId will all be the same.
protected SearchControls	getSearchControls()
protected boolean	isMapped(String kimAttribute)
List<org.kuali.rice.kim.api.identity.entity.EntityDefault>	lookupEntityDefault(Map<String,String> searchCriteria, boolean unbounded)
List<String>	lookupEntityIds(Map<String,String> searchCriteria)
<T> List<T>	search(Class<T> type, Map<String,Object> criteria)
void	setContextMappers(Map<String,org.springframework.ldap.core.ContextMapper> contextMappers)
void	setKimConstants(Constants constants)
void	setLdapTemplate(org.springframework.ldap.core.LdapTemplate template)
void	setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService service)

Methods inherited from class java.lang.Object

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

Constructor Detail

LdapPrincipalDaoImpl

public LdapPrincipalDaoImpl()

Method Detail

getPrincipal

public org.kuali.rice.kim.api.identity.principal.Principal getPrincipal(String principalId)

In EDS, the principalId, principalName, and entityId will all be the same.

Specified by:

getPrincipal in interface LdapPrincipalDao

getPrincipalByName

public org.kuali.rice.kim.api.identity.principal.Principal getPrincipalByName(String principalName)

Assuming he principalId, principalName, and entityId will all be the same.

Specified by:

getPrincipalByName in interface LdapPrincipalDao

search

public <T> List<T> search(Class<T> type,
                          Map<String,Object> criteria)

Specified by:

search in interface LdapPrincipalDao

getSearchControls

protected SearchControls getSearchControls()

getEntity

public org.kuali.rice.kim.api.identity.entity.Entity getEntity(String entityId)

FIND entity objects based on the given criteria.

Specified by:

getEntity in interface LdapPrincipalDao

Parameters:

entityId - of user/person to grab entity information for

Returns:

Entity

getEntityByPrincipalId

public org.kuali.rice.kim.api.identity.entity.Entity getEntityByPrincipalId(String principalId)

Fetches full entity info, populated from EDS, based on the Entity's principal id

Specified by:

getEntityByPrincipalId in interface LdapPrincipalDao

Parameters:

principalId - the principal id to look the entity up for

Returns:

the corresponding entity info

getEntityDefault

public org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefault(String entityId)

Description copied from interface: LdapPrincipalDao

Find entity objects based on the given criteria.

Specified by:

getEntityDefault in interface LdapPrincipalDao

getEntityDefaultByPrincipalId

public org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultByPrincipalId(String principalId)

entityid and principalId are treated as the same.

Specified by:

getEntityDefaultByPrincipalId in interface LdapPrincipalDao

See Also:

#getEntityDefaultInfo(String)

getEntityDefaultByPrincipalName

public org.kuali.rice.kim.api.identity.entity.EntityDefault getEntityDefaultByPrincipalName(String principalName)

Specified by:

getEntityDefaultByPrincipalName in interface LdapPrincipalDao

getEntityByPrincipalName

public org.kuali.rice.kim.api.identity.entity.Entity getEntityByPrincipalName(String principalName)

Specified by:

getEntityByPrincipalName in interface LdapPrincipalDao

lookupEntityDefault

public List<org.kuali.rice.kim.api.identity.entity.EntityDefault> lookupEntityDefault(Map<String,String> searchCriteria,
                                                                                      boolean unbounded)

lookupEntityIds

public List<String> lookupEntityIds(Map<String,String> searchCriteria)

Specified by:

lookupEntityIds in interface LdapPrincipalDao

getLdapLookupCriteria

protected Map<String,Object> getLdapLookupCriteria(Map<String,String> searchCriteria)

Converts Kuali Lookup parameters into LDAP query parameters

Parameters:

searchCriteria - kuali lookup info

Returns:

Map of LDAP query info

getEntityPrivacyPreferences

public org.kuali.rice.kim.api.identity.privacy.EntityPrivacyPreferences getEntityPrivacyPreferences(String entityId)

Specified by:

getEntityPrivacyPreferences in interface LdapPrincipalDao

getDefaultNamesForPrincipalIds

public Map<String,org.kuali.rice.kim.api.identity.principal.EntityNamePrincipalName> getDefaultNamesForPrincipalIds(List<String> principalIds)

Specified by:

getDefaultNamesForPrincipalIds in interface LdapPrincipalDao

getDefaultNamesForEntityIds

public Map<String,org.kuali.rice.kim.api.identity.principal.EntityNamePrincipalName> getDefaultNamesForEntityIds(List<String> entityIds)

Specified by:

getDefaultNamesForEntityIds in interface LdapPrincipalDao

getKimAttributeMatcher

protected Matcher getKimAttributeMatcher(String kimAttribute)

isMapped

protected boolean isMapped(String kimAttribute)

getLdapAttribute

protected String getLdapAttribute(String kimAttribute)

getLdapValue

protected Object getLdapValue(String kimAttribute)

setKimConstants

public void setKimConstants(Constants constants)

getKimConstants

public Constants getKimConstants()

Specified by:

getKimConstants in interface LdapPrincipalDao

getParameterService

public org.kuali.rice.coreservice.framework.parameter.ParameterService getParameterService()

setParameterService

public void setParameterService(org.kuali.rice.coreservice.framework.parameter.ParameterService service)

getLdapTemplate

public org.springframework.ldap.core.LdapTemplate getLdapTemplate()

Specified by:

getLdapTemplate in interface LdapPrincipalDao

setLdapTemplate

public void setLdapTemplate(org.springframework.ldap.core.LdapTemplate template)

Specified by:

setLdapTemplate in interface LdapPrincipalDao

getContextMappers

public Map<String,org.springframework.ldap.core.ContextMapper> getContextMappers()

Specified by:

getContextMappers in interface LdapPrincipalDao

setContextMappers

public void setContextMappers(Map<String,org.springframework.ldap.core.ContextMapper> contextMappers)