Class ThreadLimitHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.Handler.Abstract

org.eclipse.jetty.server.Handler.AbstractContainer

org.eclipse.jetty.server.Handler.Wrapper

org.eclipse.jetty.server.handler.ConditionalHandler

org.eclipse.jetty.server.handler.ConditionalHandler.Abstract

org.eclipse.jetty.server.handler.ThreadLimitHandler

All Implemented Interfaces:

Handler, Handler.Container, Handler.Singleton, Request.Handler, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle, Invocable

public class ThreadLimitHandler
extends ConditionalHandler.Abstract

Handler to limit the number of concurrent threads per remote IP address, for DOS protection.

ThreadLimitHandler applies a limit to the number of threads that can be used simultaneously per remote IP address.

The handler makes a determination of the remote IP separately to any that may be made by the ForwardedRequestCustomizer or similar:

• This handler will use only a single style of forwarded header. This is on the assumption that a trusted local proxy will produce only a single forwarded header and that any additional headers are likely from untrusted client side proxies.
• If multiple instances of a forwarded header are provided, this handler will use the right-most instance, which will have been set from the trusted local proxy

Requests in excess of the limit will be asynchronously suspended until a thread is available.

Nested Class Summary

Nested classes/interfaces inherited from class ConditionalHandler

ConditionalHandler.Abstract, ConditionalHandler.ConnectorPredicate, ConditionalHandler.DontHandle, ConditionalHandler.ElseNext, ConditionalHandler.InetAddressPatternPredicate, ConditionalHandler.MethodPredicate, ConditionalHandler.PathSpecPredicate, ConditionalHandler.PredicateSet, ConditionalHandler.Reject, ConditionalHandler.SkipNext

Nested classes/interfaces inherited from class Handler.Abstract

Handler.Abstract.NonBlocking

Nested classes/interfaces inherited from class AbstractLifeCycle

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

Nested classes/interfaces inherited from interface Container

Container.InheritedListener, Container.Listener

Nested classes/interfaces inherited from interface Dumpable

Dumpable.DumpableContainer

Nested classes/interfaces inherited from interface Handler

Handler.AbstractContainer, Handler.Collection, Handler.Container, Handler.Sequence, Handler.Singleton, Handler.Wrapper

Nested classes/interfaces inherited from interface Invocable

Invocable.Callable, Invocable.InvocationType, Invocable.ReadyTask, Invocable.Task

Nested classes/interfaces inherited from interface LifeCycle

LifeCycle.Listener

Nested classes/interfaces inherited from interface Request.Handler

Request.Handler.AbortException

Field Summary

Fields inherited from class AbstractLifeCycle

FAILED, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface Dumpable

KEY

Fields inherited from interface Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
ThreadLimitHandler()
ThreadLimitHandler(String forwardedHeader)
ThreadLimitHandler(String forwardedHeader, boolean rfc7239)
ThreadLimitHandler(Handler handler, String forwardedHeader, boolean rfc7239)

Method Summary

Modifier and Type	Method	Description
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
void	exclude(String inetAddressPattern)
protected String	getRemoteIP(Request baseRequest)
int	getThreadLimit()
protected int	getThreadLimit(String ip)
void	include(String inetAddressPattern)
boolean	isEnabled()
boolean	onConditionsMet(Request request, Response response, Callback callback)	Handle a request that has met the conditions.
protected boolean	onConditionsNotMet(Request request, Response response, Callback callback)	This method is called when the request has not met the conditions and is not to be handled by this handler.
void	setEnabled(boolean enabled)
void	setThreadLimit(int threadLimit)

Methods inherited from class ConditionalHandler

clear, dump, exclude, exclude, exclude, excludeInetAddressPattern, excludeMethod, excludePath, from, from, handle, include, include, include, includeInetAddressPattern, includeMethod, includePath, nextHandler

Methods inherited from class Handler.Wrapper

getHandler, getInvocationType, setHandler

Methods inherited from class Handler.AbstractContainer

findContainerOf, getDescendant, getDescendants, isDynamic, setDynamic, setServer

Methods inherited from class Handler.Abstract

destroy, doStop, getServer

Methods inherited from class ContainerLifeCycle

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, installBean, installBean, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, start, stop, unmanage, updateBean, updateBean, updateBeans, updateBeans

Methods inherited from class AbstractLifeCycle

getEventListeners, getState, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, setEventListeners, start, stop, toString

Methods inherited from class Object

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

Methods inherited from interface Container

getCachedBeans, getEventListeners

Methods inherited from interface Destroyable

destroy

Methods inherited from interface Dumpable

dumpSelf

Methods inherited from interface Dumpable.DumpableContainer

isDumpable

Methods inherited from interface Handler

getServer, setServer

Methods inherited from interface Handler.Container

getContainer, getDescendant, getDescendants, getDescendants

Methods inherited from interface Handler.Singleton

getHandlers, getTail, insertHandler, setHandler

Methods inherited from interface LifeCycle

addEventListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeEventListener, start, stop

Constructor Details

ThreadLimitHandler

public ThreadLimitHandler()

ThreadLimitHandler

public ThreadLimitHandler(@Name("forwardedHeader")
 String forwardedHeader)

ThreadLimitHandler

public ThreadLimitHandler(@Name("forwardedHeader")
 String forwardedHeader,
 @Name("rfc7239")
 boolean rfc7239)

ThreadLimitHandler

public ThreadLimitHandler(@Name("handler")
 Handler handler,
 @Name("forwardedHeader")
 String forwardedHeader,
 @Name("rfc7239")
 boolean rfc7239)

Method Details

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

Starts the managed lifecycle beans in the order they were added.

Overrides:

doStart in class ConditionalHandler

Throws:

Exception - If there was a problem starting. Will cause a transition to FAILED state

isEnabled

@ManagedAttribute("Whether this handler is enabled")
public boolean isEnabled()

setEnabled

public void setEnabled(boolean enabled)

getThreadLimit

@ManagedAttribute("The maximum threads that can be dispatched per remote IP")
public int getThreadLimit()

getThreadLimit

protected int getThreadLimit(String ip)

setThreadLimit

public void setThreadLimit(int threadLimit)

include

@ManagedOperation("Include IP in thread limits")
public void include(String inetAddressPattern)

exclude

@ManagedOperation("Exclude IP from thread limits")
public void exclude(String inetAddressPattern)

onConditionsMet

public boolean onConditionsMet(Request request,
 Response response,
 Callback callback)
                        throws Exception

Description copied from class: ConditionalHandler

Handle a request that has met the conditions. Typically, the implementation will provide optional handling and then call the ConditionalHandler.nextHandler(Request, Response, Callback) method to continue handling.

Specified by:

onConditionsMet in class ConditionalHandler

Parameters:

request - The request to handle

response - The response to generate

callback - The callback for completion

Returns:

True if this handler will complete the callback

Throws:

Exception - If there is a problem handling

See Also:

• Request.Handler.handle(Request, Response, Callback)

onConditionsNotMet

protected boolean onConditionsNotMet(Request request,
 Response response,
 Callback callback)
                              throws Exception

Description copied from class: ConditionalHandler

This method is called when the request has not met the conditions and is not to be handled by this handler. Implementations may return false; send an error response; or handle the request differently.

Specified by:

onConditionsNotMet in class ConditionalHandler

Parameters:

request - The request to handle

response - The response to generate

callback - The callback for completion

Returns:

True if this handler will complete the callback

Throws:

Exception - If there is a problem handling

See Also:

• Request.Handler.handle(Request, Response, Callback)

getRemoteIP

protected String getRemoteIP(Request baseRequest)