org.apache.catalina.valves

Class StuckThreadDetectionValve

java.lang.Object

org.apache.catalina.valves.ValveBase

org.apache.catalina.valves.StuckThreadDetectionValve

All Implemented Interfaces:

MBeanRegistration, Contained, Valve

public class StuckThreadDetectionValve
extends ValveBase

This valve allows to detect requests that take a long time to process, which might indicate that the thread that is processing it is stuck. Based on code proposed by TomLu in Bugzilla entry #50306

Author:

slaurent

Field Summary

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

container, controller, domain, info, mserver, next, oname

Constructor Summary

Constructors

Constructor and Description
StuckThreadDetectionValve()

Method Summary

Modifier and Type	Method and Description
void	backgroundProcess() Execute a periodic task, such as reloading, etc.
void	event(Request request, Response response, HttpEvent event) Process a Comet event.
long[]	getStuckThreadIds()
int	getThreshold()
void	invoke(Request request, Response response) The implementation-specific logic represented by this Valve.
void	setThreshold(int threshold) Specify the threshold (in seconds) used when checking for stuck threads.

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

createObjectName, getContainer, getContainerName, getController, getDomain, getInfo, 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

Constructor Detail

StuckThreadDetectionValve

public StuckThreadDetectionValve()

Method Detail

setThreshold

public void setThreshold(int threshold)

Specify the threshold (in seconds) used when checking for stuck threads. If <=0, the detection is disabled. The default is 600 seconds.

Parameters:

threshold - The new threshold in seconds

getThreshold

public int getThreshold()

Returns:

The current threshold in seconds

See Also:

setThreshold(int)

invoke

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

The implementation-specific logic represented by this Valve. See the Valve description for the normal design patterns for this method.

This method MUST be provided by a subclass.

Specified by:

invoke in interface Valve

Specified by:

invoke in class ValveBase

Parameters:

request - The servlet request to be processed

response - The servlet response to be created

Throws:

IOException - if an input/output error occurs

javax.servlet.ServletException - if a servlet error occurs

event

public void event(Request request,
                  Response response,
                  HttpEvent event)
           throws IOException,
                  javax.servlet.ServletException

Description copied from class: ValveBase

Process a Comet event. This method will rarely need to be provided by a subclass, unless it needs to reassociate a particular object with the thread that is processing the request.

Specified by:

event in interface Valve

Overrides:

event in class ValveBase

Parameters:

request - The servlet request to be processed

response - The servlet response to be processed

event - The event to be processed

Throws:

IOException - if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet

javax.servlet.ServletException - if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet

backgroundProcess

public void backgroundProcess()

Description copied from class: ValveBase

Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container. Unexpected throwables will be caught and logged.

Specified by:

backgroundProcess in interface Valve

Overrides:

backgroundProcess in class ValveBase

getStuckThreadIds

public long[] getStuckThreadIds()