org.apache.cxf.fediz.tomcat

Class FederationAuthenticator

java.lang.Object

org.apache.catalina.util.LifecycleBase

org.apache.catalina.util.LifecycleMBeanBase

org.apache.catalina.valves.ValveBase

org.apache.catalina.authenticator.AuthenticatorBase

org.apache.catalina.authenticator.FormAuthenticator

org.apache.cxf.fediz.tomcat.FederationAuthenticator

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

public class FederationAuthenticator
extends org.apache.catalina.authenticator.FormAuthenticator

Nested Class Summary

Nested classes/interfaces inherited from class org.apache.catalina.authenticator.AuthenticatorBase

org.apache.catalina.authenticator.AuthenticatorBase.AllowCorsPreflight

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

org.apache.catalina.Lifecycle.SingleUse

Field Summary

Fields

Modifier and Type	Field and Description
protected String	configFile Fediz Configuration file
protected String	encoding
static String	FEDERATION_NOTE
protected static String	INFO Descriptive information about this implementation.
static String	REQUEST_STATE
static String	SECURITY_TOKEN
static String	SESSION_SAVED_REQUEST_PREFIX
static String	SESSION_SAVED_URI_PREFIX
protected static String	TRUSTED_ISSUER

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

characterEncoding, landingPage

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

alwaysUseSession, AUTH_HEADER_NAME, cache, changeSessionIdOnAuthentication, context, disableProxyCaching, jaspicCallbackHandlerClass, REALM_NAME, securePagesWithPragma, secureRandomAlgorithm, secureRandomClass, secureRandomProvider, sendAuthInfoResponseHeaders, 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
FederationAuthenticator()

Method Summary

Modifier and Type	Method and Description
boolean	authenticate(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response)
protected boolean	checkUserAuthentication(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.cxf.fediz.core.config.FedizContext fedCtx)
boolean	doAuthenticate(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response)
protected String	getAuthMethod()
String	getConfigFile()
protected org.apache.cxf.fediz.core.config.FedizContext	getContextConfiguration(String contextName)
String	getEncoding()
void	invoke(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response)
protected boolean	matchRequest(org.apache.catalina.connector.Request request)
protected void	redirectToIdp(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.cxf.fediz.core.config.FedizContext fedCtx)
protected boolean	restoreRequest(org.apache.catalina.connector.Request request)
protected boolean	restoreRequest(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response)
protected void	resumeRequest(String contextId, javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)
protected void	saveRequest(org.apache.catalina.connector.Request request, org.apache.cxf.fediz.core.RequestState requestState)
void	setConfigFile(String configFile)
void	setEncoding(String encoding)
protected void	startInternal()
protected void	stopInternal()
protected boolean	validateToken(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.cxf.fediz.core.config.FedizContext fedConfig)

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

forwardToErrorPage, forwardToLoginPage, getCharacterEncoding, getLandingPage, isContinuationRequired, register, restoreRequest, savedRequestURL, saveRequest, setCharacterEncoding, setLandingPage

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

allowCorsPreflightBypass, associate, changeSessionID, checkForCachedAuthentication, doLogin, getAllowCorsPreflight, getAlwaysUseSession, getCache, getChangeSessionIdOnAuthentication, getContainer, getDisableProxyCaching, getJaspicCallbackHandlerClass, getRealmName, getRequestCertificates, getSecurePagesWithPragma, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, isSendAuthInfoResponseHeaders, login, logout, notify, reauthenticateFromSSO, register, setAllowCorsPreflight, setAlwaysUseSession, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setJaspicCallbackHandlerClass, setSecurePagesWithPragma, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider, setSendAuthInfoResponseHeaders

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, unregister

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

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

Methods inherited from class java.lang.Object

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

Field Detail

SESSION_SAVED_REQUEST_PREFIX

public static final String SESSION_SAVED_REQUEST_PREFIX

See Also:

Constant Field Values

SESSION_SAVED_URI_PREFIX

public static final String SESSION_SAVED_URI_PREFIX

See Also:

Constant Field Values

FEDERATION_NOTE

public static final String FEDERATION_NOTE

See Also:

Constant Field Values

REQUEST_STATE

public static final String REQUEST_STATE

See Also:

Constant Field Values

SECURITY_TOKEN

public static final String SECURITY_TOKEN

See Also:

Constant Field Values

INFO

protected static final String INFO

Descriptive information about this implementation.

See Also:

Constant Field Values

TRUSTED_ISSUER

protected static final String TRUSTED_ISSUER

See Also:

Constant Field Values

configFile

protected String configFile

Fediz Configuration file

encoding

protected String encoding

Constructor Detail

FederationAuthenticator

public FederationAuthenticator()

Method Detail

getConfigFile

public String getConfigFile()

setConfigFile

public void setConfigFile(String configFile)

getEncoding

public String getEncoding()

setEncoding

public void setEncoding(String encoding)

startInternal

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

Overrides:

startInternal in class org.apache.catalina.authenticator.AuthenticatorBase

Throws:

org.apache.catalina.LifecycleException

stopInternal

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

Overrides:

stopInternal in class org.apache.catalina.authenticator.AuthenticatorBase

Throws:

org.apache.catalina.LifecycleException

getContextConfiguration

protected org.apache.cxf.fediz.core.config.FedizContext getContextConfiguration(String contextName)

invoke

public void invoke(org.apache.catalina.connector.Request request,
                   org.apache.catalina.connector.Response response)
            throws IOException,
                   javax.servlet.ServletException

Specified by:

invoke in interface org.apache.catalina.Valve

Overrides:

invoke in class org.apache.catalina.authenticator.AuthenticatorBase

Throws:

IOException

javax.servlet.ServletException

authenticate

public boolean authenticate(org.apache.catalina.connector.Request request,
                            javax.servlet.http.HttpServletResponse response)
                     throws IOException

Specified by:

authenticate in interface org.apache.catalina.Authenticator

Overrides:

authenticate in class org.apache.catalina.authenticator.AuthenticatorBase

Throws:

IOException

doAuthenticate

public boolean doAuthenticate(org.apache.catalina.connector.Request request,
                              javax.servlet.http.HttpServletResponse response)
                       throws IOException

Overrides:

doAuthenticate in class org.apache.catalina.authenticator.FormAuthenticator

Throws:

IOException

resumeRequest

protected void resumeRequest(String contextId,
                             javax.servlet.http.HttpServletRequest request,
                             javax.servlet.http.HttpServletResponse response)
                      throws IOException

Throws:

IOException

restoreRequest

protected boolean restoreRequest(org.apache.catalina.connector.Request request,
                                 javax.servlet.http.HttpServletResponse response)
                          throws IOException

Throws:

IOException

redirectToIdp

protected void redirectToIdp(org.apache.catalina.connector.Request request,
                             javax.servlet.http.HttpServletResponse response,
                             org.apache.cxf.fediz.core.config.FedizContext fedCtx)
                      throws IOException

Throws:

IOException

matchRequest

protected boolean matchRequest(org.apache.catalina.connector.Request request)

Overrides:

matchRequest in class org.apache.catalina.authenticator.FormAuthenticator

saveRequest

protected void saveRequest(org.apache.catalina.connector.Request request,
                           org.apache.cxf.fediz.core.RequestState requestState)
                    throws IOException

Throws:

IOException

restoreRequest

protected boolean restoreRequest(org.apache.catalina.connector.Request request)
                          throws IOException

Throws:

IOException

checkUserAuthentication

protected boolean checkUserAuthentication(org.apache.catalina.connector.Request request,
                                          javax.servlet.http.HttpServletResponse response,
                                          org.apache.cxf.fediz.core.config.FedizContext fedCtx)

validateToken

protected boolean validateToken(org.apache.catalina.connector.Request request,
                                javax.servlet.http.HttpServletResponse response,
                                org.apache.cxf.fediz.core.config.FedizContext fedConfig)

getAuthMethod

protected String getAuthMethod()

Overrides:

getAuthMethod in class org.apache.catalina.authenticator.FormAuthenticator