Package org.eclipse.jetty.servlet

Class ServletHandler

java.lang.Object

org.eclipse.jetty.util.component.AbstractLifeCycle

org.eclipse.jetty.util.component.ContainerLifeCycle

org.eclipse.jetty.server.handler.AbstractHandler

org.eclipse.jetty.server.handler.AbstractHandlerContainer

org.eclipse.jetty.server.handler.HandlerWrapper

org.eclipse.jetty.server.handler.ScopedHandler

org.eclipse.jetty.servlet.ServletHandler

All Implemented Interfaces:

Handler, HandlerContainer, Container, Destroyable, Dumpable, Dumpable.DumpableContainer, LifeCycle

Direct Known Subclasses:

AntWebAppContext.AntServletHandler

@ManagedObject("Servlet Handler")
public class ServletHandler
extends ScopedHandler

Servlet HttpHandler.

This handler maps requests to servlets that implement the jakarta.servlet.http.HttpServlet API.

This handler does not implement the full J2EE features and is intended to be used directly when a full web application is not required. If a Web application is required, then this handler should be used as part of a org.eclipse.jetty.webapp.WebAppContext.

Unless run as part of a ServletContextHandler or derivative, the initialize() method must be called manually after start().

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	ServletHandler.Default404Servlet
static class	ServletHandler.MappedServlet	A mapping of a servlet by pathSpec or by name

Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.AbstractHandler

AbstractHandler.ErrorDispatchHandler

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

AbstractLifeCycle.AbstractLifeCycleListener, AbstractLifeCycle.StopException

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

Container.InheritedListener, Container.Listener

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

Dumpable.DumpableContainer

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

LifeCycle.Listener

Field Summary

Fields

Modifier and Type	Field	Description
protected final ConcurrentMap<String,jakarta.servlet.FilterChain>[]	_chainCache

Fields inherited from class org.eclipse.jetty.server.handler.ScopedHandler

_nextScope, _outerScope

Fields inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

_handler

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
ServletHandler()	Constructor.

Method Summary

Modifier and Type	Method	Description
void	addFilter(FilterHolder filter)	Convenience method to add a preconstructed FilterHolder
void	addFilter(FilterHolder filter, FilterMapping filterMapping)	Convenience method to add a filter and mapping
void	addFilterMapping(FilterMapping mapping)	Convenience method to add a preconstructed FilterMapping
FilterHolder	addFilterWithMapping(Class<? extends jakarta.servlet.Filter> filter, String pathSpec, int dispatches)	Convenience method to add a filter.
FilterHolder	addFilterWithMapping(Class<? extends jakarta.servlet.Filter> filter, String pathSpec, EnumSet<jakarta.servlet.DispatcherType> dispatches)	Convenience method to add a filter.
FilterHolder	addFilterWithMapping(String className, String pathSpec, int dispatches)	Convenience method to add a filter.
FilterHolder	addFilterWithMapping(String className, String pathSpec, EnumSet<jakarta.servlet.DispatcherType> dispatches)	Convenience method to add a filter.
void	addFilterWithMapping(FilterHolder holder, String pathSpec, int dispatches)	Convenience method to add a filter.
void	addFilterWithMapping(FilterHolder holder, String pathSpec, EnumSet<jakarta.servlet.DispatcherType> dispatches)	Convenience method to add a filter.
void	addListener(ListenerHolder listener)	Add a holder for a listener
void	addServlet(ServletHolder holder)	Convenience method to add a pre-constructed ServletHolder.
void	addServletMapping(ServletMapping mapping)	Convenience method to add a pre-constructed ServletMapping.
ServletHolder	addServletWithMapping(Class<? extends jakarta.servlet.Servlet> servlet, String pathSpec)	Convenience method to add a servlet.
ServletHolder	addServletWithMapping(String className, String pathSpec)	Convenience method to add a servlet.
void	addServletWithMapping(ServletHolder servlet, String pathSpec)	Convenience method to add a servlet.
protected PathSpec	asPathSpec(String pathSpec)
protected boolean	containsFilterHolder(FilterHolder holder)
protected boolean	containsServletHolder(ServletHolder holder)
void	doHandle(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Do the handler work within the scope.
void	doScope(String target, Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)	Scope the handler
protected void	doStart()	Starts the managed lifecycle beans in the order they were added.
protected void	doStop()	Stops the managed lifecycle beans in the reverse order they were added.
void	dump(Appendable out, String indent)	Dump this object (and children) into an Appendable using the provided indent after any new lines.
FilterHolder	getFilter(String name)
protected jakarta.servlet.FilterChain	getFilterChain(Request baseRequest, String pathInContext, ServletHolder servletHolder)
FilterMapping[]	getFilterMappings()
FilterHolder[]	getFilters()
MappedResource<ServletHandler.MappedServlet>	getHolderEntry(String target)	Deprecated. Use getMatchedServlet(String) instead
protected IdentityService	getIdentityService()
ListenerHolder[]	getListeners()
ServletHandler.MappedServlet	getMappedServlet(String target)	Deprecated. use getMatchedServlet(String) instead
MatchedResource<ServletHandler.MappedServlet>	getMatchedServlet(String target)	ServletHolder matching target path.
int	getMaxFilterChainsCacheSize()
ServletHolder	getServlet(String name)
jakarta.servlet.ServletContext	getServletContext()
ServletContextHandler	getServletContextHandler()
ServletMapping	getServletMapping(String pathSpec)	Get the ServletMapping matching the path
ServletMapping[]	getServletMappings()
ServletHolder[]	getServlets()
List<ServletHolder>	getServlets(Class<?> clazz)
void	initialize()	Initialize filters and load-on-startup servlets.
protected void	initializeHolders(Collection<? extends BaseHolder<?>> holders)
protected void	invalidateChainsCache()
boolean	isAllowDuplicateMappings()
boolean	isAvailable()
boolean	isDumpable(Object o)
boolean	isEnsureDefaultServlet()
boolean	isFilterChainsCached()
boolean	isInitialized()
boolean	isStartWithUnavailable()
protected jakarta.servlet.FilterChain	newFilterChain(FilterHolder filterHolder, jakarta.servlet.FilterChain chain)	Create a FilterChain that calls the passed filter with the passed chain
FilterHolder	newFilterHolder(Source source)
ListenerHolder	newListenerHolder(Source source)
ServletHolder	newServletHolder(Source source)	Add a new servlet holder
protected void	notFound(Request baseRequest, jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response)
void	prependFilter(FilterHolder filter)	Convenience method to add a preconstructed FilterHolder
void	prependFilterMapping(FilterMapping mapping)	Convenience method to add a preconstructed FilterMapping
void	removeFilterHolder(FilterHolder holder)
void	removeFilterMapping(FilterMapping mapping)
void	setAllowDuplicateMappings(boolean allowDuplicateMappings)
void	setEnsureDefaultServlet(boolean ensureDefaultServlet)
void	setFilterChainsCached(boolean filterChainsCached)
void	setFilterMappings(FilterMapping[] filterMappings)
void	setFilters(FilterHolder[] holders)
void	setListeners(ListenerHolder[] holders)
void	setMaxFilterChainsCacheSize(int maxFilterChainsCacheSize)	Set the maximum filter chain cache size.
void	setServletMappings(ServletMapping[] servletMappings)
void	setServlets(ServletHolder[] holders)	Set Servlets.
Set<String>	setServletSecurity(jakarta.servlet.ServletRegistration.Dynamic registration, jakarta.servlet.ServletSecurityElement servletSecurityElement)
void	setStartWithUnavailable(boolean start)
protected void	start(LifeCycle l)	Starts the given lifecycle.
protected void	stop(LifeCycle l)	Stops the given lifecycle.
protected void	updateMappings()
protected void	updateNameMappings()

Methods inherited from class org.eclipse.jetty.server.handler.ScopedHandler

handle, nextHandle, nextScope

Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper

destroy, expandChildren, getHandler, getHandlers, insertHandler, setHandler

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer

expandHandler, findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass, setServer

Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler

doError, getServer

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

addBean, addBean, addEventListener, addManaged, contains, dump, dump, dumpObjects, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, 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.LifeCycle

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

Field Details

_chainCache

protected final ConcurrentMap<String,jakarta.servlet.FilterChain>[] _chainCache

Constructor Details

ServletHandler

public ServletHandler()

Constructor.

Method Details

isDumpable

public boolean isDumpable(Object o)

dump

public void dump(Appendable out,
 String indent)
          throws IOException

Description copied from interface: Dumpable

Dump this object (and children) into an Appendable using the provided indent after any new lines. The indent should not be applied to the first object dumped.

Specified by:

dump in interface Dumpable

Overrides:

dump in class ContainerLifeCycle

Parameters:

out - The appendable to dump to

indent - The indent to apply after any new lines.

Throws:

IOException - if unable to write to Appendable

doStart

protected void doStart()
                throws Exception

Description copied from class: ContainerLifeCycle

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

Overrides:

doStart in class ScopedHandler

Throws:

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

isEnsureDefaultServlet

public boolean isEnsureDefaultServlet()

Returns:

true if ServletHandler always has a default servlet, using ServletHandler.Default404Servlet if no other default servlet is configured.

setEnsureDefaultServlet

public void setEnsureDefaultServlet(boolean ensureDefaultServlet)

Parameters:

ensureDefaultServlet - true if ServletHandler always has a default servlet, using ServletHandler.Default404Servlet if no other default servlet is configured.

start

protected void start(LifeCycle l)
              throws Exception

Description copied from class: ContainerLifeCycle

Starts the given lifecycle.

Overrides:

start in class ContainerLifeCycle

Parameters:

l - the lifecycle to start

Throws:

Exception - if unable to start lifecycle

stop

protected void stop(LifeCycle l)
             throws Exception

Description copied from class: ContainerLifeCycle

Stops the given lifecycle.

Overrides:

stop in class ContainerLifeCycle

Parameters:

l - the lifecycle to stop

Throws:

Exception - if unable to stop the lifecycle

doStop

protected void doStop()
               throws Exception

Description copied from class: ContainerLifeCycle

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

Overrides:

doStop in class AbstractHandler

Throws:

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

getIdentityService

protected IdentityService getIdentityService()

getFilterMappings

@ManagedAttribute(value="filters",
                  readonly=true)
public FilterMapping[] getFilterMappings()

getFilters

@ManagedAttribute(value="filters",
                  readonly=true)
public FilterHolder[] getFilters()

getHolderEntry

@Deprecated
public MappedResource<ServletHandler.MappedServlet> getHolderEntry(String target)

Deprecated.

Use getMatchedServlet(String) instead

ServletHolder matching path.

Parameters:

target - Path within _context or servlet name

Returns:

PathMap Entries pathspec to ServletHolder

getServletContext

public jakarta.servlet.ServletContext getServletContext()

getServletContextHandler

public ServletContextHandler getServletContextHandler()

getServletMappings

@ManagedAttribute(value="mappings of servlets",
                  readonly=true)
public ServletMapping[] getServletMappings()

getServletMapping

public ServletMapping getServletMapping(String pathSpec)

Get the ServletMapping matching the path

Parameters:

pathSpec - the path spec

Returns:

the servlet mapping for the path spec (or null if not found)

getServlets

@ManagedAttribute(value="servlets",
                  readonly=true)
public ServletHolder[] getServlets()

getServlets

public List<ServletHolder> getServlets(Class<?> clazz)

getServlet

public ServletHolder getServlet(String name)

doScope

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

Description copied from class: ScopedHandler

Scope the handler

Derived implementations should call ScopedHandler.nextScope(String, Request, HttpServletRequest, HttpServletResponse)

Overrides:

doScope in class ScopedHandler

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

doHandle

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

Description copied from class: ScopedHandler

Do the handler work within the scope.

Derived implementations should call ScopedHandler.nextHandle(String, Request, HttpServletRequest, HttpServletResponse)

Specified by:

doHandle in class ScopedHandler

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

getMatchedServlet

public MatchedResource<ServletHandler.MappedServlet> getMatchedServlet(String target)

ServletHolder matching target path.

Parameters:

target - Path within _context or servlet name

Returns:

MatchedResource, pointing to the MappedResource for the ServletHolder, and also the pathspec specific name/info sections for the match. Named servlets have a null PathSpec and MatchedResource.

getMappedServlet

@Deprecated
public ServletHandler.MappedServlet getMappedServlet(String target)

Deprecated.

use getMatchedServlet(String) instead

ServletHolder matching path.

Parameters:

target - Path within _context or servlet name

Returns:

MappedResource to the ServletHolder. Named servlets have a null PathSpec

getFilterChain

protected jakarta.servlet.FilterChain getFilterChain(Request baseRequest,
 String pathInContext,
 ServletHolder servletHolder)

newFilterChain

protected jakarta.servlet.FilterChain newFilterChain(FilterHolder filterHolder,
 jakarta.servlet.FilterChain chain)

Create a FilterChain that calls the passed filter with the passed chain

Parameters:

filterHolder - The filter to invoke

chain - The chain to pass to the filter

Returns:

A FilterChain that invokes the filter with the chain

invalidateChainsCache

protected void invalidateChainsCache()

isAvailable

public boolean isAvailable()

Returns:

true if the handler is started and there are no unavailable servlets

setStartWithUnavailable

public void setStartWithUnavailable(boolean start)

Parameters:

start - True if this handler will start with unavailable servlets

isAllowDuplicateMappings

public boolean isAllowDuplicateMappings()

Returns:

the allowDuplicateMappings

setAllowDuplicateMappings

public void setAllowDuplicateMappings(boolean allowDuplicateMappings)

Parameters:

allowDuplicateMappings - the allowDuplicateMappings to set

isStartWithUnavailable

public boolean isStartWithUnavailable()

Returns:

True if this handler will start with unavailable servlets

initialize

public void initialize()
                throws Exception

Initialize filters and load-on-startup servlets.

Throws:

Exception - if unable to initialize

isInitialized

public boolean isInitialized()

Returns:

true if initialized has been called, false otherwise

initializeHolders

protected void initializeHolders(Collection<? extends BaseHolder<?>> holders)

isFilterChainsCached

public boolean isFilterChainsCached()

Returns:

whether the filter chains are cached.

addListener

public void addListener(ListenerHolder listener)

Add a holder for a listener

Parameters:

listener - the listener for the holder

getListeners

public ListenerHolder[] getListeners()

setListeners

public void setListeners(ListenerHolder[] holders)

newListenerHolder

public ListenerHolder newListenerHolder(Source source)

newServletHolder

public ServletHolder newServletHolder(Source source)

Add a new servlet holder

Parameters:

source - the holder source

Returns:

the servlet holder

addServletWithMapping

public ServletHolder addServletWithMapping(String className,
 String pathSpec)

Convenience method to add a servlet.

Parameters:

className - the class name

pathSpec - the path spec

Returns:

The servlet holder.

addServletWithMapping

public ServletHolder addServletWithMapping(Class<? extends jakarta.servlet.Servlet> servlet,
 String pathSpec)

Convenience method to add a servlet.

Parameters:

servlet - the servlet class

pathSpec - the path spec

Returns:

The servlet holder.

addServletWithMapping

public void addServletWithMapping(ServletHolder servlet,
 String pathSpec)

Convenience method to add a servlet.

Parameters:

servlet - servlet holder to add

pathSpec - servlet mappings for the servletHolder

addServlet

public void addServlet(ServletHolder holder)

Convenience method to add a pre-constructed ServletHolder.

Parameters:

holder - the servlet holder

addServletMapping

public void addServletMapping(ServletMapping mapping)

Convenience method to add a pre-constructed ServletMapping.

Parameters:

mapping - the servlet mapping

setServletSecurity

public Set<String> setServletSecurity(jakarta.servlet.ServletRegistration.Dynamic registration,
 jakarta.servlet.ServletSecurityElement servletSecurityElement)

newFilterHolder

public FilterHolder newFilterHolder(Source source)

getFilter

public FilterHolder getFilter(String name)

addFilterWithMapping

public FilterHolder addFilterWithMapping(Class<? extends jakarta.servlet.Filter> filter,
 String pathSpec,
 EnumSet<jakarta.servlet.DispatcherType> dispatches)

Convenience method to add a filter.

Parameters:

filter - class of filter to create

pathSpec - filter mappings for filter

dispatches - see FilterMapping.setDispatches(int)

Returns:

The filter holder.

addFilterWithMapping

public FilterHolder addFilterWithMapping(String className,
 String pathSpec,
 EnumSet<jakarta.servlet.DispatcherType> dispatches)

Convenience method to add a filter.

Parameters:

className - of filter

pathSpec - filter mappings for filter

dispatches - see FilterMapping.setDispatches(int)

Returns:

The filter holder.

addFilterWithMapping

public void addFilterWithMapping(FilterHolder holder,
 String pathSpec,
 EnumSet<jakarta.servlet.DispatcherType> dispatches)

Convenience method to add a filter.

Parameters:

holder - filter holder to add

pathSpec - filter mappings for filter

dispatches - see FilterMapping.setDispatches(int)

addFilterWithMapping

public FilterHolder addFilterWithMapping(Class<? extends jakarta.servlet.Filter> filter,
 String pathSpec,
 int dispatches)

Convenience method to add a filter.

Parameters:

filter - class of filter to create

pathSpec - filter mappings for filter

dispatches - see FilterMapping.setDispatches(int)

Returns:

The filter holder.

addFilterWithMapping

public FilterHolder addFilterWithMapping(String className,
 String pathSpec,
 int dispatches)

Convenience method to add a filter.

Parameters:

className - of filter

pathSpec - filter mappings for filter

dispatches - see FilterMapping.setDispatches(int)

Returns:

The filter holder.

addFilterWithMapping

public void addFilterWithMapping(FilterHolder holder,
 String pathSpec,
 int dispatches)

Convenience method to add a filter.

Parameters:

holder - filter holder to add

pathSpec - filter mappings for filter

dispatches - see FilterMapping.setDispatches(int)

addFilter

public void addFilter(FilterHolder filter,
 FilterMapping filterMapping)

Convenience method to add a filter and mapping

Parameters:

filter - the filter holder

filterMapping - the filter mapping

addFilter

public void addFilter(FilterHolder filter)

Convenience method to add a preconstructed FilterHolder

Parameters:

filter - the filter holder

prependFilter

public void prependFilter(FilterHolder filter)

Convenience method to add a preconstructed FilterHolder

Parameters:

filter - the filter holder

addFilterMapping

public void addFilterMapping(FilterMapping mapping)

Convenience method to add a preconstructed FilterMapping

Parameters:

mapping - the filter mapping

prependFilterMapping

public void prependFilterMapping(FilterMapping mapping)

Convenience method to add a preconstructed FilterMapping

Parameters:

mapping - the filter mapping

removeFilterHolder

public void removeFilterHolder(FilterHolder holder)

removeFilterMapping

public void removeFilterMapping(FilterMapping mapping)

updateNameMappings

protected void updateNameMappings()

asPathSpec

protected PathSpec asPathSpec(String pathSpec)

updateMappings

protected void updateMappings()

notFound

protected void notFound(Request baseRequest,
 jakarta.servlet.http.HttpServletRequest request,
 jakarta.servlet.http.HttpServletResponse response)
                 throws IOException,
jakarta.servlet.ServletException

Throws:

IOException

jakarta.servlet.ServletException

containsFilterHolder

protected boolean containsFilterHolder(FilterHolder holder)

containsServletHolder

protected boolean containsServletHolder(ServletHolder holder)

setFilterChainsCached

public void setFilterChainsCached(boolean filterChainsCached)

Parameters:

filterChainsCached - The filterChainsCached to set.

setFilterMappings

public void setFilterMappings(FilterMapping[] filterMappings)

Parameters:

filterMappings - The filterMappings to set.

setFilters

public void setFilters(FilterHolder[] holders)

setServletMappings

public void setServletMappings(ServletMapping[] servletMappings)

Parameters:

servletMappings - The servletMappings to set.

setServlets

public void setServlets(ServletHolder[] holders)

Set Servlets.

Parameters:

holders - Array of servlets to define

getMaxFilterChainsCacheSize

public int getMaxFilterChainsCacheSize()

Returns:

The maximum entries in a filter chain cache.

setMaxFilterChainsCacheSize

public void setMaxFilterChainsCacheSize(int maxFilterChainsCacheSize)

Set the maximum filter chain cache size. Filter chains are cached if isFilterChainsCached() is true. If the max cache size is greater than zero, then the cache is flushed whenever it grows to be this size.

Parameters:

maxFilterChainsCacheSize - the maximum number of entries in a filter chain cache.