org.jasig.cas.authentication.handler.support

Class AbstractUsernamePasswordAuthenticationHandler

java.lang.Object

org.jasig.cas.authentication.AbstractAuthenticationHandler

org.jasig.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

org.jasig.cas.authentication.handler.support.AbstractUsernamePasswordAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler

Direct Known Subclasses:

AcceptUsersAuthenticationHandler, JaasAuthenticationHandler

public abstract class AbstractUsernamePasswordAuthenticationHandler
extends AbstractPreAndPostProcessingAuthenticationHandler

Abstract class to override supports so that we don't need to duplicate the check for UsernamePasswordCredential.

Since:

3.0

Author:

Scott Battaglia, Marvin S. Addison

Field Summary

Fields inherited from class org.jasig.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

logger

Constructor Summary

Constructors

Constructor and Description
AbstractUsernamePasswordAuthenticationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected abstract HandlerResult	authenticateUsernamePasswordInternal(UsernamePasswordCredential transformedCredential) Authenticates a username/password credential by an arbitrary strategy.
protected HandlerResult	createHandlerResult(Credential credential, Principal principal, List<Message> warnings) Helper method to construct a handler result on successful authentication events.
protected HandlerResult	doAuthentication(Credential credential) Performs the details of authentication and returns an authentication handler result on success.
protected PasswordEncoder	getPasswordEncoder() Method to return the PasswordEncoder to be used to encode passwords.
protected PasswordPolicyConfiguration	getPasswordPolicyConfiguration()
protected PrincipalNameTransformer	getPrincipalNameTransformer()
void	setPasswordEncoder(PasswordEncoder passwordEncoder) Sets the PasswordEncoder to be used with this class.
void	setPasswordPolicyConfiguration(PasswordPolicyConfiguration passwordPolicyConfiguration)
void	setPrincipalNameTransformer(PrincipalNameTransformer principalNameTransformer)
boolean	supports(Credential credential) Determines whether the handler has the capability to authenticate the given credential.

Methods inherited from class org.jasig.cas.authentication.handler.support.AbstractPreAndPostProcessingAuthenticationHandler

authenticate, postAuthenticate, preAuthenticate

Methods inherited from class org.jasig.cas.authentication.AbstractAuthenticationHandler

getName, setName

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractUsernamePasswordAuthenticationHandler

public AbstractUsernamePasswordAuthenticationHandler()

Method Detail

doAuthentication

protected final HandlerResult doAuthentication(Credential credential)
                                        throws GeneralSecurityException,
                                               PreventedException

Performs the details of authentication and returns an authentication handler result on success.

Specified by:

doAuthentication in class AbstractPreAndPostProcessingAuthenticationHandler

Parameters:

credential - Credential to authenticate.

Returns:

Authentication handler result on success.

Throws:

GeneralSecurityException - On authentication failure that is thrown out to the caller of AbstractPreAndPostProcessingAuthenticationHandler.authenticate(org.jasig.cas.authentication.Credential).

PreventedException - On the indeterminate case when authentication is prevented.

authenticateUsernamePasswordInternal

protected abstract HandlerResult authenticateUsernamePasswordInternal(UsernamePasswordCredential transformedCredential)
                                                               throws GeneralSecurityException,
                                                                      PreventedException

Authenticates a username/password credential by an arbitrary strategy.

Parameters:

transformedCredential - the credential object bearing the transformed username and password.

Returns:

HandlerResult resolved from credential on authentication success or null if no principal could be resolved from the credential.

Throws:

GeneralSecurityException - On authentication failure.

PreventedException - On the indeterminate case when authentication is prevented.

getPasswordEncoder

protected final PasswordEncoder getPasswordEncoder()

Method to return the PasswordEncoder to be used to encode passwords.

Returns:

the PasswordEncoder associated with this class.

getPrincipalNameTransformer

protected final PrincipalNameTransformer getPrincipalNameTransformer()

getPasswordPolicyConfiguration

protected final PasswordPolicyConfiguration getPasswordPolicyConfiguration()

createHandlerResult

protected final HandlerResult createHandlerResult(Credential credential,
                                Principal principal,
                                List<Message> warnings)

Helper method to construct a handler result on successful authentication events.

Parameters:

credential - the credential on which the authentication was successfully performed. Note that this credential instance may be different from what was originally provided as transformation of the username may have occurred, if one is in fact defined.

principal - the resolved principal

warnings - the warnings

Returns:

the constructed handler result

setPasswordEncoder

public final void setPasswordEncoder(PasswordEncoder passwordEncoder)

Sets the PasswordEncoder to be used with this class.

Parameters:

passwordEncoder - the PasswordEncoder to use when encoding passwords.

setPrincipalNameTransformer

public final void setPrincipalNameTransformer(PrincipalNameTransformer principalNameTransformer)

setPasswordPolicyConfiguration

public final void setPasswordPolicyConfiguration(PasswordPolicyConfiguration passwordPolicyConfiguration)

supports

public boolean supports(Credential credential)

Description copied from interface: AuthenticationHandler

Determines whether the handler has the capability to authenticate the given credential. In practical terms, the AuthenticationHandler.authenticate(Credential) method MUST be capable of processing a given credential if supports returns true on the same credential.

Parameters:

credential - The credential to check.

Returns:

True if credential is a UsernamePasswordCredential, false otherwise.