org.gatein.sso.integration

Class SSODelegateValve

java.lang.Object

org.gatein.sso.integration.SSODelegateValve

All Implemented Interfaces:

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

public class SSODelegateValve
extends Object
implements org.apache.catalina.Valve, org.apache.catalina.Contained, MBeanRegistration, org.apache.catalina.Lifecycle

Delegates work to another valve configured through option 'delegateValveClassName'. It's possible to disable delegation by boolean parameter 'ssoDelegationEnabled'. Actually delegation will be enabled only for SSO scenario, which require integration with Tomcat valves (SAML, SPNEGO)

Author:

Marek Posolda

Nested Class Summary

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

org.apache.catalina.Lifecycle.SingleUse

Field Summary

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
SSODelegateValve()

Method Summary

Modifier and Type	Method and Description
void	addLifecycleListener(org.apache.catalina.LifecycleListener listener)
void	backgroundProcess()
void	destroy()
org.apache.catalina.LifecycleListener[]	findLifecycleListeners()
org.apache.catalina.Container	getContainer()
org.apache.catalina.Valve	getNext()
org.apache.catalina.LifecycleState	getState()
String	getStateName()
void	init()
void	invoke(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response)
boolean	isAsyncSupported()
void	postDeregister()
void	postRegister(Boolean registrationDone)
void	preDeregister()
ObjectName	preRegister(MBeanServer server, ObjectName name)
void	removeLifecycleListener(org.apache.catalina.LifecycleListener listener)
void	setContainer(org.apache.catalina.Container container)
void	setDelegateValveClassName(String delegateValve)
void	setNext(org.apache.catalina.Valve valve)
void	setSamlSPConfigFile(String configFile)
void	setSsoDelegationEnabled(String enabled)
void	start()
void	stop()

Methods inherited from class java.lang.Object

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

Constructor Detail

SSODelegateValve

public SSODelegateValve()

Method Detail

setDelegateValveClassName

public void setDelegateValveClassName(String delegateValve)

setSsoDelegationEnabled

public void setSsoDelegationEnabled(String enabled)

setSamlSPConfigFile

public void setSamlSPConfigFile(String configFile)

getNext

public org.apache.catalina.Valve getNext()

Specified by:

getNext in interface org.apache.catalina.Valve

setNext

public void setNext(org.apache.catalina.Valve valve)

Specified by:

setNext in interface org.apache.catalina.Valve

backgroundProcess

public void backgroundProcess()

Specified by:

backgroundProcess in interface org.apache.catalina.Valve

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

Throws:

IOException

javax.servlet.ServletException

getContainer

public org.apache.catalina.Container getContainer()

Specified by:

getContainer in interface org.apache.catalina.Contained

setContainer

public void setContainer(org.apache.catalina.Container container)

Specified by:

setContainer in interface org.apache.catalina.Contained

preRegister

public ObjectName preRegister(MBeanServer server,
                              ObjectName name)
                       throws Exception

Specified by:

preRegister in interface MBeanRegistration

Throws:

Exception

postRegister

public void postRegister(Boolean registrationDone)

Specified by:

postRegister in interface MBeanRegistration

preDeregister

public void preDeregister()
                   throws Exception

Specified by:

preDeregister in interface MBeanRegistration

Throws:

Exception

postDeregister

public void postDeregister()

Specified by:

postDeregister in interface MBeanRegistration

addLifecycleListener

public void addLifecycleListener(org.apache.catalina.LifecycleListener listener)

Specified by:

addLifecycleListener in interface org.apache.catalina.Lifecycle

findLifecycleListeners

public org.apache.catalina.LifecycleListener[] findLifecycleListeners()

Specified by:

findLifecycleListeners in interface org.apache.catalina.Lifecycle

removeLifecycleListener

public void removeLifecycleListener(org.apache.catalina.LifecycleListener listener)

Specified by:

removeLifecycleListener in interface org.apache.catalina.Lifecycle

start

public void start()
           throws org.apache.catalina.LifecycleException

Specified by:

start in interface org.apache.catalina.Lifecycle

Throws:

org.apache.catalina.LifecycleException

stop

public void stop()
          throws org.apache.catalina.LifecycleException

Specified by:

stop in interface org.apache.catalina.Lifecycle

Throws:

org.apache.catalina.LifecycleException

init

public void init()
          throws org.apache.catalina.LifecycleException

Specified by:

init in interface org.apache.catalina.Lifecycle

Throws:

org.apache.catalina.LifecycleException

destroy

public void destroy()
             throws org.apache.catalina.LifecycleException

Specified by:

destroy in interface org.apache.catalina.Lifecycle

Throws:

org.apache.catalina.LifecycleException

getState

public org.apache.catalina.LifecycleState getState()

Specified by:

getState in interface org.apache.catalina.Lifecycle

getStateName

public String getStateName()

Specified by:

getStateName in interface org.apache.catalina.Lifecycle

isAsyncSupported

public boolean isAsyncSupported()

Specified by:

isAsyncSupported in interface org.apache.catalina.Valve