Top Description Inners Fields Constructors Methods
org.eclipse.jetty.ee10.servlet

public Class ServletContextHandler

extends ContextHandler
Class Inheritance
Annotations
@ManagedObject:Servlet Context Handler
Imports
java.io.File, .IOException, .InputStream, java.net.MalformedURLException, .URI, .URL, java.nio.charset.Charset, java.nio.file.Files, .Path, java.util.ArrayList, .Arrays, .Collections, .EnumSet, .Enumeration, .EventListener, .HashMap, .HashSet, .List, .Locale, .Map, .Objects, .Set, java.util.concurrent.CopyOnWriteArrayList, .TimeUnit, java.util.function.Supplier, jakarta.servlet.DispatcherType, .Filter, .FilterRegistration, .RequestDispatcher, .Servlet, .ServletContainerInitializer, .ServletContextAttributeEvent, .ServletContextAttributeListener, .ServletContextEvent, .ServletContextListener, .ServletException, .ServletRegistration, .ServletRequestAttributeListener, .ServletRequestEvent, .ServletRequestListener, .ServletSecurityElement, .SessionCookieConfig, .SessionTrackingMode, jakarta.servlet.descriptor.JspConfigDescriptor, .JspPropertyGroupDescriptor, .TaglibDescriptor, jakarta.servlet.http.HttpServlet, .HttpServletRequest, .HttpServletResponse, .HttpSessionActivationListener, .HttpSessionAttributeListener, .HttpSessionBindingListener, .HttpSessionIdListener, .HttpSessionListener, org.eclipse.jetty.ee10.servlet.ServletContextResponse.EncodingFrom, .ServletContextResponse.OutputType, org.eclipse.jetty.ee10.servlet.security.ConstraintAware, .ConstraintMapping, .ConstraintSecurityHandler, org.eclipse.jetty.http.HttpURI, org.eclipse.jetty.http.pathmap.MatchedResource, org.eclipse.jetty.security.SecurityHandler, org.eclipse.jetty.server.Context, .Handler, .Request, .Response, org.eclipse.jetty.server.handler.ContextHandler, .ContextHandlerCollection, .ContextRequest, .ContextResponse, org.eclipse.jetty.session.AbstractSessionManager, .ManagedSession, .SessionManager, org.eclipse.jetty.util.Attributes, .Callback, .DecoratedObjectFactory, .DeprecationWarning, .ExceptionUtil, .Loader, .StringUtil, .URIUtil, org.eclipse.jetty.util.annotation.ManagedAttribute, .ManagedObject, org.eclipse.jetty.util.component.ClassLoaderDump, .ContainerLifeCycle, .Dumpable, .DumpableCollection, .Environment, .LifeCycle, org.eclipse.jetty.util.resource.Resource, .ResourceFactory, .Resources, org.eclipse.jetty.util.security.SecurityUtils, org.slf4j.Logger, .LoggerFactory
Servlet Context.

This extension to the ContextHandler allows for simple construction of a context with ServletHandler and optionally session and security handlers, et. 

  new ServletContext("/context",Context.SESSIONS|Context.NO_SECURITY);

This class should have been called ServletContext, but this would have cause confusion with jakarta.servlet.ServletContext.

Nested and Inner Type Summary

Modifier and TypeClass and Description
public static enum
ServletContextHandler.ContextStatus

public static class
ServletContextHandler.JspConfig

public static class
ServletContextHandler.JspPropertyGroup

public static interface
ServletContextHandler.ServletContainerInitializerCaller

public static class
ServletContextHandler.ServletContainerInitializerStarter

Bean that is added to the ServletContextHandler to start all of the ServletContainerInitializers by starting their corresponding ServletContainerInitializerHolders when this bean is itself started.

public class
ServletContextHandler.ServletContextApi

public static interface
ServletContextHandler.ServletContextScopeListener

Listener for all threads entering context scope, including async IO callbacks

public static interface
ServletContextHandler.ServletRequestInfo

The interface used by ServletApiRequest to access the ServletContextRequest without access to the unwrapped Request methods.

public static interface
ServletContextHandler.ServletResponseInfo

The interface used by ServletApiResponse to access the ServletContextResponse without access to the unwrapped Response methods.

public class
ServletContextHandler.ServletScopedContext

public static class
ServletContextHandler.TagLib

Field Summary

Modifier and TypeField and Description
public static final Environment
__environment

private final List<ServletContextHandler.ServletContextScopeListener>
_contextListeners

Hides org.eclipse.jetty.server.handler.ContextHandler._contextListeners.

private String
_contextPathEncoded

protected ServletContextHandler.ContextStatus
_contextStatus

private String
_defaultRequestCharacterEncoding

private String
_defaultResponseCharacterEncoding

private Class<? extends SecurityHandler>
_defaultSecurityHandlerClass

private final List<ServletContextListener>
_destroyServletContextListeners

private final Set<EventListener>
_durableListeners

private final Map<String, String>
_initParams

protected JspConfigDescriptor
_jspConfig

private Map<String, String>
_localeEncodingMap

private Logger
_logger

private int
_maxFormContentSize

private int
_maxFormKeys

protected final DecoratedObjectFactory
_objFactory

protected int
_options

private final List<EventListener>
_programmaticListeners

protected SecurityHandler
_securityHandler

private final ServletContextHandler.ServletContextApi
_servletContext

private final List<ServletContextAttributeListener>
_servletContextAttributeListeners

private final List<ServletContextListener>
_servletContextListeners

protected ServletHandler
_servletHandler

private final List<ServletRequestAttributeListener>
_servletRequestAttributeListeners

private final List<ServletRequestListener>
_servletRequestListeners

protected SessionHandler
_sessionHandler

private boolean
_startListeners

private boolean
_usingSecurityManager

private String[]
_welcomeFiles

public static final int
DEFAULT_LISTENER_TYPE_INDEX

public static final int
DEFAULT_MAX_FORM_CONTENT_SIZE

public static final int
DEFAULT_MAX_FORM_KEYS

public static final int
EXTENDED_LISTENER_TYPE_INDEX

private static final Logger
LOG

Hides org.eclipse.jetty.server.handler.ContextHandler.LOG.

public static final String
MAX_FORM_CONTENT_SIZE_KEY

public static final String
MAX_FORM_KEYS_KEY

public static final int
NO_SECURITY

public static final int
NO_SESSIONS

public static final int
SECURITY

public static final Class<?>[]
SERVLET_LISTENER_TYPES

public static final int
SESSIONS

Inherited from org.eclipse.jetty.server.handler.ContextHandler:
MANAGED_ATTRIBUTES

Constructor Summary

AccessConstructor and Description
public
ServletContextHandler()

public
ServletContextHandler(String contextPath)

public
ServletContextHandler(int options)

public
ServletContextHandler(String contextPath, int options)

public
ServletContextHandler(String contextPath, boolean sessions, boolean security)

public
ServletContextHandler(SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler)

public
ServletContextHandler(String contextPath, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler)

public
ServletContextHandler(String contextPath, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler, int options)

Method Summary

Modifier and TypeMethod and Description
public boolean

Returns:

true if the listener was added
addEventListener(EventListener
the event listener to add
listener)

Overrides org.eclipse.jetty.server.handler.ContextHandler.addEventListener.

Implements org.eclipse.jetty.util.component.LifeCycle.addEventListener, org.eclipse.jetty.util.component.Container.addEventListener.

Add a context event listeners.

public void
addFilter(FilterHolder
the filter holder
holder, String
the path spec
pathSpec, EnumSet<DispatcherType>
the dispatcher types for this filter
dispatches)

Convenience method to add a filter

public FilterHolder

Returns:

the FilterHolder that was created
addFilter(Class<? extends Filter>
the filter class
filterClass, String
the path spec
pathSpec, EnumSet<DispatcherType>
the dispatcher types for this filter
dispatches)

Convenience method to add a filter

public FilterHolder

Returns:

the FilterHolder that was created
addFilter(String
the filter class name
filterClass, String
the path spec
pathSpec, EnumSet<DispatcherType>
the dispatcher types for this filter
dispatches)

Convenience method to add a filter

public FilterHolder

Returns:

the FilterHolder that was created
addFilter(Filter
the filter instance
filter, String
the path spec
pathSpec, EnumSet<DispatcherType>
the dispatcher types for this filter
dispatches)

Convenience method to add a servlet.

public void
addLocaleEncoding(String locale, String encoding)

protected void
addProgrammaticListener(EventListener
the programmatic listener to add
listener)

Apply any necessary restrictions on a programmatic added listener.

protected void
addRoles(String...
role names to add
roleNames)

delegate for ServletContext.declareRole method

public ServletHolder

Returns:

the ServletHolder for the added servlet
addServlet(String
the servlet class name
className, String
the path spec to map servlet to
pathSpec)

Convenience method to add a servlet.

public ServletHolder

Returns:

the ServletHolder for the added servlet
addServlet(Class<? extends Servlet>
the servlet class
servlet, String
the path spec to map servlet to
pathSpec)

Convenience method to add a servlet.

public void
addServlet(ServletHolder
the servlet holder
servlet, String
the path spec
pathSpec)

Convenience method to add a servlet.

public ServletHolder

Returns:

the ServletHolder for the added servlet
addServlet(HttpServlet
the servlet instance
servlet, String
the path spec
pathSpec)

Convenience method to add a servlet.

public ServletContainerInitializerHolder

Returns:

the ServletContainerInitializerHolder that was created
addServletContainerInitializer(ServletContainerInitializer
the ServletContainerInitializer to register.
sci)

Convenience method to programmatically add a ServletContainerInitializer.

public ServletContainerInitializerHolder

Returns:

the ServletContainerInitializerHolder that was created
addServletContainerInitializer(ServletContainerInitializer
the ServletContainerInitializer to register.
sci, Class<?>...
the Set of application classes.
classes)

Convenience method to programmatically add a ServletContainerInitializer.

public void
addServletContainerInitializer(ServletContainerInitializerHolder...
the ServletContainerInitializerHolders
sciHolders)

Convenience method to programmatically add a list of ServletContainerInitializer.

public void
callContextDestroyed(ServletContextListener l, ServletContextEvent e)

public void
callContextInitialized(ServletContextListener l, ServletContextEvent e)

public void
contextDestroyed()

Call the ServletContextListeners with contextDestroyed.

public void
contextInitialized()

Call the ServletContextListeners contextInitialized methods.

pack-priv void
destroyFilter(Filter filter)

pack-priv void
destroyListener(EventListener listener)

pack-priv void
destroyServlet(Servlet servlet)

private void
doSetHandler(Handler.Singleton wrapper, Handler handler)

protected void
doStart()

Overrides org.eclipse.jetty.server.handler.ContextHandler.doStart.

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

protected void
doStop()

Overrides org.eclipse.jetty.server.handler.ContextHandler.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.server.handler.ContextHandler.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.

protected ServletRegistration.Dynamic

Returns:

the ServletRegistration.Dynamic
dynamicHolderAdded(ServletHolder
new holder created through the api.
holder)

notification that a ServletRegistration has been created so we can track the annotations

public ServletContextHandler.ServletScopedContext
getContext()

Overrides org.eclipse.jetty.server.handler.ContextHandler.getContext.

public String
getContextPathEncoded()

Returns: Returns the encoded contextPath.

public static ServletContext
getCurrentServletContext()

public static ServletContextHandler
getCurrentServletContextHandler()

public String
getDefaultRequestCharacterEncoding()

public String
getDefaultResponseCharacterEncoding()

public Class<? extends SecurityHandler>

Returns:

the defaultSecurityHandlerClass
getDefaultSecurityHandlerClass()

Get the defaultSecurityHandlerClass.

public String
getInitParameter(String name)

public Enumeration<String>
getInitParameterNames()

public Map<String, String>
getInitParams()

Returns: Returns the initParams.

public Invocable.InvocationType
getInvocationType()

Overrides org.eclipse.jetty.server.Handler.Wrapper.getInvocationType.

Overrides default org.eclipse.jetty.server.Request.Handler.getInvocationType.

public String
getLocaleEncoding(String locale)

public String

Returns:

a String representing the character encoding for the locale or null if none found.
getLocaleEncoding(Locale
a Locale value
locale)

Get the character encoding for a locale.

public Map<String, String>

Returns:

a map of all the locale encodings: key is name of the locale and value is the char encoding
getLocaleEncodings()

Get all of the locale encodings

public Logger
getLogger()

private String
getLogNameSuffix()

public int
getMaxFormContentSize()

public int
getMaxFormKeys()

public DecoratedObjectFactory

Returns:

The DecoratedObjectFactory
getObjectFactory()

The DecoratedObjectFactory for use by IoC containers (weld / spring / etc)

public String

Returns:

Returns the encoded contextPath, or empty string for root context
getRequestContextPath()

Get the context path in a form suitable to be returned from HttpServletRequest#getContextPath() or jakarta.servlet.ServletContext#getContextPath().

public Resource

Returns:

the resource, or null if not available.
getResource(String
the path within the base resource to attempt to get
pathInContext)

Attempt to get a Resource from the Context.

public Set<String>
getResourcePaths(String path)

public SecurityHandler
getSecurityHandler()

Returns: Returns the securityHandler.

private static Object
getSecurityManager()

public static ServletContext
getServletContext(Context context)

public ServletContext
getServletContext()

public static ServletContextHandler
getServletContextHandler(ServletContext servletContext, String purpose)

public static ServletContextHandler
getServletContextHandler(ServletContext servletContext)

public ServletHandler
getServletHandler()

Returns: Returns the servletHandler.

public SessionHandler
getSessionHandler()

Returns: Returns the sessionHandler.

public String[]
getWelcomeFiles()

Returns: The names of the files which the server should consider to be welcome files in this context.

protected boolean
handleByContextHandler(String pathInContext, ContextRequest request, Response response, Callback callback)

Overrides org.eclipse.jetty.server.handler.ContextHandler.handleByContextHandler.

public void
insertHandler(Handler.Singleton
the Handler to insert
handler)

Overrides default org.eclipse.jetty.server.Handler.Singleton.insertHandler.

Insert a HandlerWrapper before the first Session, Security or ServletHandler but after any other HandlerWrappers.

public boolean
isDurableListener(EventListener listener)

public boolean
isProgrammaticListener(EventListener listener)

public boolean
isUsingSecurityManager()

public Class<?>
loadClass(String className)

protected ContextHandler.ScopedContext
newContext()

Overrides org.eclipse.jetty.server.handler.ContextHandler.newContext.

public Resource

Returns:

the Resource for that url
newResource(URL
the url to convert to a Resource
url)

Convert URL to Resource wrapper for ResourceFactory#newResource(URL) enables extensions to provide alternate resource implementations.

public Resource

Returns:

the Resource for that URI
newResource(URI
the URI to convert to a Resource
uri)

Convert URL to Resource wrapper for ResourceFactory#newResource(URL) enables extensions to provide alternate resource implementations.

public Resource

Returns:

The Resource for the URL/path
newResource(String
The URL or path to convert
urlOrPath)

Convert a URL or path to a Resource.

protected SecurityHandler
newSecurityHandler()

public ServletContextHandler.ServletContextApi
newServletContextApi()

protected ServletContextRequest
newServletContextRequest(ServletChannel servletChannel, Request request, Response response, String decodedPathInContext, MatchedResource<ServletHandler.MappedServlet> matchedResource)

protected ServletHandler
newServletHandler()

protected SessionHandler
newSessionHandler()

protected void
notifyEnterScope(Request
A request that is applicable to the scope, or null
request)

Overrides org.eclipse.jetty.server.handler.ContextHandler.notifyEnterScope.

protected void
notifyExitScope(Request
A request that is applicable to the scope, or null
request)

Overrides org.eclipse.jetty.server.handler.ContextHandler.notifyExitScope.

private void
relinkHandlers()

public boolean
removeEventListener(EventListener
the listener to remove
listener)

Overrides org.eclipse.jetty.server.handler.ContextHandler.removeEventListener.

Implements org.eclipse.jetty.util.component.LifeCycle.removeEventListener, org.eclipse.jetty.util.component.Container.removeEventListener.

Remove an event listener.

private void
replaceHandler(Handler.Singleton handler, Handler.Singleton replacement)

protected void
requestDestroyed(Request baseRequest, HttpServletRequest request)

protected void
requestInitialized(Request baseRequest, HttpServletRequest request)

public void
setContextPath(String
The _contextPath to set.
contextPath)

Overrides org.eclipse.jetty.server.handler.ContextHandler.setContextPath.

public void
setDefaultRequestCharacterEncoding(String encoding)

public void
setDefaultResponseCharacterEncoding(String encoding)

public void
setDefaultSecurityHandlerClass(Class<? extends SecurityHandler>
the defaultSecurityHandlerClass to set
defaultSecurityHandlerClass)

Set the defaultSecurityHandlerClass.

public void
setHandler(Handler
The Handler to set as a child
handler)

Overrides org.eclipse.jetty.server.Handler.Wrapper.setHandler.

Implements org.eclipse.jetty.server.Handler.Singleton.setHandler.

public String
setInitParameter(String name, String value)

public void
setLogger(Logger logger)

public void
setMaxFormContentSize(int
the maximum size of the form content (in bytes)
maxSize)

Set the maximum size of a form post, to protect against DOS attacks from large forms.

public void
setMaxFormKeys(int
the maximum number of form keys
max)

Set the maximum number of form Keys to protect against DOS attack from crafted hash keys.

public void
setSecurityHandler(SecurityHandler
The SecurityHandler to set on this context.
securityHandler)

public void
setServletHandler(ServletHandler
The servletHandler to set.
servletHandler)

public Set<String>

Returns:

the set of exact URL mappings currently associated with the registration that are also present in the web.xml security constraints and thus will be unaffected by this call.
setServletSecurity(ServletRegistration.Dynamic
ServletRegistration.Dynamic instance that setServletSecurity was called on
registration, ServletSecurityElement
new security info
servletSecurityElement)

Delegate for ServletRegistration.Dynamic.setServletSecurity method

public void
setSessionHandler(SessionHandler
The sessionHandler to set.
sessionHandler)

public void
setTempDirectory(File
A directory. If it does not exist, it must be able to be created during start.
tempDirectory)

Overrides org.eclipse.jetty.server.handler.ContextHandler.setTempDirectory.

Set the temporary directory returned by ScopedContext#getTempDirectory().

public void
setUsingSecurityManager(boolean usingSecurityManager)

public void
setWelcomeFiles(String[] files)

protected void
startContext()

Finish constructing handlers and link them together.

protected void
stopContext()

private ContextRequest
wrapNoServlet(Request request, Response response)

protected ContextRequest
wrapRequest(Request request, Response response)

Overrides org.eclipse.jetty.server.handler.ContextHandler.wrapRequest.

protected ContextResponse
wrapResponse(ContextRequest request, Response response)

Overrides org.eclipse.jetty.server.handler.ContextHandler.wrapResponse.

Inherited from org.eclipse.jetty.server.handler.ContextHandler:
addAliasCheckaddVirtualHostscheckAliascheckVirtualHostclearAliasChecksclearAttributescreateTempDirectorydestroyenterScopeexitScopegetAliasChecksgetAllowNullPathInContextgetAttributegetAttributeNameSetgetBaseResourcegetClassLoadergetClassPathgetContextHandlergetContextPathgetCurrentContextgetCurrentContextgetCurrentContextHandlergetDisplayNamegetErrorHandlergetMimeTypesgetProtectedTargetsgetTempDirectorygetVirtualHostshandlehandleMovedPermanentlyhandleUnavailableisAvailableisProtectedTargetisTempDirectoryPersistentremoveAttributeremoveVirtualHostssetAliasCheckssetAllowNullPathInContextsetAttributesetAvailablesetBaseResourcesetBaseResourceAsPathsetBaseResourceAsStringsetClassLoadersetDisplayNamesetErrorHandlersetProtectedTargetssetServersetTempDirectoryPersistentsetVirtualHoststoString