org.picketlink.idm.ldap.internal

Class LDAPIdentityStore

java.lang.Object

org.picketlink.idm.ldap.internal.LDAPIdentityStore

All Implemented Interfaces:

org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

@CredentialHandlers(value=LDAPPlainTextPasswordCredentialHandler.class)
public class LDAPIdentityStore
extends Object
implements org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

An IdentityStore implementation backed by an LDAP directory

Author:

Shane Bryzak, Anil Saldhana, Pedro Silva

Constructor Summary

Constructors

Constructor and Description
LDAPIdentityStore()

Method Summary

Methods

Modifier and Type	Method and Description
void	add(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.AttributedType attributedType)
<T extends org.picketlink.idm.model.IdentityType> int	countQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.IdentityQuery<T> identityQuery)
<T extends org.picketlink.idm.model.Relationship> int	countQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.RelationshipQuery<T> query)
<T extends org.picketlink.idm.model.IdentityType> List<T>	fetchQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.IdentityQuery<T> identityQuery)
<T extends org.picketlink.idm.model.Relationship> List<T>	fetchQueryResults(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.query.RelationshipQuery<T> query)
org.picketlink.idm.model.Agent	getAgent(org.picketlink.idm.spi.SecurityContext context, String loginName)
<T extends Serializable> org.picketlink.idm.model.Attribute<T>	getAttribute(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.IdentityType identityType, String attributeName)
org.picketlink.idm.config.LDAPIdentityStoreConfiguration	getConfig()
org.picketlink.idm.model.Group	getGroup(org.picketlink.idm.spi.SecurityContext context, String groupPath)
org.picketlink.idm.model.Group	getGroup(org.picketlink.idm.spi.SecurityContext context, String name, org.picketlink.idm.model.Group parent)
protected LDAPOperationManager	getLDAPManager()
protected org.picketlink.idm.model.Group	getParentGroup(LDAPGroup childGroup, boolean loadAllHiearchy) Returns the parent group for the given child group.
protected List<org.picketlink.idm.model.Group>	getParentGroups(org.picketlink.idm.spi.SecurityContext context, LDAPGroup childGroup)
org.picketlink.idm.model.Role	getRole(org.picketlink.idm.spi.SecurityContext context, String name)
org.picketlink.idm.model.User	getUser(org.picketlink.idm.spi.SecurityContext context, String loginName)
protected LDAPAgent	lookupAgent(org.picketlink.idm.model.Agent agent)
protected LDAPAgent	lookupAgent(String loginName)
protected <T extends LDAPIdentityType> T	lookupEntryById(org.picketlink.idm.spi.SecurityContext context, Class<T> type, String id)
protected <T extends org.picketlink.idm.model.IdentityType> T	lookupEntryById(org.picketlink.idm.spi.SecurityContext context, T identityType)
protected LDAPGroup	lookupGroup(String groupPath)
protected LDAPGroup	lookupGroup(String groupPath, String baseDN)
protected LDAPRole	lookupRole(String name)
void	remove(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.AttributedType attributedType)
void	removeAttribute(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.IdentityType identityType, String attributeName)
void	setAttribute(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.IdentityType identityType, org.picketlink.idm.model.Attribute<? extends Serializable> attribute)
void	setup(org.picketlink.idm.config.LDAPIdentityStoreConfiguration config)
void	update(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.AttributedType attributedType)
void	updateCredential(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.model.Agent agent, Object credential, Date effectiveDate, Date expiryDate)
void	validateCredentials(org.picketlink.idm.spi.SecurityContext context, org.picketlink.idm.credential.Credentials credentials)

Methods inherited from class java.lang.Object

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

Constructor Detail

LDAPIdentityStore

public LDAPIdentityStore()

Method Detail

setup

public void setup(org.picketlink.idm.config.LDAPIdentityStoreConfiguration config)

Specified by:

setup in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

getConfig

public org.picketlink.idm.config.LDAPIdentityStoreConfiguration getConfig()

Specified by:

getConfig in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

add

public void add(org.picketlink.idm.spi.SecurityContext context,
       org.picketlink.idm.model.AttributedType attributedType)

Specified by:

add in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

update

public void update(org.picketlink.idm.spi.SecurityContext context,
          org.picketlink.idm.model.AttributedType attributedType)

Specified by:

update in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

remove

public void remove(org.picketlink.idm.spi.SecurityContext context,
          org.picketlink.idm.model.AttributedType attributedType)

Specified by:

remove in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

getAgent

public org.picketlink.idm.model.Agent getAgent(org.picketlink.idm.spi.SecurityContext context,
                                      String loginName)

Specified by:

getAgent in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

getUser

public org.picketlink.idm.model.User getUser(org.picketlink.idm.spi.SecurityContext context,
                                    String loginName)

Specified by:

getUser in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

getGroup

public org.picketlink.idm.model.Group getGroup(org.picketlink.idm.spi.SecurityContext context,
                                      String groupPath)

Specified by:

getGroup in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

getGroup

public org.picketlink.idm.model.Group getGroup(org.picketlink.idm.spi.SecurityContext context,
                                      String name,
                                      org.picketlink.idm.model.Group parent)

Specified by:

getGroup in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

getRole

public org.picketlink.idm.model.Role getRole(org.picketlink.idm.spi.SecurityContext context,
                                    String name)

Specified by:

getRole in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

fetchQueryResults

public <T extends org.picketlink.idm.model.IdentityType> List<T> fetchQueryResults(org.picketlink.idm.spi.SecurityContext context,
                                                                          org.picketlink.idm.query.IdentityQuery<T> identityQuery)

Specified by:

fetchQueryResults in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

countQueryResults

public <T extends org.picketlink.idm.model.IdentityType> int countQueryResults(org.picketlink.idm.spi.SecurityContext context,
                                                                      org.picketlink.idm.query.IdentityQuery<T> identityQuery)

Specified by:

countQueryResults in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

fetchQueryResults

public <T extends org.picketlink.idm.model.Relationship> List<T> fetchQueryResults(org.picketlink.idm.spi.SecurityContext context,
                                                                          org.picketlink.idm.query.RelationshipQuery<T> query)

Specified by:

fetchQueryResults in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

countQueryResults

public <T extends org.picketlink.idm.model.Relationship> int countQueryResults(org.picketlink.idm.spi.SecurityContext context,
                                                                      org.picketlink.idm.query.RelationshipQuery<T> query)

Specified by:

countQueryResults in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

setAttribute

public void setAttribute(org.picketlink.idm.spi.SecurityContext context,
                org.picketlink.idm.model.IdentityType identityType,
                org.picketlink.idm.model.Attribute<? extends Serializable> attribute)

Specified by:

setAttribute in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

getAttribute

public <T extends Serializable> org.picketlink.idm.model.Attribute<T> getAttribute(org.picketlink.idm.spi.SecurityContext context,
                                                                          org.picketlink.idm.model.IdentityType identityType,
                                                                          String attributeName)

Specified by:

getAttribute in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

removeAttribute

public void removeAttribute(org.picketlink.idm.spi.SecurityContext context,
                   org.picketlink.idm.model.IdentityType identityType,
                   String attributeName)

Specified by:

removeAttribute in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

validateCredentials

public void validateCredentials(org.picketlink.idm.spi.SecurityContext context,
                       org.picketlink.idm.credential.Credentials credentials)

Specified by:

validateCredentials in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

updateCredential

public void updateCredential(org.picketlink.idm.spi.SecurityContext context,
                    org.picketlink.idm.model.Agent agent,
                    Object credential,
                    Date effectiveDate,
                    Date expiryDate)

Specified by:

updateCredential in interface org.picketlink.idm.spi.IdentityStore<org.picketlink.idm.config.LDAPIdentityStoreConfiguration>

getLDAPManager

protected LDAPOperationManager getLDAPManager()

lookupEntryById

protected <T extends LDAPIdentityType> T lookupEntryById(org.picketlink.idm.spi.SecurityContext context,
                                             Class<T> type,
                                             String id)
                                              throws org.picketlink.idm.IdentityManagementException

Throws:

org.picketlink.idm.IdentityManagementException

getParentGroup

protected org.picketlink.idm.model.Group getParentGroup(LDAPGroup childGroup,
                                            boolean loadAllHiearchy)

Returns the parent group for the given child group.

Parameters:

childGroup -

Returns:

getParentGroups

protected List<org.picketlink.idm.model.Group> getParentGroups(org.picketlink.idm.spi.SecurityContext context,
                                                   LDAPGroup childGroup)

lookupEntryById

protected <T extends org.picketlink.idm.model.IdentityType> T lookupEntryById(org.picketlink.idm.spi.SecurityContext context,
                                                                  T identityType)
                                                                   throws org.picketlink.idm.IdentityManagementException

Throws:

org.picketlink.idm.IdentityManagementException

lookupRole

protected LDAPRole lookupRole(String name)

lookupAgent

protected LDAPAgent lookupAgent(String loginName)

lookupAgent

protected LDAPAgent lookupAgent(org.picketlink.idm.model.Agent agent)

lookupGroup

protected LDAPGroup lookupGroup(String groupPath)

lookupGroup

protected LDAPGroup lookupGroup(String groupPath,
                    String baseDN)