org.picketlink.idm.internal

Class ContextualIdentityManager

java.lang.Object

org.picketlink.idm.internal.AbstractIdentityContext

org.picketlink.idm.internal.ContextualIdentityManager

All Implemented Interfaces:

IdentityManager, IdentityContext

public class ContextualIdentityManager
extends AbstractIdentityContext
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, EventBridge eventBridge, IdGenerator idGenerator, StoreSelector storeSelector, RelationshipManager relationshipManager)

Method Summary

Methods

Modifier and Type	Method and Description
void	add(IdentityType identityType) Adds the given IdentityType instance to the configured identity store.
<T extends IdentityType> IdentityQuery<T>	createIdentityQuery(Class<T> identityType) Creates an IdentityQuery that can be used to query for IdentityType instances.
<T extends IdentityType> T	lookupIdentityById(Class<T> identityType, String id) Retrieves an IdentityType with the given identifier.
void	remove(IdentityType identityType) Removes the given IdentityType instance from the configured identity store.
<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	update(IdentityType identityType) Updates the given IdentityType instance.
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.AbstractIdentityContext

getEventBridge, getIdGenerator, getParameter, getPartition, getPermissionHandlerPolicy, isParameterSet, setParameter

Methods inherited from class java.lang.Object

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

Constructor Detail

ContextualIdentityManager

public ContextualIdentityManager(Partition partition,
                         EventBridge eventBridge,
                         IdGenerator idGenerator,
                         StoreSelector storeSelector,
                         RelationshipManager relationshipManager)

Method Detail

add

public void add(IdentityType identityType)
         throws IdentityManagementException

Description copied from interface: IdentityManager

Adds the given IdentityType instance to the configured identity store.

Specified by:

add in interface IdentityManager

Throws:

IdentityManagementException - If cannot store the provided IdentityType instance.

update

public void update(IdentityType identityType)
            throws IdentityManagementException

Description copied from interface: IdentityManager

Updates the given IdentityType instance. The instance must have an identifier, otherwise a exception will be thrown.

Specified by:

update in interface IdentityManager

Throws:

IdentityManagementException - If cannot update the provided IdentityType instance.

remove

public void remove(IdentityType identityType)
            throws IdentityManagementException

Description copied from interface: IdentityManager

Removes the given IdentityType instance from the configured identity store. The instance must have an identifier, otherwise a exception will be thrown.

Specified by:

remove in interface IdentityManager

Throws:

IdentityManagementException - If cannot remove the provided IdentityType instance.

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.

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: