org.apereo.cas.authentication

Class AbstractAuthenticationHandler

java.lang.Object

org.apereo.cas.authentication.AbstractAuthenticationHandler

All Implemented Interfaces:

AuthenticationHandler

Direct Known Subclasses:

AbstractPreAndPostProcessingAuthenticationHandler, DigestAuthenticationHandler, HttpBasedServiceCredentialsAuthenticationHandler, OpenIdCredentialsAuthenticationHandler, PrincipalBearingCredentialsAuthenticationHandler, RemoteAddressAuthenticationHandler

public abstract class AbstractAuthenticationHandler
extends java.lang.Object
implements AuthenticationHandler

Base class for all authentication handlers that support configurable naming.

Since:

4.0.0

Field Summary

Fields

Modifier and Type	Field and Description
protected org.slf4j.Logger	logger Instance of logging for subclasses.
protected PrincipalFactory	principalFactory Factory to create the principal type.
protected ServicesManager	servicesManager The services manager instance, as the entry point to the registry.

Fields inherited from interface org.apereo.cas.authentication.AuthenticationHandler

SUCCESSFUL_AUTHENTICATION_HANDLERS

Constructor Summary

Constructors

Constructor and Description
AbstractAuthenticationHandler() Instantiates a new Abstract authentication handler.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Gets a unique name for this authentication handler within the Spring context that contains it.
void	setName(java.lang.String name) Sets the authentication handler name.
void	setPrincipalFactory(PrincipalFactory principalFactory) Sets principal factory to create principal objects.
void	setServicesManager(ServicesManager servicesManager)

Methods inherited from class java.lang.Object

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

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

authenticate, supports

Field Detail

logger

protected transient org.slf4j.Logger logger

Instance of logging for subclasses.

principalFactory

protected PrincipalFactory principalFactory

Factory to create the principal type.

servicesManager

protected ServicesManager servicesManager

The services manager instance, as the entry point to the registry.

Constructor Detail

AbstractAuthenticationHandler

public AbstractAuthenticationHandler()

Instantiates a new Abstract authentication handler.

Method Detail

getName

public java.lang.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(java.lang.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.

setPrincipalFactory

public void setPrincipalFactory(PrincipalFactory principalFactory)

Sets principal factory to create principal objects.

Parameters:

principalFactory - the principal factory

setServicesManager

public void setServicesManager(ServicesManager servicesManager)