org.picketlink.idm.internal

Class ContextualIdentityManager

java.lang.Object

org.picketlink.idm.internal.AbstractAttributedTypeManager<IdentityType>

org.picketlink.idm.internal.ContextualIdentityManager

All Implemented Interfaces:

AttributedTypeManager<IdentityType>, IdentityManager

public class ContextualIdentityManager
extends AbstractAttributedTypeManager<IdentityType>
implements IdentityManager

Default implementation of the IdentityManager interface.

This lightweight class is intended to be created any time a batch of partition-specific identity management operations are to be performed. In a web environment, it is recommended that instances are scoped to the web request lifecycle.

This class is not thread-safe.

Author:

Shane Bryzak, anil saldhana

Field Summary

Fields inherited from interface org.picketlink.idm.IdentityManager

IDENTITY_MANAGER_CTX_PARAMETER

Constructor Summary

Constructors

Constructor and Description
ContextualIdentityManager(Partition partition, DefaultPartitionManager partitionManager)

Method Summary

Modifier and Type	Method and Description
protected void	checkIfExists(IdentityType identityType)
protected void	checkUniqueness(IdentityType identityType)
protected IdentityContext	createIdentityContext(Partition partition, EventBridge eventBridge, IdGenerator idGenerator)
<T extends IdentityType> IdentityQuery<T>	createIdentityQuery(Class<T> identityType) Creates an IdentityQuery that can be used to query for IdentityType instances.
protected void	doAdd(IdentityType attributedType)
protected void	doRemove(IdentityType attributedType)
protected void	doUpdate(IdentityType attributedType)
protected void	fireAttributedTypeAddedEvent(IdentityType attributedType)
protected void	fireAttributedTypeRemovedEvent(IdentityType attributedType)
protected void	fireAttributedTypeUpdatedEvent(IdentityType attributedType)
IdentityQueryBuilder	getQueryBuilder() Returns a IdentityQueryBuilder, responsible for building queries.
<C extends IdentityType> C	lookupById(Class<C> attributedType, String id) Retrieves an AttributedType with the given identifier.
<T extends IdentityType> T	lookupIdentityById(Class<T> identityType, String id) Retrieves an IdentityType with the given identifier.
void	removeCredential(Account account, Class<? extends CredentialStorage> storageClass) Removes all credentials stored by a certain CredentialStorage associated with the given Account.
<T extends CredentialStorage> List<T>	retrieveCredentials(Account account, Class<T> storageClass) Returns a list of all stored credential values for the specified account and credential storage class
<T extends CredentialStorage> T	retrieveCurrentCredential(Account account, Class<T> storageClass) Returns the current stored credential value for the specific account and credential storage class
void	updateCredential(Account account, Object credential) Updates a credential for the given Account.
void	updateCredential(Account account, Object credential, Date effectiveDate, Date expiryDate) Updates a credential for the given Account.
void	validateCredentials(Credentials credentials) Validates the given Credentials.

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

add, addAttributes, fireEvent, getConfiguration, getEventBridge, getIdentityContext, getIdGenerator, getStoreSelector, remove, removeAllAttributes, removeAttributes, update

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.AttributedTypeManager

add, remove, update

Constructor Detail

ContextualIdentityManager

public ContextualIdentityManager(Partition partition,
                                 DefaultPartitionManager partitionManager)

Method Detail

doAdd

protected void doAdd(IdentityType attributedType)

Specified by:

doAdd in class AbstractAttributedTypeManager<IdentityType>

fireAttributedTypeAddedEvent

protected void fireAttributedTypeAddedEvent(IdentityType attributedType)

Specified by:

fireAttributedTypeAddedEvent in class AbstractAttributedTypeManager<IdentityType>

doUpdate

protected void doUpdate(IdentityType attributedType)

Specified by:

doUpdate in class AbstractAttributedTypeManager<IdentityType>

fireAttributedTypeUpdatedEvent

protected void fireAttributedTypeUpdatedEvent(IdentityType attributedType)

Specified by:

fireAttributedTypeUpdatedEvent in class AbstractAttributedTypeManager<IdentityType>

fireAttributedTypeRemovedEvent

protected void fireAttributedTypeRemovedEvent(IdentityType attributedType)

Specified by:

fireAttributedTypeRemovedEvent in class AbstractAttributedTypeManager<IdentityType>

doRemove

protected void doRemove(IdentityType attributedType)

Specified by:

doRemove in class AbstractAttributedTypeManager<IdentityType>

lookupIdentityById

public <T extends IdentityType> T lookupIdentityById(Class<T> identityType,
                                                     String id)

Description copied from interface: IdentityManager

Retrieves an IdentityType with the given identifier.

The first argument tells which IdentityType type should be returned. If you provide the IdentityType base interface any IdentityType instance that matches the given identifier will be returned.

Specified by:

lookupIdentityById in interface IdentityManager

Returns:

If no IdentityType is found with the given identifier this method returns null.

lookupById

public <C extends IdentityType> C lookupById(Class<C> attributedType,
                                             String id)
                                      throws IdentityManagementException

Description copied from interface: AttributedTypeManager

Retrieves an AttributedType with the given identifier.

The first argument tells which AttributedType type should be returned. If you provide the AttributedType base interface any AttributedType instance that matches the given identifier will be returned.

Specified by:

lookupById in interface AttributedTypeManager<IdentityType>

Returns:

If no AttributedType is found with the given identifier this method returns null.

Throws:

IdentityManagementException

createIdentityQuery

public <T extends IdentityType> IdentityQuery<T> createIdentityQuery(Class<T> identityType)

Description copied from interface: IdentityManager

Creates an IdentityQuery that can be used to query for IdentityType instances.

The first argument tells which IdentityType type should be returned. If you provide the IdentityType base interface any IdentityType instance that matches the provided query parameters will be returned.

Specified by:

createIdentityQuery in interface IdentityManager

Returns:

validateCredentials

public void validateCredentials(Credentials credentials)

Description copied from interface: IdentityManager

Validates the given Credentials.

To check the validation status you should use the Credentials.getStatus method.

Specified by:

validateCredentials in interface IdentityManager

updateCredential

public void updateCredential(Account account,
                             Object credential)

Description copied from interface: IdentityManager

Updates a credential for the given Account.

Specified by:

updateCredential in interface IdentityManager

credential - The credential must be a object supported by any CredentialHandler. Examples of credentials are the Password and Digest types.

updateCredential

public void updateCredential(Account account,
                             Object credential,
                             Date effectiveDate,
                             Date expiryDate)

Description copied from interface: IdentityManager

Updates a credential for the given Account.

This methods also allows to specify the expiration and effective date for the credential.

Specified by:

updateCredential in interface IdentityManager

credential - The credential must be a object supported by any CredentialHandler. Examples of credentials are the Password and Digest types.

retrieveCurrentCredential

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

Description copied from interface: IdentityManager

Returns the current stored credential value for the specific account and credential storage class

Specified by:

retrieveCurrentCredential in interface IdentityManager

Returns:

retrieveCredentials

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

Description copied from interface: IdentityManager

Returns a list of all stored credential values for the specified account and credential storage class

Specified by:

retrieveCredentials in interface IdentityManager

Returns:

removeCredential

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

Description copied from interface: IdentityManager

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

Specified by:

removeCredential in interface IdentityManager

Parameters:

account - The account which credentials should be removed.

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

getQueryBuilder

public IdentityQueryBuilder getQueryBuilder()

Description copied from interface: IdentityManager

Returns a IdentityQueryBuilder, responsible for building queries.

Specified by:

getQueryBuilder in interface IdentityManager

Returns:

createIdentityContext

protected IdentityContext createIdentityContext(Partition partition,
                                                EventBridge eventBridge,
                                                IdGenerator idGenerator)

Overrides:

createIdentityContext in class AbstractAttributedTypeManager<IdentityType>

checkIfExists

protected void checkIfExists(IdentityType identityType)
                      throws IdentityManagementException

Specified by:

checkIfExists in class AbstractAttributedTypeManager<IdentityType>

Throws:

IdentityManagementException

checkUniqueness

protected void checkUniqueness(IdentityType identityType)

Specified by:

checkUniqueness in class AbstractAttributedTypeManager<IdentityType>