Jetty 12.0.6 · org.eclipse.jetty.ee10.servlet.ServletHandler

Modifier and Type	Class and Description
pack-priv static class	ServletHandler.Chain
pack-priv static class	ServletHandler.ChainEnd
public static class	ServletHandler.Default404Servlet
public static class	ServletHandler.MappedServlet A mapping of a servlet by pathSpec or by name

Modifier and Type	Field and Description
private boolean	_allowDuplicateMappings
protected final ConcurrentMap<String, FilterChain>[]	_chainCache
private boolean	_decodeAmbiguousURIs
private final List<BaseHolder<?>>	_durable
private boolean	_ensureDefaultServlet
private boolean	_filterChainsCached
private final List<FilterMapping>	_filterMappings
private final Map<String, FilterHolder>	_filterNameMap
private MultiMap<FilterMapping>	_filterNameMappings
private List<FilterMapping>	_filterPathMappings
private final List<FilterHolder>	_filters
private IdentityService	_identityService
private boolean	_initialized
private final List<ListenerHolder>	_listeners Hides org.eclipse.jetty.util.component.ContainerLifeCycle._listeners.
private final AutoLock	_lock Hides org.eclipse.jetty.util.component.AbstractLifeCycle._lock.
private int	_matchAfterIndex
private int	_matchBeforeIndex
private int	_maxFilterChainsCacheSize
private ServletContext	_servletContext
private ServletContextHandler	_servletContextHandler
private final List<ServletMapping>	_servletMappings
private final Map<String, ServletHandler.MappedServlet>	_servletNameMap
private PathMappings<ServletHandler.MappedServlet>	_servletPathMap
private final List<ServletHolder>	_servlets
private boolean	_startWithUnavailable
private List<FilterMapping>	_wildFilterNameMappings
private static final Logger	LOG Hides org.eclipse.jetty.server.Handler.Abstract.LOG.

Access	Constructor and Description
public	ServletHandler() Constructor.

Method Summary

Modifier and Type	Method and Description
public void	addFilter(FilterHolder the filter holder filter, FilterMapping the filter mapping filterMapping) Convenience method to add a filter and mapping
public void	addFilter(FilterHolder the filter holder filter) Convenience method to add a preconstructed FilterHolder
public void	addFilterMapping(FilterMapping the filter mapping mapping) Convenience method to add a preconstructed FilterMapping
public FilterHolder	Returns: The filter holder. addFilterWithMapping(Class<? extends Filter> class of filter to create filter, String filter mappings for filter pathSpec, EnumSet<DispatcherType> see `FilterMapping#setDispatches(int)` dispatches) Convenience method to add a filter.
public FilterHolder	Returns: The filter holder. addFilterWithMapping(String of filter className, String filter mappings for filter pathSpec, EnumSet<DispatcherType> see `FilterMapping#setDispatches(int)` dispatches) Convenience method to add a filter.
public void	addFilterWithMapping(FilterHolder filter holder to add holder, String filter mappings for filter pathSpec, EnumSet<DispatcherType> see `FilterMapping#setDispatches(int)` dispatches) Convenience method to add a filter.
public FilterHolder	Returns: The filter holder. addFilterWithMapping(Class<? extends Filter> class of filter to create filter, String filter mappings for filter pathSpec, int see `FilterMapping#setDispatches(int)` dispatches) Convenience method to add a filter.
public FilterHolder	Returns: The filter holder. addFilterWithMapping(String of filter className, String filter mappings for filter pathSpec, int see `FilterMapping#setDispatches(int)` dispatches) Convenience method to add a filter.
public void	addFilterWithMapping(FilterHolder filter holder to add holder, String filter mappings for filter pathSpec, int see `FilterMapping#setDispatches(int)` dispatches) Convenience method to add a filter.
public void	addListener(ListenerHolder the listener for the holder listener) Add a holder for a listener
public void	addServlet(ServletHolder the servlet holder holder) Convenience method to add a pre-constructed ServletHolder.
public void	addServletMapping(ServletMapping the servlet mapping mapping) Convenience method to add a pre-constructed ServletMapping.
public ServletHolder	Returns: The servlet holder. addServletWithMapping(String the class name className, String the path spec pathSpec) Convenience method to add a servlet.
public ServletHolder	Returns: The servlet holder. addServletWithMapping(Class<? extends Servlet> the servlet class servlet, String the path spec pathSpec) Convenience method to add a servlet.
public void	addServletWithMapping(ServletHolder servlet holder to add servlet, String servlet mappings for the servletHolder pathSpec) Convenience method to add a servlet.
protected PathSpec	asPathSpec(String pathSpec)
protected boolean	containsFilterHolder(FilterHolder holder)
protected boolean	containsServletHolder(ServletHolder holder)
pack-priv void	destroyFilter(Filter filter)
pack-priv void	destroyListener(EventListener listener)
pack-priv void	destroyServlet(Servlet servlet)
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 void	dump(Appendable The appendable to dump to out, String The indent to apply after any new lines. indent) Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.dump. Implements org.eclipse.jetty.util.component.Dumpable.dump. Dump this object (and children) into an Appendable using the provided indent after any new lines.
public FilterHolder	getFilter(String name)
protected FilterChain	getFilterChain(HttpServletRequest request, String pathInContext, ServletHolder servletHolder)
public FilterMapping[]	getFilterMappings()
public FilterHolder[]	getFilters()
protected IdentityService	getIdentityService()
public ListenerHolder[]	getListeners()
public ServletHandler.MappedServlet	Returns: MappedResource to the ServletHolder. Named servlets have a null PathSpec getMappedServlet(String Path within _context or servlet name target) ServletHolder matching path.
public MatchedResource<ServletHandler.MappedServlet>	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`. getMatchedServlet(String Path within _context or servlet name target) ServletHolder matching target path.
public int	getMaxFilterChainsCacheSize() Returns: The maximum entries in a filter chain cache.
public ServletHolder	getServlet(String name)
public ServletContext	getServletContext()
public ServletContextHandler	getServletContextHandler()
public ServletMapping	Returns: the servlet mapping for the path spec (or null if not found) getServletMapping(String the path spec pathSpec) Get the ServletMapping matching the path
public ServletMapping[]	getServletMappings()
public ServletHolder[]	getServlets()
public List<ServletHolder>	getServlets(Class<?> clazz)
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	initialize() Initialize filters and load-on-startup servlets.
protected void	initializeHolders(Collection<? extends BaseHolder<?>> holders)
protected void	invalidateChainsCache()
public boolean	isAllowDuplicateMappings() Returns: the allowDuplicateMappings
public boolean	isAvailable() Returns: true if the handler is started and there are no unavailable servlets
public boolean	isDecodeAmbiguousURIs()
public boolean	isDumpable(Object o) Overrides default org.eclipse.jetty.util.component.Dumpable.DumpableContainer.isDumpable.
public boolean	isEnsureDefaultServlet() Returns: true if ServletHandler always has a default servlet, using `Default404Servlet` if no other default servlet is configured.
public boolean	isFilterChainsCached() Returns: whether the filter chains are cached.
public boolean	isInitialized() Returns: true if initialized has been called, false otherwise
public boolean	isStartWithUnavailable() Returns: True if this handler will start with unavailable servlets
pack-priv AutoLock	lock()
protected FilterChain	Returns: A FilterChain that invokes the filter with the chain newFilterChain(FilterHolder The filter to invoke filterHolder, FilterChain The chain to pass to the filter chain) Create a FilterChain that calls the passed filter with the passed chain
public FilterHolder	newFilterHolder(Source source)
public ListenerHolder	newListenerHolder(Source source)
public ServletHolder	Returns: the servlet holder newServletHolder(Source the holder source source) Add a new servlet holder
protected void	notFound(Request baseRequest, HttpServletRequest request, HttpServletResponse response)
public void	prependFilter(FilterHolder the filter holder filter) Convenience method to add a preconstructed FilterHolder
public void	prependFilterMapping(FilterMapping the filter mapping mapping) Convenience method to add a preconstructed FilterMapping
public void	removeFilterHolder(FilterHolder holder)
public void	removeFilterMapping(FilterMapping mapping)
public void	setAllowDuplicateMappings(boolean the allowDuplicateMappings to set allowDuplicateMappings) Set the allowDuplicateMappings to set.
public void	setDecodeAmbiguousURIs(boolean `True` if ambiguous URIs are decoded by `ServletApiRequest#getServletPath()` and `ServletApiRequest#getPathInfo()`. decodeAmbiguousURIs)
public void	setEnsureDefaultServlet(boolean true if ServletHandler always has a default servlet, using `Default404Servlet` if no other default servlet is configured. ensureDefaultServlet)
public void	setFilterChainsCached(boolean The filterChainsCached to set. filterChainsCached)
public void	setFilterMappings(FilterMapping[] The filterMappings to set. filterMappings)
public void	setFilters(FilterHolder[] holders)
public void	setListeners(ListenerHolder[] holders)
public void	setMaxFilterChainsCacheSize(int the maximum number of entries in a filter chain cache. maxFilterChainsCacheSize) Set the maximum filter chain cache size.
public void	setServletMappings(ServletMapping[] The servletMappings to set. servletMappings)
public void	setServlets(ServletHolder[] Array of servlets to define holders) Set Servlets.
public Set<String>	setServletSecurity(ServletRegistration.Dynamic registration, ServletSecurityElement servletSecurityElement)
public void	setStartWithUnavailable(boolean True if this handler will start with unavailable servlets start)
protected void	start(LifeCycle the lifecycle to start l) Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.start. Starts the given lifecycle.
protected void	stop(LifeCycle the lifecycle to stop l) Overrides org.eclipse.jetty.util.component.ContainerLifeCycle.stop. Stops the given lifecycle.
private <T> void	updateAndSet(Collection<T> target, Collection<T> values)
protected void	updateMappings()
protected void	updateNameMappings()

Inherited from org.eclipse.jetty.server.Handler.Wrapper:: getHandler getInvocationType setHandler

public Class ServletHandler

Nested and Inner Type Summary

Field Summary

Constructor Summary

Method Summary