org.apache.cxf.fediz.tomcat
Class FederationAuthenticator

java.lang.Object
  extended by org.apache.catalina.util.LifecycleBase
      extended by org.apache.catalina.util.LifecycleMBeanBase
          extended by org.apache.catalina.valves.ValveBase
              extended by org.apache.catalina.authenticator.AuthenticatorBase
                  extended by org.apache.catalina.authenticator.FormAuthenticator
                      extended by org.apache.cxf.fediz.tomcat.FederationAuthenticator
All Implemented Interfaces:
MBeanRegistration, org.apache.catalina.Authenticator, org.apache.catalina.Contained, org.apache.catalina.Lifecycle, org.apache.catalina.Valve

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


Field Summary
protected  String configFile
          Fediz Configuration file
static String FEDERATION_NOTE
           
protected static String INFO
          Descriptive information about this implementation.
static String SECURITY_TOKEN
           
protected  boolean tokenExpirationValidation
           
protected static String TRUSTED_ISSUER
           
 
Fields inherited from class org.apache.catalina.authenticator.FormAuthenticator
characterEncoding, info, landingPage
 
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
FederationAuthenticator()
           
 
Method Summary
 boolean authenticate(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.catalina.deploy.LoginConfig config)
           
protected  String getAuthMethod()
           
 String getConfigFile()
           
protected  org.apache.cxf.fediz.core.config.FederationContext getContextConfiguration(String contextName)
           
 String getInfo()
          Return descriptive information about this Valve implementation.
 void invoke(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response)
           
 boolean isTokenExpirationValidation()
           
protected  void redirectToIssuer(org.apache.catalina.connector.Request request, javax.servlet.http.HttpServletResponse response, org.apache.cxf.fediz.core.FederationProcessor processor)
          Called to redirect to the IDP/Issuer
 void setConfigFile(String configFile)
           
 void setTokenExpirationValidation(boolean tokenExpirationValidation)
           
protected  void startInternal()
           
protected  void stopInternal()
           
 
Methods inherited from class org.apache.catalina.authenticator.FormAuthenticator
forwardToErrorPage, forwardToLoginPage, getCharacterEncoding, getLandingPage, matchRequest, restoreRequest, savedRequestURL, saveRequest, setCharacterEncoding, setLandingPage
 
Methods inherited from class org.apache.catalina.authenticator.AuthenticatorBase
associate, authenticate, doLogin, getAlwaysUseSession, getCache, getChangeSessionIdOnAuthentication, getContainer, getDisableProxyCaching, getSecurePagesWithPragma, getSecureRandomAlgorithm, getSecureRandomClass, getSecureRandomProvider, login, logout, reauthenticateFromSSO, register, setAlwaysUseSession, setCache, setChangeSessionIdOnAuthentication, setContainer, setDisableProxyCaching, setSecurePagesWithPragma, setSecureRandomAlgorithm, setSecureRandomClass, setSecureRandomProvider
 
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, setState, start, stop
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

FEDERATION_NOTE

public static final String FEDERATION_NOTE
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


tokenExpirationValidation

protected boolean tokenExpirationValidation
Constructor Detail

FederationAuthenticator

public FederationAuthenticator()
Method Detail

getInfo

public String getInfo()
Return descriptive information about this Valve implementation.

Specified by:
getInfo in interface org.apache.catalina.Valve
Overrides:
getInfo in class org.apache.catalina.authenticator.FormAuthenticator

getConfigFile

public String getConfigFile()

setConfigFile

public void setConfigFile(String configFile)

isTokenExpirationValidation

public boolean isTokenExpirationValidation()

setTokenExpirationValidation

public void setTokenExpirationValidation(boolean tokenExpirationValidation)

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.FederationContext 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,
                            org.apache.catalina.deploy.LoginConfig config)
                     throws IOException
Specified by:
authenticate in interface org.apache.catalina.Authenticator
Overrides:
authenticate in class org.apache.catalina.authenticator.FormAuthenticator
Throws:
IOException

getAuthMethod

protected String getAuthMethod()
Overrides:
getAuthMethod in class org.apache.catalina.authenticator.FormAuthenticator

redirectToIssuer

protected void redirectToIssuer(org.apache.catalina.connector.Request request,
                                javax.servlet.http.HttpServletResponse response,
                                org.apache.cxf.fediz.core.FederationProcessor processor)
                         throws IOException
Called to redirect to the IDP/Issuer

Parameters:
request - Request we are processing
response - Response we are populating
processor - FederationProcessor
Throws:
IOException - If the forward to the login page fails and the call to HttpServletResponse.sendError(int, String) throws an IOException


Apache Fediz