org.picketlink.idm.spi

Interface CredentialStore<T extends IdentityStoreConfiguration>

All Superinterfaces:

IdentityStore<T>

All Known Implementing Classes:

FileIdentityStore, JDBCIdentityStore, JPAIdentityStore, LDAPIdentityStore, TokenIdentityStore

public interface CredentialStore<T extends IdentityStoreConfiguration>
extends IdentityStore<T>

A special type of IdentityStore that supports the storage of raw credential state also

Author:

Shane Bryzak

Method Summary

Methods

Modifier and Type	Method and Description
void	removeCredential(IdentityContext context, 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(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	storeCredential(IdentityContext context, Account account, CredentialStorage storage) Stores the specified credential state.

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

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

Method Detail

storeCredential

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

Stores the specified credential state.

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

storage - The credential storage instance to be stored.

retrieveCurrentCredential

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

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

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

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

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

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

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.