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

public Class DebugHandler

extends Wrapper
implements Listener
Class Inheritance
All Implemented Interfaces
org.eclipse.jetty.io.Connection.Listener, java.util.EventListener
Imports
java.io.OutputStream, .PrintStream, java.util.Locale, org.eclipse.jetty.http.HttpHeader, org.eclipse.jetty.io.Connection, org.eclipse.jetty.server.AbstractConnector, .Connector, .Handler, .Request, .Response, org.eclipse.jetty.util.Callback, .DateCache, .RolloverFileOutputStream

Debug Handler. A lightweight debug handler that can be used in production code. Details of the request and response are written to an output stream and the current thread name is updated with information that will link to the details in that output.

Field Summary

Modifier and TypeField and Description
private final DateCache
private OutputStream
private PrintStream

Constructor Summary

AccessConstructor and Description
public
public

Method Summary

Modifier and TypeMethod and Description
protected void
doStart()

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

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

protected void
doStop()

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

Stops the managed lifecycle beans in the reverse order they were added.

public OutputStream

Returns:

the out
getOutputStream
()

Get the out.

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
)

Overrides org.eclipse.jetty.server.Handler.Wrapper.handle.

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

Invoked to handle the passed HTTP request and response.

public void
public void
public void
setOutputStream(OutputStream
the out to set
out
)

Set the out to set.

Inherited from org.eclipse.jetty.server.Handler.Wrapper:
getHandlergetInvocationTypesetHandler

Field Detail

_dateback to summary
private final DateCache _date
_outback to summary
private OutputStream _out
_printback to summary
private PrintStream _print

Constructor Detail

DebugHandlerback to summary
public DebugHandler()
DebugHandlerback to summary
public DebugHandler(Handler handler)

Method Detail

doStartback to summary
protected void doStart() throws Exception

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

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStart.

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

Annotations
@Override
Exceptions
Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStart.

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

doStopback to summary
protected void doStop() throws Exception

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

Doc from org.eclipse.jetty.util.component.ContainerLifeCycle.doStop.

Stops the managed lifecycle beans in the reverse order they were added.

Annotations
@Override
Exceptions
Exception:

Doc from org.eclipse.jetty.util.component.AbstractLifeCycle.doStop.

If there was a problem stopping. Will cause a transition to FAILED state

getOutputStreamback to summary
public OutputStream getOutputStream()

Get the out.

Returns:OutputStream

the out

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

Overrides org.eclipse.jetty.server.Handler.Wrapper.handle.

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.
onClosedback to summary
public void onClosed(Connection connection)

Overrides default org.eclipse.jetty.io.Connection.Listener.onClosed.

Annotations
@Override
onOpenedback to summary
public void onOpened(Connection connection)

Overrides default org.eclipse.jetty.io.Connection.Listener.onOpened.

Annotations
@Override
setOutputStreamback to summary
public void setOutputStream(OutputStream out)

Set the out to set.

Parameters
out:OutputStream

the out to set