org.picketlink.idm.ldap.internal

Class LDAPIdentityStore

java.lang.Object

org.picketlink.idm.internal.AbstractIdentityStore<LDAPIdentityStoreConfiguration>

org.picketlink.idm.ldap.internal.LDAPIdentityStore

All Implemented Interfaces:

CredentialStore<LDAPIdentityStoreConfiguration>, IdentityStore<LDAPIdentityStoreConfiguration>

@CredentialHandlers(value=LDAPPlainTextPasswordCredentialHandler.class)
public class LDAPIdentityStore
extends AbstractIdentityStore<LDAPIdentityStoreConfiguration>
implements CredentialStore<LDAPIdentityStoreConfiguration>

An IdentityStore implementation backed by an LDAP directory

Author:

Shane Bryzak, Anil Saldhana, Pedro Silva

Field Summary

Fields

Modifier and Type	Field and Description
static String	EMPTY_ATTRIBUTE_VALUE
static String	ENTRY_DN_ATTRIBUTE_NAME

Constructor Summary

Constructors

Constructor and Description
LDAPIdentityStore()

Method Summary

Modifier and Type	Method and Description
void	addAttributedType(IdentityContext context, AttributedType attributedType)
protected void	addToParentAsMember(AttributedType attributedType)
protected <V extends IdentityType> StringBuilder	createIdentityTypeSearchFilter(IdentityQuery<V> identityQuery, LDAPMappingConfiguration ldapEntryConfig)
protected BasicAttributes	extractAttributes(AttributedType attributedType, boolean isCreate)
<V extends IdentityType> List<V>	fetchQueryResults(IdentityContext context, IdentityQuery<V> identityQuery)
<V extends Relationship> List<V>	fetchQueryResults(IdentityContext context, RelationshipQuery<V> query)
String	getBindingDN(AttributedType attributedType)
String	getBindingDN(AttributedType attributedType, boolean appendBaseDN)
protected String	getEntryIdentifier(AttributedType attributedType)
LDAPOperationManager	getOperationManager()
void	removeAttributedType(IdentityContext context, AttributedType attributedType)
void	removeCredential(IdentityContext context, Account account, Class<? extends CredentialStorage> storageClass) Removes all credentials stored by a certain CredentialStorage associated with the given Account.
protected void	removeCredentials(IdentityContext context, Account account)
protected void	removeFromRelationships(IdentityContext context, IdentityType identityType)
<T extends CredentialStorage> List<T>	retrieveCredentials(IdentityContext context, Account account, Class<T> storageClass) Returns a list of all credential state of the specified T, for the specified Account.
<T extends CredentialStorage> T	retrieveCurrentCredential(IdentityContext context, Account account, Class<T> storageClass) Returns the currently active credential state of the specified T, for the specified Account.
void	setup(LDAPIdentityStoreConfiguration config) Sets the configuration and context in which the IdentityStore will execute its operations
void	storeCredential(IdentityContext context, Account account, CredentialStorage storage) Stores the specified credential state.
void	updateAttributedType(IdentityContext context, AttributedType attributedType)

Methods inherited from class org.picketlink.idm.internal.AbstractIdentityStore

add, countQueryResults, countQueryResults, getConfig, remove, update, updateCredential, validateCredentials

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.picketlink.idm.spi.IdentityStore

add, countQueryResults, countQueryResults, getConfig, remove, update, updateCredential, validateCredentials

Field Detail

EMPTY_ATTRIBUTE_VALUE

public static final String EMPTY_ATTRIBUTE_VALUE

See Also:

Constant Field Values

ENTRY_DN_ATTRIBUTE_NAME

public static final String ENTRY_DN_ATTRIBUTE_NAME

See Also:

Constant Field Values

Constructor Detail

LDAPIdentityStore

public LDAPIdentityStore()

Method Detail

setup

public void setup(LDAPIdentityStoreConfiguration config)

Description copied from interface: IdentityStore

Sets the configuration and context in which the IdentityStore will execute its operations

Specified by:

setup in interface IdentityStore<LDAPIdentityStoreConfiguration>

Overrides:

setup in class AbstractIdentityStore<LDAPIdentityStoreConfiguration>

addAttributedType

public void addAttributedType(IdentityContext context,
                              AttributedType attributedType)

Overrides:

addAttributedType in class AbstractIdentityStore<LDAPIdentityStoreConfiguration>

updateAttributedType

public void updateAttributedType(IdentityContext context,
                                 AttributedType attributedType)

Specified by:

updateAttributedType in class AbstractIdentityStore<LDAPIdentityStoreConfiguration>

removeAttributedType

public void removeAttributedType(IdentityContext context,
                                 AttributedType attributedType)

Specified by:

removeAttributedType in class AbstractIdentityStore<LDAPIdentityStoreConfiguration>

removeFromRelationships

protected void removeFromRelationships(IdentityContext context,
                                       IdentityType identityType)

Specified by:

removeFromRelationships in class AbstractIdentityStore<LDAPIdentityStoreConfiguration>

fetchQueryResults

public <V extends IdentityType> List<V> fetchQueryResults(IdentityContext context,
                                                          IdentityQuery<V> identityQuery)

Specified by:

fetchQueryResults in interface IdentityStore<LDAPIdentityStoreConfiguration>

fetchQueryResults

public <V extends Relationship> List<V> fetchQueryResults(IdentityContext context,
                                                          RelationshipQuery<V> query)

Specified by:

fetchQueryResults in interface IdentityStore<LDAPIdentityStoreConfiguration>

storeCredential

public void storeCredential(IdentityContext context,
                            Account account,
                            CredentialStorage storage)

Description copied from interface: CredentialStore

Stores the specified credential state.

Specified by:

storeCredential in interface CredentialStore<LDAPIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storage - The credential storage instance to be stored.

retrieveCurrentCredential

public <T extends CredentialStorage> T retrieveCurrentCredential(IdentityContext context,
                                                                 Account account,
                                                                 Class<T> storageClass)

Description copied from interface: CredentialStore

Returns the currently active credential state of the specified T, for the specified Account.

Specified by:

retrieveCurrentCredential in interface CredentialStore<LDAPIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storageClass - The credential storage type specifying which credential types should be removed.

Returns:

retrieveCredentials

public <T extends CredentialStorage> List<T> retrieveCredentials(IdentityContext context,
                                                                 Account account,
                                                                 Class<T> storageClass)

Description copied from interface: CredentialStore

Returns a list of all credential state of the specified T, for the specified Account.

Specified by:

retrieveCredentials in interface CredentialStore<LDAPIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storageClass - The credential storage type specifying which credential types should be removed.

Returns:

removeCredential

public void removeCredential(IdentityContext context,
                             Account account,
                             Class<? extends CredentialStorage> storageClass)

Description copied from interface: CredentialStore

Removes all credentials stored by a certain CredentialStorage associated with the given Account.

Specified by:

removeCredential in interface CredentialStore<LDAPIdentityStoreConfiguration>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storageClass - The credential storage type specifying which credential types should be removed.

removeCredentials

protected void removeCredentials(IdentityContext context,
                                 Account account)

Specified by:

removeCredentials in class AbstractIdentityStore<LDAPIdentityStoreConfiguration>

createIdentityTypeSearchFilter

protected <V extends IdentityType> StringBuilder createIdentityTypeSearchFilter(IdentityQuery<V> identityQuery,
                                                                                LDAPMappingConfiguration ldapEntryConfig)

extractAttributes

protected BasicAttributes extractAttributes(AttributedType attributedType,
                                            boolean isCreate)

getOperationManager

public LDAPOperationManager getOperationManager()

getBindingDN

public String getBindingDN(AttributedType attributedType,
                           boolean appendBaseDN)

getBindingDN

public String getBindingDN(AttributedType attributedType)

addToParentAsMember

protected void addToParentAsMember(AttributedType attributedType)

getEntryIdentifier

protected String getEntryIdentifier(AttributedType attributedType)