org.kuali.rice.kim.dao

Interface LdapPrincipalDao

All Known Implementing Classes:

LdapPrincipalDaoImpl

public interface LdapPrincipalDao

Interface class with public methods for accessing LDAP data store for entity information

Author:

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

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)
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)
Constants	getKimConstants()
org.springframework.ldap.core.LdapTemplate	getLdapTemplate()
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) In EDS, the principalId, principalName, and entityId will all be the same.
List<String>	lookupEntityIds(Map<String,String> searchCriteria)
<T> List<T>	search(Class<T> type, Map<String,Object> criteria)
void	setLdapTemplate(org.springframework.ldap.core.LdapTemplate template)

Method Detail

getLdapTemplate

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

setLdapTemplate

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

getPrincipal

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

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

getPrincipalByName

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

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

search

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

getEntityDefault

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

Find entity objects based on the given criteria.

getEntity

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

getEntityByPrincipalId

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

Parameters:

principalId - the principal id to look the entity up for

Returns:

the corresponding entity info

getEntityByPrincipalName

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

getEntityDefaultByPrincipalId

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

entityid and principalId are treated as the same.

See Also:

getEntityDefault(String)

getEntityDefaultByPrincipalName

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

lookupEntityIds

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

getEntityPrivacyPreferences

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

getDefaultNamesForPrincipalIds

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

getDefaultNamesForEntityIds

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

getContextMappers

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

getKimConstants

Constants getKimConstants()