Modifier and Type	Class and Description
private static class	StuckThreadDetectionValve.CompletedStuckThread
private static class	StuckThreadDetectionValve.MonitoredThread
private static enum	StuckThreadDetectionValve.MonitoredThreadState

Field Summary

Modifier and Type	Field and Description
private final Map<Long, StuckThreadDetectionValve.MonitoredThread>	activeThreads The only references we keep to actual running Thread objects are in this Map (which is automatically cleaned in invoke()s finally clause).
private final Queue<StuckThreadDetectionValve.CompletedStuckThread>	completedStuckThreadsQueue
private AtomicLong	interruptedThreadsCount Keeps count of the number of stuck threads that have been interrupted
private int	interruptThreadThreshold In seconds.
private static final Log	log Hides org.apache.catalina.util.LifecycleMBeanBase.log. Logger
private static final StringManager	sm Hides org.apache.catalina.valves.ValveBase.sm. The string manager for this package.
private final AtomicInteger	stuckCount Keeps count of the number of stuck threads detected
private int	threshold In seconds.

Inherited from org.apache.catalina.valves.ValveBase:: asyncSupported container containerLog next

Constructor Summary

Access	Constructor and Description
public	StuckThreadDetectionValve() Required to enable async support.

Method Summary

Modifier and Type	Method and Description
public void	backgroundProcess() Overrides org.apache.catalina.valves.ValveBase.backgroundProcess. Implements org.apache.catalina.Valve.backgroundProcess. Execute a periodic task, such as reloading, etc. This method will be invoked inside the classloading context of this container.
public long	getInterruptedThreadsCount()
public int	getInterruptThreadThreshold()
public int	getStuckThreadCount()
public long[]	getStuckThreadIds()
public String[]	getStuckThreadNames()
public int	Returns: The current threshold in seconds getThreshold()
protected void	initInternal() Overrides org.apache.catalina.valves.ValveBase.initInternal. Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.
public void	invoke(Request The servlet request to be processed request, Response The servlet response to be created response) Implements org.apache.catalina.Valve.invoke. Perform request processing as required by this Valve.
private void	notifyStuckThreadCompleted(StuckThreadDetectionValve.CompletedStuckThread thread, int numStuckThreads)
private void	notifyStuckThreadDetected(StuckThreadDetectionValve.MonitoredThread monitoredThread, long activeTime, int numStuckThreads)
public void	setInterruptThreadThreshold(int The new thread interruption threshold in seconds interruptThreadThreshold) Specifies the threshold (in seconds) before stuck threads are interrupted.
public void	setThreshold(int The new threshold in seconds threshold) Specifies the threshold (in seconds) used when checking for stuck threads.

Inherited from org.apache.catalina.valves.ValveBase:: getContainer getDomainInternal getNext getObjectNameKeyProperties isAsyncSupported setAsyncSupported setContainer setNext startInternal stopInternal toString

Field Detail

activeThreads	back to summary
private final Map<Long, StuckThreadDetectionValve.MonitoredThread> activeThreads The only references we keep to actual running Thread objects are in this Map (which is automatically cleaned in invoke()s finally clause). That way, Threads can be GC'ed, even though the Valve still thinks they are stuck (caused by a long monitor interval)

completedStuckThreadsQueue	back to summary
private final Queue<StuckThreadDetectionValve.CompletedStuckThread> completedStuckThreadsQueue

interruptedThreadsCount	back to summary
private AtomicLong interruptedThreadsCount Keeps count of the number of stuck threads that have been interrupted

interruptThreadThreshold	back to summary
private int interruptThreadThreshold In seconds. Default is -1 to disable interruption.

log	back to summary
private static final Log log Hides org.apache.catalina.util.LifecycleMBeanBase.log. Logger

log

back to summary

private static final Log log

Hides org.apache.catalina.util.LifecycleMBeanBase.log.

Logger

sm	back to summary
private static final StringManager sm Hides org.apache.catalina.valves.ValveBase.sm. The string manager for this package.

back to summary

private static final StringManager sm

Hides org.apache.catalina.valves.ValveBase.sm.

The string manager for this package.

stuckCount	back to summary
private final AtomicInteger stuckCount Keeps count of the number of stuck threads detected

threshold	back to summary
private int threshold In seconds. Default 600 (10 minutes).

Constructor Detail

StuckThreadDetectionValve	back to summary
public StuckThreadDetectionValve() Required to enable async support.

Method Detail

backgroundProcess	back to summary
public void backgroundProcess() Overrides org.apache.catalina.valves.ValveBase.backgroundProcess. Implements org.apache.catalina.Valve.backgroundProcess. Doc from org.apache.catalina.valves.ValveBase.backgroundProcess. 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. The default implementation is NO-OP. Annotations @Override

backgroundProcess

back to summary

public void backgroundProcess()

Overrides org.apache.catalina.valves.ValveBase.backgroundProcess.

Implements org.apache.catalina.Valve.backgroundProcess.

Doc from org.apache.catalina.valves.ValveBase.backgroundProcess.

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.

The default implementation is NO-OP.

Annotations

@Override

getInterruptedThreadsCount	back to summary
public long getInterruptedThreadsCount()

getInterruptThreadThreshold	back to summary
public int getInterruptThreadThreshold()

getStuckThreadCount	back to summary
public int getStuckThreadCount()

getStuckThreadIds	back to summary
public long[] getStuckThreadIds()

getStuckThreadNames	back to summary
public String[] getStuckThreadNames()

getThreshold	back to summary
public int getThreshold() Returns:int The current threshold in seconds See Also `setThreshold(int)`

initInternal	back to summary
protected void initInternal() throws LifecycleException Overrides org.apache.catalina.valves.ValveBase.initInternal. Doc from org.apache.catalina.util.LifecycleMBeanBase.initInternal. Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method. Annotations @Override Exceptions LifecycleException: Doc from org.apache.catalina.util.LifecycleBase.initInternal. If the initialisation fails

initInternal

back to summary

protected void initInternal() throws LifecycleException

Overrides org.apache.catalina.valves.ValveBase.initInternal.

Doc from org.apache.catalina.util.LifecycleMBeanBase.initInternal.

Sub-classes wishing to perform additional initialization should override this method, ensuring that super.initInternal() is the first call in the overriding method.

Annotations

@Override

Exceptions

LifecycleException:

Doc from org.apache.catalina.util.LifecycleBase.initInternal.

If the initialisation fails

invoke back to summary

invoke	back to summary
public void invoke(Request request, Response response) throws IOException, ServletException Implements org.apache.catalina.Valve.invoke. Doc from org.apache.catalina.Valve.invoke. Perform request processing as required by this Valve. An individual Valve MAY perform the following actions, in the specified order: Examine and/or modify the properties of the specified Request and Response. Examine the properties of the specified Request, completely generate the corresponding Response, and return control to the caller. Examine the properties of the specified Request and Response, wrap either or both of these objects to supplement their functionality, and pass them on. If the corresponding Response was not generated (and control was not returned, call the next Valve in the pipeline (if there is one) by executing `getNext().invoke()`. Examine, but not modify, the properties of the resulting Response (which was created by a subsequently invoked Valve or Container). A Valve MUST NOT do any of the following things: Change request properties that have already been used to direct the flow of processing control for this request (for instance, trying to change the virtual host to which a Request should be sent from a pipeline attached to a Host or Context in the standard implementation). Create a completed Response AND pass this Request and Response on to the next Valve in the pipeline. Consume bytes from the input stream associated with the Request, unless it is completely generating the response, or wrapping the request before passing it on. Modify the HTTP headers included with the Response after the `getNext().invoke()` method has returned. Perform any actions on the output stream associated with the specified Response after the `getNext().invoke()` method has returned. Parameters request:Request The servlet request to be processed response:Response The servlet response to be created Annotations @Override Exceptions IOException: if an input/output error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet ServletException: if a servlet error occurs, or is thrown by a subsequently invoked Valve, Filter, or Servlet

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

Implements org.apache.catalina.Valve.invoke.

Doc from org.apache.catalina.Valve.invoke.

Perform request processing as required by this Valve.

An individual Valve MAY perform the following actions, in the specified order:

Examine and/or modify the properties of the specified Request and Response.
Examine the properties of the specified Request, completely generate the corresponding Response, and return control to the caller.
Examine the properties of the specified Request and Response, wrap either or both of these objects to supplement their functionality, and pass them on.
If the corresponding Response was not generated (and control was not returned, call the next Valve in the pipeline (if there is one) by executing getNext().invoke().
Examine, but not modify, the properties of the resulting Response (which was created by a subsequently invoked Valve or Container).

A Valve MUST NOT do any of the following things:

Change request properties that have already been used to direct the flow of processing control for this request (for instance, trying to change the virtual host to which a Request should be sent from a pipeline attached to a Host or Context in the standard implementation).
Create a completed Response AND pass this Request and Response on to the next Valve in the pipeline.
Consume bytes from the input stream associated with the Request, unless it is completely generating the response, or wrapping the request before passing it on.
Modify the HTTP headers included with the Response after the getNext().invoke() method has returned.
Perform any actions on the output stream associated with the specified Response after the getNext().invoke() method has returned.

Parameters

request:Request: The servlet request to be processed
response:Response: The servlet response to be created

Annotations

@Override

Exceptions

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

notifyStuckThreadCompleted	back to summary
private void notifyStuckThreadCompleted(StuckThreadDetectionValve.CompletedStuckThread thread, int numStuckThreads)

notifyStuckThreadDetected	back to summary
private void notifyStuckThreadDetected(StuckThreadDetectionValve.MonitoredThread monitoredThread, long activeTime, int numStuckThreads)

setInterruptThreadThreshold	back to summary
public void setInterruptThreadThreshold(int interruptThreadThreshold) Specifies the threshold (in seconds) before stuck threads are interrupted. If <=0, the interruption is disabled. The default is -1. If >=0, the value must actually be >= threshold. Parameters interruptThreadThreshold:int The new thread interruption threshold in seconds

setInterruptThreadThreshold

back to summary

public void setInterruptThreadThreshold(int interruptThreadThreshold)

Specifies the threshold (in seconds) before stuck threads are interrupted. If <=0, the interruption is disabled. The default is -1. If >=0, the value must actually be >= threshold.

Parameters

interruptThreadThreshold:int: The new thread interruption threshold in seconds

setThreshold	back to summary
public void setThreshold(int threshold) Specifies the threshold (in seconds) used when checking for stuck threads. If <=0, the detection is disabled. The default is 600 seconds. Parameters threshold:int The new threshold in seconds

setThreshold

back to summary

public void setThreshold(int threshold)

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

Parameters

threshold:int: The new threshold in seconds

org.apache.catalina.valves back to summary

private Class StuckThreadDetectionValve.CompletedStuckThread

Class Inheritance

extends Object

java.lang.Object
org.apache.catalina.valves.StuckThreadDetectionValve.CompletedStuckThread

Field Summary

Modifier and Type	Field and Description
private final long	threadId
private final String	threadName
private final long	totalActiveTime

Constructor Summary

Access	Constructor and Description
pack-priv	CompletedStuckThread(Thread thread, long totalActiveTime)

Method Summary

Modifier and Type	Method and Description
public long	getId()
public String	getName()
public long	getTotalActiveTime()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

threadId	back to summary
private final long threadId

threadName	back to summary
private final String threadName

totalActiveTime	back to summary
private final long totalActiveTime

Constructor Detail

CompletedStuckThread	back to summary
pack-priv CompletedStuckThread(Thread thread, long totalActiveTime)

Method Detail

getId	back to summary
public long getId()

getName	back to summary
public String getName()

getTotalActiveTime	back to summary
public long getTotalActiveTime()

org.apache.catalina.valves back to summary

private Class StuckThreadDetectionValve.MonitoredThread

Class Inheritance

extends Object

java.lang.Object
org.apache.catalina.valves.StuckThreadDetectionValve.MonitoredThread

Field Summary

Modifier and Type	Field and Description
private boolean	interrupted Set to true after the thread is interrupted.
private final Semaphore	interruptionSemaphore Semaphore to synchronize the stuck thread with the background-process thread.
private final String	requestUri
private final long	start
private final AtomicInteger	state
private final Thread	thread Reference to the thread to get a stack trace from background task

Constructor Summary

Access	Constructor and Description
pack-priv	MonitoredThread(Thread thread, String requestUri, boolean interruptible)

Method Summary

Modifier and Type	Method and Description
public long	getActiveTimeInMillis()
public String	getRequestUri()
public Date	getStartTime()
public Thread	getThread()
public boolean	interruptIfStuck(long interruptThreadThreshold)
pack-priv boolean	isMarkedAsStuck()
public StuckThreadDetectionValve.MonitoredThreadState	markAsDone()
public boolean	markAsStuckIfStillRunning()
public boolean	wasInterrupted()

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

interrupted	back to summary
private boolean interrupted Set to true after the thread is interrupted. No need to make it volatile since it is accessed right after acquiring the semaphore.

interruptionSemaphore	back to summary
private final Semaphore interruptionSemaphore Semaphore to synchronize the stuck thread with the background-process thread. It's not used if the interruption feature is not active.

requestUri	back to summary
private final String requestUri

start	back to summary
private final long start

state	back to summary
private final AtomicInteger state

thread	back to summary
private final Thread thread Reference to the thread to get a stack trace from background task

Constructor Detail

MonitoredThread	back to summary
pack-priv MonitoredThread(Thread thread, String requestUri, boolean interruptible)

Method Detail

getActiveTimeInMillis	back to summary
public long getActiveTimeInMillis()

getRequestUri	back to summary
public String getRequestUri()

getStartTime	back to summary
public Date getStartTime()

getThread	back to summary
public Thread getThread()

interruptIfStuck	back to summary
public boolean interruptIfStuck(long interruptThreadThreshold)

isMarkedAsStuck	back to summary
pack-priv boolean isMarkedAsStuck()

markAsDone	back to summary
public StuckThreadDetectionValve.MonitoredThreadState markAsDone()

markAsStuckIfStillRunning	back to summary
public boolean markAsStuckIfStillRunning()

wasInterrupted	back to summary
public boolean wasInterrupted()

org.apache.catalina.valves back to summary

private final Enum StuckThreadDetectionValve.MonitoredThreadState

Class Inheritance

extends Enum<StuckThreadDetectionValve.MonitoredThreadState>

java.lang.Object
java.lang.Enum
org.apache.catalina.valves.StuckThreadDetectionValve.MonitoredThreadState

Field Summary

Modifier and Type	Field and Description
public static final StuckThreadDetectionValve.MonitoredThreadState	DONE
public static final StuckThreadDetectionValve.MonitoredThreadState	RUNNING
public static final StuckThreadDetectionValve.MonitoredThreadState	STUCK

Constructor Summary

Access	Constructor and Description
private	MonitoredThreadState()

Method Summary

Modifier and Type	Method and Description
public static StuckThreadDetectionValve.MonitoredThreadState	valueOf(String name)
public static StuckThreadDetectionValve.MonitoredThreadState[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

DONE	back to summary
public static final StuckThreadDetectionValve.MonitoredThreadState DONE

RUNNING	back to summary
public static final StuckThreadDetectionValve.MonitoredThreadState RUNNING

STUCK	back to summary
public static final StuckThreadDetectionValve.MonitoredThreadState STUCK

Constructor Detail

MonitoredThreadState	back to summary
private MonitoredThreadState()

Method Detail

valueOf	back to summary
public static StuckThreadDetectionValve.MonitoredThreadState valueOf(String name)

values	back to summary
public static StuckThreadDetectionValve.MonitoredThreadState[] values()

public Class StuckThreadDetectionValve

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class StuckThreadDetectionValve.CompletedStuckThread

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private Class StuckThreadDetectionValve.MonitoredThread

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail

private final Enum StuckThreadDetectionValve.MonitoredThreadState

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail