org.picketlink.idm.credential.handler

Class AbstractCredentialHandler<S extends CredentialStore<?>,V extends AbstractBaseCredentials,U>

java.lang.Object

org.picketlink.idm.credential.handler.AbstractCredentialHandler<S,V,U>

All Implemented Interfaces:

CredentialHandler<S,V,U>

Direct Known Subclasses:

DigestCredentialHandler, LDAPPlainTextPasswordCredentialHandler, PasswordCredentialHandler, TokenCredentialHandler, X509CertificateCredentialHandler

public abstract class AbstractCredentialHandler<S extends CredentialStore<?>,V extends AbstractBaseCredentials,U>
extends Object
implements CredentialHandler<S,V,U>

Base class for CredentialHandler implementations.

Author:

pedroigor

Constructor Summary

Constructors

Constructor and Description
AbstractCredentialHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract CredentialStorage	createCredentialStorage(IdentityContext context, Account account, U password, S store, Date effectiveDate, Date expiryDate)
protected Account	getAccount(IdentityContext context, String userName) Custom CredentialHandler implementations may override this method to perform the lookup of Account instances based on the userName.
protected abstract Account	getAccount(IdentityContext context, V credentials)
protected Account	getAccountById(IdentityContext context, String identifier) Custom CredentialHandler implementations may override this method to perform the lookup of Account instances based on the identifier.
protected abstract CredentialStorage	getCredentialStorage(IdentityContext context, Account account, V credentials, S store)
protected Property	getDefaultLoginNameProperty(Class<? extends Account> accountType)
protected IdentityManager	getIdentityManager(IdentityContext context)
protected boolean	isDebugEnabled()
void	setup(S store)
void	update(IdentityContext context, Account account, U password, S store, Date effectiveDate, Date expiryDate) Updates the credential for a certain Account.
void	validate(IdentityContext context, V credentials, S store) Validates a credential.
protected abstract boolean	validateCredential(IdentityContext context, CredentialStorage credentialStorage, V credentials, S store)

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractCredentialHandler

public AbstractCredentialHandler()

Method Detail

setup

public void setup(S store)

Specified by:

setup in interface CredentialHandler<S extends CredentialStore<?>,V extends AbstractBaseCredentials,U>

getAccount

protected Account getAccount(IdentityContext context,
                 String userName)

Custom CredentialHandler implementations may override this method to perform the lookup of Account instances based on the userName.

Parameters:

context -

userName - The login name of the account that will be used to retrieve the instance.

Returns:

getAccountById

protected Account getAccountById(IdentityContext context,
                     String identifier)

Custom CredentialHandler implementations may override this method to perform the lookup of Account instances based on the identifier.

Parameters:

context -

identifier - The identifier of the account that will be used to retrieve the instance.

Returns:

validate

public void validate(IdentityContext context,
            V credentials,
            S store)

Description copied from interface: CredentialHandler

Validates a credential.

Specified by:

validate in interface CredentialHandler<S extends CredentialStore<?>,V extends AbstractBaseCredentials,U>

Parameters:

context - The contextual invocation context.

credentials - The credential to be validated.

store - The underlying identity store.

update

public void update(IdentityContext context,
          Account account,
          U password,
          S store,
          Date effectiveDate,
          Date expiryDate)

Description copied from interface: CredentialHandler

Updates the credential for a certain Account.

Specified by:

update in interface CredentialHandler<S extends CredentialStore<?>,V extends AbstractBaseCredentials,U>

Parameters:

context - The contextual invocation context.

account - The account which credentials should be removed.

password - The credential to be updated.

store - The underlying identity store.

effectiveDate - The date specifying from when this credential is valid.

expiryDate - The date specifying when the credential expires.

createCredentialStorage

protected abstract CredentialStorage createCredentialStorage(IdentityContext context,
                                        Account account,
                                        U password,
                                        S store,
                                        Date effectiveDate,
                                        Date expiryDate)

validateCredential

protected abstract boolean validateCredential(IdentityContext context,
                         CredentialStorage credentialStorage,
                         V credentials,
                         S store)

getAccount

protected abstract Account getAccount(IdentityContext context,
                 V credentials)

getCredentialStorage

protected abstract CredentialStorage getCredentialStorage(IdentityContext context,
                                     Account account,
                                     V credentials,
                                     S store)

getIdentityManager

protected IdentityManager getIdentityManager(IdentityContext context)

isDebugEnabled

protected boolean isDebugEnabled()

getDefaultLoginNameProperty

protected Property getDefaultLoginNameProperty(Class<? extends Account> accountType)