org.jasig.cas.client.tomcat.v7
Class AbstractCasAuthenticator

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.v7.AbstractAuthenticator
                      org.jasig.cas.client.tomcat.v7.AbstractCasAuthenticator

All Implemented Interfaces:

MBeanRegistration, org.apache.catalina.Authenticator, org.apache.catalina.Contained, org.apache.catalina.Lifecycle, org.apache.catalina.LifecycleListener, org.apache.catalina.Valve

Direct Known Subclasses:

Cas10CasAuthenticator, Cas20CasAuthenticator, Cas20ProxyCasAuthenticator

public abstract class AbstractCasAuthenticator
extends AbstractAuthenticator

Base class for all CAS protocol authenticators.

Since:

3.1.12

Version:

$Revision$ $Date$

Author:

Scott Battaglia

Field Summary

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

logger

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

algorithm, alwaysUseSession, AUTH_HEADER_NAME, cache, changeSessionIdOnAuthentication, context, DEFAULT_ALGORITHM, disableProxyCaching, info, REALM_NAME, securePagesWithPragma, secureRandomAlgorithm, secureRandomClass, secureRandomProvider, SESSION_ID_BYTES, 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

AbstractCasAuthenticator()

Method Summary

protected String	getArtifactParameterName() Abstract method that subclasses should use to provide the name of the artifact parameter (i.e.
protected String	getProxyCallbackUrl()
protected String	getServiceParameterName() Abstract method that subclasses should use to provide the name of the service parameter (i.e.
void	setProxyCallbackUrl(String proxyCallbackUrl)

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

authenticate, getAuthenticationMethod, getAuthMethod, getCasServerUrlPrefix, getEncoding, getInfo, getName, getTicketValidator, isEncode, isRenew, lifecycleEvent, setCasServerLoginUrl, setCasServerUrlPrefix, setEncode, setEncoding, setRenew, setServerName, setServiceUrl, setState, startInternal

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

associate, doLogin, getAlgorithm, getCache, getChangeSessionIdOnAuthentication, getContainer, getDisableProxyCaching, getSecurePagesWithPragma, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, invoke, login, logout, reauthenticateFromSSO, register, setAlgorithm, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider, stopInternal

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

backgroundProcess, event, 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

Constructor Detail

AbstractCasAuthenticator

public AbstractCasAuthenticator()

Method Detail

getProxyCallbackUrl

protected final String getProxyCallbackUrl()

setProxyCallbackUrl

public final void setProxyCallbackUrl(String proxyCallbackUrl)

getArtifactParameterName

protected final String getArtifactParameterName()

Description copied from class: AbstractAuthenticator

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 final String getServiceParameterName()

Description copied from class: AbstractAuthenticator

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.