org.picketlink.idm

Interface IdentityManager

All Known Implementing Classes:

ContextualIdentityManager, SecuredIdentityManager

public interface IdentityManager

Manages all Identity Management related operations.

Author:

Shane Bryzak

Field Summary

Fields

Modifier and Type	Field and Description
static String	IDENTITY_MANAGER_CTX_PARAMETER The active IdentityManager instance may be stored in the IdentityContext under this parameter name

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) Deprecated. Use the getQueryBuilder() to create queries.
IdentityQueryBuilder	getQueryBuilder() Returns a IdentityQueryBuilder, responsible for building queries.
<T extends IdentityType> T	lookupIdentityById(Class<T> identityType, String id) Retrieves an IdentityType with the given identifier.
void	remove(IdentityType value) Removes the given IdentityType instance from the configured identity store.
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	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.

Field Detail

IDENTITY_MANAGER_CTX_PARAMETER

static final String IDENTITY_MANAGER_CTX_PARAMETER

The active IdentityManager instance may be stored in the IdentityContext under this parameter name

See Also:

Constant Field Values

Method Detail

add

void add(IdentityType identityType)
         throws IdentityManagementException

Adds the given IdentityType instance to the configured identity store.

Parameters:

identityType -

Throws:

IdentityManagementException - If cannot store the provided IdentityType instance.

update

void update(IdentityType identityType)
            throws IdentityManagementException

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

Parameters:

identityType -

Throws:

IdentityManagementException - If cannot update the provided IdentityType instance.

remove

void remove(IdentityType value)
            throws IdentityManagementException

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

Parameters:

value -

Throws:

IdentityManagementException - If cannot remove the provided IdentityType instance.

getQueryBuilder

IdentityQueryBuilder getQueryBuilder()

Returns a IdentityQueryBuilder, responsible for building queries.

Returns:

lookupIdentityById

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

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.

Parameters:

identityType -

id -

Returns:

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

createIdentityQuery

@Deprecated
<T extends IdentityType> IdentityQuery<T> createIdentityQuery(Class<T> identityType)

Deprecated. Use the getQueryBuilder() to create queries.

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.

Parameters:

identityType -

Returns:

validateCredentials

void validateCredentials(Credentials credentials)

Validates the given Credentials.

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

Parameters:

credentials -

updateCredential

void updateCredential(Account account,
                    Object credential)

Updates a credential for the given Account.

Parameters:

account -

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

updateCredential

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

Updates a credential for the given Account.

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

Parameters:

account -

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

retrieveCurrentCredential

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

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

Parameters:

account -

storageClass -

Returns:

retrieveCredentials

<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

Parameters:

account -

storageClass -

Returns:

removeCredential

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

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

Parameters:

account - The account which credentials should be removed.

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