org.jasig.cas.authentication

Class AcceptUsersAuthenticationHandler

java.lang.Object

org.jasig.cas.authentication.AbstractAuthenticationHandler

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

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

org.jasig.cas.authentication.AcceptUsersAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler

public class AcceptUsersAuthenticationHandler
extends AbstractUsernamePasswordAuthenticationHandler

Handler that contains a list of valid users and passwords. Useful if there is a small list of users that we wish to allow. An example use case may be if there are existing handlers that make calls to LDAP, etc. but there is a need for additional users we don't want in LDAP. With the chain of command processing of handlers, this handler could be added to check before LDAP and provide the list of additional users. The list of acceptable users is stored in a map. The key of the map is the username and the password is the object retrieved from doing map.get(KEY).

Note that this class makes an unmodifiable copy of whatever map is provided to it.

Since:

3.0.0

Author:

Scott Battaglia, Marvin S. Addison

Field Summary

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

logger

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

principalFactory

Constructor Summary

Constructors

Constructor and Description
AcceptUsersAuthenticationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
protected HandlerResult	authenticateUsernamePasswordInternal(UsernamePasswordCredential credential) Authenticates a username/password credential by an arbitrary strategy.
void	setUsers(Map<String,String> users)

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

doAuthentication, getPasswordEncoder, getPasswordPolicyConfiguration, getPrincipalNameTransformer, setPasswordEncoder, setPasswordPolicyConfiguration, setPrincipalNameTransformer, supports

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

authenticate, createHandlerResult, postAuthenticate, preAuthenticate

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

getName, setName, setPrincipalFactory

Methods inherited from class java.lang.Object

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

Constructor Detail

AcceptUsersAuthenticationHandler

public AcceptUsersAuthenticationHandler()

Method Detail

authenticateUsernamePasswordInternal

protected final HandlerResult authenticateUsernamePasswordInternal(UsernamePasswordCredential credential)
                                                            throws GeneralSecurityException,
                                                                   PreventedException

Authenticates a username/password credential by an arbitrary strategy.

Specified by:

authenticateUsernamePasswordInternal in class AbstractUsernamePasswordAuthenticationHandler

Parameters:

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

setUsers

public final void setUsers(Map<String,String> users)

Parameters:

users - The users to set.