org.jasig.cas.client.tomcat.v85

Class Saml11Authenticator

java.lang.Object

org.apache.catalina.util.LifecycleBase

org.apache.catalina.util.LifecycleMBeanBase

org.apache.catalina.valves.ValveBase

org.apache.catalina.authenticator.AuthenticatorBase

org.jasig.cas.client.tomcat.v85.AbstractAuthenticator

org.jasig.cas.client.tomcat.v85.Saml11Authenticator

All Implemented Interfaces:

MBeanRegistration, javax.security.auth.message.config.RegistrationListener, org.apache.catalina.Authenticator, org.apache.catalina.Contained, org.apache.catalina.JmxEnabled, org.apache.catalina.Lifecycle, org.apache.catalina.LifecycleListener, org.apache.catalina.Valve

public final class Saml11Authenticator
extends AbstractAuthenticator

CAS authenticator that uses the SAML 1.1 protocol.

Since:

3.1.12

Version:

$Revision$

Author:

Marvin S. Addison

Nested Class Summary

Nested classes/interfaces inherited from interface org.apache.catalina.Lifecycle

org.apache.catalina.Lifecycle.SingleUse

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTH_METHOD

Fields inherited from class org.jasig.cas.client.tomcat.v85.AbstractAuthenticator

logger

Fields inherited from class org.apache.catalina.authenticator.AuthenticatorBase

alwaysUseSession, AUTH_HEADER_NAME, cache, changeSessionIdOnAuthentication, context, disableProxyCaching, REALM_NAME, securePagesWithPragma, secureRandomAlgorithm, secureRandomClass, secureRandomProvider, sessionIdGenerator, sm, sso

Fields inherited from class org.apache.catalina.valves.ValveBase

asyncSupported, container, containerLog, next

Fields inherited from class org.apache.catalina.util.LifecycleMBeanBase

mserver

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_DESTROY_EVENT, AFTER_INIT_EVENT, AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_DESTROY_EVENT, BEFORE_INIT_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, CONFIGURE_START_EVENT, CONFIGURE_STOP_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
Saml11Authenticator()

Method Summary

Modifier and Type	Method and Description
protected String	getArtifactParameterName() Abstract method that subclasses should use to provide the name of the artifact parameter (i.e.
protected String	getAuthenticationMethod()
protected String	getName()
protected String	getServiceParameterName() Abstract method that subclasses should use to provide the name of the service parameter (i.e.
protected TicketValidator	getTicketValidator() Returns the single instance of the ticket validator to use to validate tickets.
void	setTolerance(int ms)
protected void	startInternal()

Methods inherited from class org.jasig.cas.client.tomcat.v85.AbstractAuthenticator

doAuthenticate, getAuthMethod, getCasServerUrlPrefix, getEncoding, getInfo, isEncode, isRenew, lifecycleEvent, setCasServerLoginUrl, setCasServerUrlPrefix, setEncode, setEncoding, setRenew, setServerName, setServiceUrl, setState

Methods inherited from class org.apache.catalina.authenticator.AuthenticatorBase

associate, authenticate, checkForCachedAuthentication, doLogin, getAlwaysUseSession, getCache, getChangeSessionIdOnAuthentication, getContainer, getDisableProxyCaching, getRealmName, getRequestCertificates, getSecurePagesWithPragma, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, invoke, isContinuationRequired, login, logout, notify, reauthenticateFromSSO, register, setAlwaysUseSession, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider, stopInternal

Methods inherited from class org.apache.catalina.valves.ValveBase

backgroundProcess, getDomainInternal, getNext, getObjectNameKeyProperties, initInternal, isAsyncSupported, setAsyncSupported, setNext, toString

Methods inherited from class org.apache.catalina.util.LifecycleMBeanBase

destroyInternal, getDomain, getObjectName, postDeregister, postRegister, preDeregister, preRegister, register, setDomain, unregister

Methods inherited from class org.apache.catalina.util.LifecycleBase

addLifecycleListener, destroy, findLifecycleListeners, fireLifecycleEvent, getState, getStateName, init, removeLifecycleListener, setState, start, stop

Methods inherited from class java.lang.Object

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

Field Detail

AUTH_METHOD

public static final String AUTH_METHOD

See Also:

Constant Field Values

Constructor Detail

Saml11Authenticator

public Saml11Authenticator()

Method Detail

setTolerance

public void setTolerance(int ms)

Parameters:

ms - SAML clock drift tolerance in milliseconds.

startInternal

protected void startInternal()
                      throws org.apache.catalina.LifecycleException

Overrides:

startInternal in class AbstractAuthenticator

Throws:

org.apache.catalina.LifecycleException

getTicketValidator

protected TicketValidator getTicketValidator()

Description copied from class: AbstractAuthenticator

Returns the single instance of the ticket validator to use to validate tickets. Sub classes should include the one appropriate for the

Specified by:

getTicketValidator in class AbstractAuthenticator

Returns:

a fully configured ticket validator. CANNOT be NULL.

getAuthenticationMethod

protected String getAuthenticationMethod()

Specified by:

getAuthenticationMethod in class AbstractAuthenticator

getArtifactParameterName

protected String getArtifactParameterName()

Abstract method that subclasses should use to provide the name of the artifact parameter (i.e. ticket)

Specified by:

getArtifactParameterName in class AbstractAuthenticator

Returns:

the artifact parameter name. CANNOT be NULL.

getServiceParameterName

protected String getServiceParameterName()

Abstract method that subclasses should use to provide the name of the service parameter (i.e. service)

Specified by:

getServiceParameterName in class AbstractAuthenticator

Returns:

the service parameter name. CANNOT be NULL.

getName

protected String getName()

Specified by:

getName in class AbstractAuthenticator

Returns:

Authenticator descriptive name.