org.jasig.cas.authentication

Class AbstractAuthenticationHandler

java.lang.Object

org.jasig.cas.authentication.AbstractAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler

Direct Known Subclasses:

AbstractPreAndPostProcessingAuthenticationHandler, HttpBasedServiceCredentialsAuthenticationHandler

public abstract class AbstractAuthenticationHandler
extends Object
implements AuthenticationHandler

Base class for all authentication handlers that support configurable naming.

Since:

4.0

Author:

Marvin S. Addison

Constructor Summary

Constructors

Constructor and Description
AbstractAuthenticationHandler()

Method Summary

Methods

Modifier and Type	Method and Description
String	getName() Gets a unique name for this authentication handler within the Spring context that contains it.
void	setName(String name) Sets the authentication handler name.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jasig.cas.authentication.AuthenticationHandler

authenticate, supports

Constructor Detail

AbstractAuthenticationHandler

public AbstractAuthenticationHandler()

Method Detail

getName

public String getName()

Description copied from interface: AuthenticationHandler

Gets a unique name for this authentication handler within the Spring context that contains it. For implementations that allow setting a unique name, deployers MUST take care to ensure that every handler instance has a unique name.

Specified by:

getName in interface AuthenticationHandler

Returns:

Unique name within a Spring context.

setName

public void setName(String name)

Sets the authentication handler name. Authentication handler names SHOULD be unique within an AuthenticationManager, and particular implementations may require uniqueness. Uniqueness is a best practice generally.

Parameters:

name - Handler name.