Package org.eclipse.jetty.server

Interface Handler

All Superinterfaces:

Destroyable, LifeCycle

All Known Implementing Classes:

AbstractHandler, AbstractHandler.ErrorDispatchHandler, AbstractHandlerContainer, AntWebAppContext, AntWebAppContext.AntServletHandler, AsyncDelayHandler, BufferedResponseHandler, ConnectHandler, ConstraintSecurityHandler, ContextHandler, ContextHandlerCollection, DebugHandler, DefaultHandler, ErrorHandler, ErrorPageErrorHandler, FileBufferedResponseHandler, GzipHandler, HandlerCollection, HandlerList, HandlerWrapper, HotSwapHandler, HttpSpiContextHandler, IdleTimeoutHandler, InetAccessHandler, MovedContextHandler, RequestLogHandler, ResourceHandler, RewriteHandler, ScopedHandler, SecuredRedirectHandler, SecurityHandler, Server, ServletContextHandler, ServletHandler, SessionHandler, ShutdownHandler, StatisticsHandler, ThreadLimitHandler, WebAppContext, WebSocketUpgradeHandler

@ManagedObject("Jetty Handler")
public interface Handler
extends LifeCycle, Destroyable

A Jetty Server Handler.

A Handler instance is required by a Server to handle incoming HTTP requests.

A Handler may:

• Completely generate the HTTP Response
• Examine/modify the request and call another Handler (see HandlerWrapper).
• Pass the request to one or more other Handlers (see HandlerCollection).

Handlers are passed the servlet API request and response object, but are not Servlets. The servlet container is implemented by handlers for context, security, session and servlet that modify the request object before passing it to the next stage of handling.

Nested Class Summary

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

LifeCycle.Listener

Method Summary

Modifier and Type	Method	Description
void	destroy()
Server	getServer()
void	handle(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Handle a request.
void	setServer(Server server)

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

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

Method Details

handle

void handle(String target,
 Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
     throws IOException,
jakarta.servlet.ServletException

Handle a request.

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:

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

setServer

void setServer(Server server)

getServer

@ManagedAttribute(value="the jetty server for this handler",
                  readonly=true)
Server getServer()

destroy

@ManagedOperation(value="destroy associated resources",
                  impact="ACTION")
void destroy()

Specified by:

destroy in interface Destroyable