Top Description Fields Constructors Methods
org.eclipse.jetty.server.handler

public Class DefaultHandler

extends Abstract
Class Inheritance
Imports
java.io.ByteArrayOutputStream, .InputStream, .OutputStreamWriter, java.nio.ByteBuffer, java.util.Collections, .List, .Objects, org.eclipse.jetty.http.DateGenerator, .HttpField, .HttpHeader, .HttpMethod, .HttpStatus, .MimeTypes, .PreEncodedHttpField, org.eclipse.jetty.server.Handler, .Request, .Response, .Server, org.eclipse.jetty.util.BufferUtil, .Callback, .IO, .StringUtil, .TypeUtil, .URIUtil, org.eclipse.jetty.util.annotation.ManagedAttribute, .Name, org.eclipse.jetty.util.resource.Resource, org.slf4j.Logger, .LoggerFactory

Default Handler. This handle will deal with unhandled requests in the server. For requests for favicon.ico, the Jetty icon is served. For requests to '/' a 404 with a list of known contexts is served. For all other requests a normal 404 is served.

Field Summary

Modifier and TypeField and Description
private ByteBuffer
private final HttpField
private final long
private boolean
private boolean
private static final Logger

Constructor Summary

AccessConstructor and Description
public
public
DefaultHandler(boolean serveFavIcon, boolean showContexts)

Method Summary

Modifier and TypeMethod and Description
public boolean
handle(Request
the HTTP request to handle
request
,
Response
the HTTP response to handle
response
,
Callback
the callback to complete when the handling is complete
callback
)

Implements org.eclipse.jetty.server.Request.Handler.handle.

Invoked to handle the passed HTTP request and response.

private void
public boolean

Returns:

Returns true if the handle can server the jetty favicon.ico
isServeFavIcon
()

public boolean
public void
setServeFavIcon(boolean
true if the handle can server the jetty favicon.ico
serveFavIcon
)

Set true if the handle can server the jetty favicon.ico.

public void
setServer(Server
the Server to associate to this Handler
server
)

Overrides org.eclipse.jetty.server.Handler.Abstract.setServer.

Implements org.eclipse.jetty.server.Handler.setServer.

Set the Server to associate to this Handler.
public void
setShowContexts(boolean show)

public String
toString()

Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString.

Returns a string representation of the object.
Inherited from org.eclipse.jetty.server.Handler.Abstract:
destroydoStartdoStopgetInvocationTypegetServer

Field Detail

_faviconback to summary
private ByteBuffer _favicon
_faviconModifiedback to summary
private final HttpField _faviconModified
_faviconModifiedMsback to summary
private final long _faviconModifiedMs
_serveFavIconback to summary
private boolean _serveFavIcon
_showContextsback to summary
private boolean _showContexts
LOGback to summary
private static final Logger LOG

Hides org.eclipse.jetty.server.Handler.Abstract.LOG.

Constructor Detail

DefaultHandlerback to summary
public DefaultHandler()
DefaultHandlerback to summary
public DefaultHandler(boolean serveFavIcon, boolean showContexts)

Method Detail

handleback to summary
public boolean handle(Request request, Response response, Callback callback) throws Exception

Implements org.eclipse.jetty.server.Request.Handler.handle.

Doc from org.eclipse.jetty.server.Request.Handler.handle.

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;
}
Parameters
request:Request

the HTTP request to handle

response:Response

the HTTP response to handle

callback:Callback

the callback to complete when the handling is complete

Returns:boolean

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.

Annotations
@Override
Exceptions
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.
initFavIconback to summary
private void initFavIcon()
isServeFavIconback to summary
public boolean isServeFavIcon()
Returns:boolean

Returns true if the handle can server the jetty favicon.ico

Annotations
@ManagedAttribute:True if the favicon.ico is served
isShowContextsback to summary
public boolean isShowContexts()
Annotations
@ManagedAttribute:True if the contexts should be shown in the default 404 page
setServeFavIconback to summary
public void setServeFavIcon(boolean serveFavIcon)

Set true if the handle can server the jetty favicon.ico.

Parameters
serveFavIcon:boolean

true if the handle can server the jetty favicon.ico

setServerback to summary
public void setServer(Server server)

Overrides org.eclipse.jetty.server.Handler.Abstract.setServer.

Implements org.eclipse.jetty.server.Handler.setServer.

Doc from org.eclipse.jetty.server.Handler.setServer.

Set the Server to associate to this Handler.

Parameters
server:Server

the Server to associate to this Handler

Annotations
@Override
setShowContextsback to summary
public void setShowContexts(boolean show)
toStringback to summary
public String toString()

Overrides org.eclipse.jetty.util.component.AbstractLifeCycle.toString.

Doc from java.lang.Object.toString.

Returns a string representation of the object.

Returns:String

a string representation of the object.

Annotations
@Override