Module org.eclipse.jetty.ee9.nested

Package org.eclipse.jetty.ee9.nested

Class AbstractHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.ee9.nested.AbstractHandler

All Implemented Interfaces:

Handler, org.eclipse.jetty.util.component.Container, org.eclipse.jetty.util.component.Destroyable, org.eclipse.jetty.util.component.Dumpable, org.eclipse.jetty.util.component.Dumpable.DumpableContainer, org.eclipse.jetty.util.component.LifeCycle

Direct Known Subclasses:

AbstractHandler.ErrorDispatchHandler, AbstractHandlerContainer, ErrorHandler

@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	Deprecated. This class is no longer required as ERROR dispatch is only done if there is an error page target.

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

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

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.Dumpable

org.eclipse.jetty.util.component.Dumpable.DumpableContainer

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, STARTED, STARTING, STOPPED, STOPPING

Fields inherited from interface org.eclipse.jetty.util.component.Dumpable

KEY

Constructor Summary

Constructors

Constructor	Description
AbstractHandler()

Method Summary

Modifier and Type	Method	Description
void	destroy()
protected void	doError(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Deprecated.
protected void	doStart()
protected void	doStop()
org.eclipse.jetty.server.Server	getServer()
abstract void	handle(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handle a request.
void	setServer(org.eclipse.jetty.server.Server server)

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

addBean, addBean, addEventListener, addManaged, contains, dump, 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 org.eclipse.jetty.util.component.AbstractLifeCycle

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

Methods inherited from class java.lang.Object

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

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

getCachedBeans, getEventListeners

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

dumpSelf

Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer

isDumpable

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

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

Constructor Details

AbstractHandler

public AbstractHandler()

Method Details

handle

public abstract void handle(String target,
 Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                     throws IOException,
jakarta.servlet.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.

response - The response as the Response object or a wrapper of that request.

Throws:

IOException - if unable to handle the request or response processing

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

doError

@Deprecated
protected void doError(String target,
 Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                throws IOException,
jakarta.servlet.ServletException

Deprecated.

Deprecated error page generation

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.

response - The response as the Response object or a wrapper of that request.

Throws:

IOException - if unable to handle the request or response processing

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

doStart

protected void doStart()
                throws Exception

Overrides:

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

Throws:

Exception

doStop

protected void doStop()
               throws Exception

Overrides:

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

Throws:

Exception

setServer

public void setServer(org.eclipse.jetty.server.Server server)

Specified by:

setServer in interface Handler

getServer

public org.eclipse.jetty.server.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