Module org.eclipse.jetty.server

Package org.eclipse.jetty.server.handler

Class DoSHandler.StatusRejectHandler

java.lang.Object

org.eclipse.jetty.server.handler.DoSHandler.StatusRejectHandler

All Implemented Interfaces:

Request.Handler, org.eclipse.jetty.util.thread.Invocable

Enclosing class:

DoSHandler

public static class DoSHandler.StatusRejectHandler
extends Object
implements Request.Handler

A Handler to reject DoS requests with a status code or failure.

Nested Class Summary

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.thread.Invocable

org.eclipse.jetty.util.thread.Invocable.Callable, org.eclipse.jetty.util.thread.Invocable.InvocationType, org.eclipse.jetty.util.thread.Invocable.ReadyTask, org.eclipse.jetty.util.thread.Invocable.Task

Nested classes/interfaces inherited from interface org.eclipse.jetty.server.Request.Handler

Request.Handler.AbortException

Field Summary

Fields inherited from interface org.eclipse.jetty.util.thread.Invocable

__nonBlocking, NOOP

Constructor Summary

Constructors

Constructor	Description
StatusRejectHandler()
StatusRejectHandler(int status)

Method Summary

Modifier and Type	Method	Description
boolean	handle(Request request, Response response, org.eclipse.jetty.util.Callback callback)	Invoked to handle the passed HTTP request and response.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.eclipse.jetty.server.Request.Handler

getInvocationType

Constructor Details

StatusRejectHandler

public StatusRejectHandler()

StatusRejectHandler

public StatusRejectHandler(int status)

Parameters:

status - The status used to reject a request, or 0 to fail the request or -1 for a default (HttpStatus.TOO_MANY_REQUESTS_429.

Method Details

handle

public boolean handle(Request request,
 Response response,
 org.eclipse.jetty.util.Callback callback)
               throws Exception

Description copied from interface: Request.Handler

Invoked to handle the passed HTTP request and response.

The request is accepted by returning true, then handling must be concluded by completing the passed callback. The handling may be asynchronous, i.e. this method may return true and complete the given callback later, possibly from a different thread. If this method returns false, then the callback must not be invoked and any mutation on the response reversed.

Exceptions thrown by this method may be subsequently handled by an error Request.Handler, if present, otherwise a default HTTP 500 error is generated and the callback completed while writing the error response.

The simplest implementation is:

 public boolean handle(Request request, Response response, Callback callback)
 {
     callback.succeeded();
     return true;
 }
 

A HelloWorld implementation is:

 public boolean handle(Request request, Response response, Callback callback)
 {
     response.write(true, ByteBuffer.wrap("Hello World\n".getBytes(StandardCharsets.UTF_8)), callback);
     return true;
 }
 

Specified by:

handle in interface Request.Handler

Parameters:

request - the HTTP request to handle

response - the HTTP response to handle

callback - the callback to complete when the handling is complete

Returns:

True if and only if the request will be handled, a response generated and the callback eventually called. This may occur within the scope of the call to this method, or asynchronously some time later. If false is returned, then this method must not generate a response, nor complete the callback.

Throws:

Exception - if there is a failure during the handling. Catchers cannot assume that the callback will be called and thus should attempt to complete the request as if a false had been returned.

See Also:

• Request.Handler.AbortException