org.jboss.as.web.session

Class JvmRouteValve

java.lang.Object

org.apache.catalina.valves.ValveBase

org.jboss.as.web.session.JvmRouteValve

All Implemented Interfaces:

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

public class JvmRouteValve
extends org.apache.catalina.valves.ValveBase
implements org.apache.catalina.Lifecycle

Web request valve to specifically handle Tomcat jvmRoute using mod_jk(2) module. We assume that the session id has a format of id.jvmRoute where jvmRoute is used by JK module to determine sticky session during load balancing. Checks for failover by matching session and request jvmRoute to the session manager's, updating the session and session cookie if a failover is detected. This valve is inserted in the pipeline only when mod_jk is configured.

Version:

$Revision: 108925 $

Author:

Ben Wang, Brian Stansberry

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.jboss.logging.Logger	log_
protected SessionManager	manager
protected org.apache.catalina.util.LifecycleSupport	support

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

container, controller, domain, mserver, next, oname, sm

Fields inherited from interface org.apache.catalina.Lifecycle

AFTER_START_EVENT, AFTER_STOP_EVENT, BEFORE_START_EVENT, BEFORE_STOP_EVENT, DESTROY_EVENT, INIT_EVENT, PERIODIC_EVENT, START_EVENT, STOP_EVENT

Constructor Summary

Constructors

Constructor and Description
JvmRouteValve(SessionManager manager) Create a new Valve.

Method Summary

Methods

Modifier and Type	Method and Description
void	addLifecycleListener(org.apache.catalina.LifecycleListener listener)
void	checkJvmRoute(org.apache.catalina.connector.Request req, org.apache.catalina.connector.Response res)
org.apache.catalina.LifecycleListener[]	findLifecycleListeners()
String	getInfo() Get information about this Valve.
protected void	handleJvmRoute(String requestedId, String sessionId, String jvmRoute, javax.servlet.http.HttpServletResponse response, boolean setCookie)
void	invoke(org.apache.catalina.connector.Request request, org.apache.catalina.connector.Response response)
void	removeLifecycleListener(org.apache.catalina.LifecycleListener listener)
void	start()
void	stop()

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

backgroundProcess, createObjectName, event, getContainer, getContainerName, getController, getDomain, getNext, getObjectName, getParentName, postDeregister, postRegister, preDeregister, preRegister, setContainer, setController, setNext, setObjectName, toString

Methods inherited from class java.lang.Object

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

Field Detail

log_

protected static org.jboss.logging.Logger log_

support

protected org.apache.catalina.util.LifecycleSupport support

manager

protected SessionManager manager

Constructor Detail

JvmRouteValve

public JvmRouteValve(SessionManager manager)

Create a new Valve.

Method Detail

getInfo

public String getInfo()

Get information about this Valve.

Specified by:

getInfo in interface org.apache.catalina.Valve

Overrides:

getInfo in class org.apache.catalina.valves.ValveBase

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

Specified by:

invoke in class org.apache.catalina.valves.ValveBase

Throws:

IOException

javax.servlet.ServletException

checkJvmRoute

public void checkJvmRoute(org.apache.catalina.connector.Request req,
                 org.apache.catalina.connector.Response res)
                   throws IOException,
                          javax.servlet.ServletException

Throws:

IOException

javax.servlet.ServletException

handleJvmRoute

protected void handleJvmRoute(String requestedId,
                  String sessionId,
                  String jvmRoute,
                  javax.servlet.http.HttpServletResponse response,
                  boolean setCookie)
                       throws IOException

Throws:

IOException

addLifecycleListener

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

Specified by:

addLifecycleListener in interface org.apache.catalina.Lifecycle

removeLifecycleListener

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

Specified by:

removeLifecycleListener in interface org.apache.catalina.Lifecycle

findLifecycleListeners

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

Specified by:

findLifecycleListeners 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