Package org.eclipse.jetty.server.handler

Class AbstractHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

All Implemented Interfaces:

Handler, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.LifeCycle

Direct Known Subclasses:

AbstractHandler.ErrorDispatchHandler, AbstractHandlerContainer, DefaultHandler, ErrorHandler, SecuredRedirectHandler

@ManagedObject("Jetty Handler")
public abstract class AbstractHandler
extends org.eclipse.jetty.util.component.ContainerLifeCycle
implements Handler

AbstractHandler.

A convenience implementation of Handler that uses the ContainerLifeCycle to provide:

• start/stop behavior
• a bean container
• basic Dumpable support
• a Server reference
• optional error dispatch handling

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	AbstractHandler.ErrorDispatchHandler	An extension of AbstractHandler that handles DispatcherType.ERROR dispatches.

Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.AbstractLifeCycle.AbstractLifeCycleListener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.Container

org.eclipse.jetty.util.component.Container.InheritedListener, org.eclipse.jetty.util.component.Container.Listener

Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle

org.eclipse.jetty.util.component.LifeCycle.Listener

Field Summary

Fields inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING

Constructor Summary

Constructors

Constructor	Description
AbstractHandler()

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected void	doError(java.lang.String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)	Convenience method to generate error page.
protected void	doStart()
protected void	doStop()
void	dumpThis(java.lang.Appendable out)
Server	getServer()
abstract void	handle(java.lang.String target, Request baseRequest, HttpServletRequest request, HttpServletResponse response)	Handle a request.
void	setServer(Server server)

Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle

addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop, toString

Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle

addBean, addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dump, dumpBeans, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isManaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, start, stop, unmanage, updateBean, updateBean, updateBeans

Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle

addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, start, stop, stop

Methods inherited from class java.lang.Object

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

Constructor Detail

AbstractHandler

public AbstractHandler()

Method Detail

handle

public abstract void handle(java.lang.String target,
                            Request baseRequest,
                            HttpServletRequest request,
                            HttpServletResponse response)
                     throws java.io.IOException,
                            ServletException

Description copied from interface: Handler

Handle a request.

Specified by:

handle in interface Handler

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.

Throws:

java.io.IOException - if unable to handle the request or response processing

ServletException - if unable to handle the request or response due to underlying servlet issue

doError

protected void doError(java.lang.String target,
                       Request baseRequest,
                       HttpServletRequest request,
                       HttpServletResponse response)
                throws java.io.IOException,
                       ServletException

Convenience method to generate error page.

This method can be called from handle(String, Request, HttpServletRequest, HttpServletResponse) when an DispatcherType.ERROR dispatch is detected and an error page needs to be generated by calling HttpServletResponse.sendError(int, String) with the appropriate code and reason, which are taken from ServletRequest.getAttribute(String) for RequestDispatcher.ERROR_STATUS_CODE and RequestDispatcher.ERROR_MESSAGE

Parameters:

target - The target of the request - either a URI or a name.

baseRequest - The original unwrapped request object.

request - The request either as the Request object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getRequest() method can be used access the Request object if required.

response - The response as the Response object or a wrapper of that request. The HttpConnection.getCurrentConnection().getHttpChannel().getResponse() method can be used access the Response object if required.

Throws:

java.io.IOException - if unable to handle the request or response processing

ServletException - if unable to handle the request or response due to underlying servlet issue

See Also:

for a convenience class that calls this method.

doStart

protected void doStart()
                throws java.lang.Exception

Overrides:

doStart in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

java.lang.Exception

doStop

protected void doStop()
               throws java.lang.Exception

Overrides:

doStop in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

java.lang.Exception

setServer

public void setServer(Server server)

Specified by:

setServer in interface Handler

getServer

public Server getServer()

Specified by:

getServer in interface Handler

destroy

public void destroy()

Specified by:

destroy in interface org.eclipse.jetty.util.component.Destroyable

Specified by:

destroy in interface Handler

Overrides:

destroy in class org.eclipse.jetty.util.component.ContainerLifeCycle

dumpThis

public void dumpThis(java.lang.Appendable out)
              throws java.io.IOException

Overrides:

dumpThis in class org.eclipse.jetty.util.component.ContainerLifeCycle

Throws:

java.io.IOException