Package org.eclipse.jetty.servlet
Class ServletContextHandler
- java.lang.Object
-
- All Implemented Interfaces:
Handler
,HandlerContainer
,Attributes
,Container
,Destroyable
,Dumpable
,Dumpable.DumpableContainer
,Graceful
,LifeCycle
- Direct Known Subclasses:
WebAppContext
@ManagedObject("Servlet Context Handler") @Deprecated(since="2021-05-27") public class ServletContextHandler extends ContextHandler
Deprecated.The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.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
ServletContext
.
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description class
ServletContextHandler.Context
Deprecated.static interface
ServletContextHandler.Decorator
Deprecated.use newDecorator
static class
ServletContextHandler.Initializer
Deprecated.The Eclipse Jetty and Apache Felix Http Jetty packages are no longer supported.static class
ServletContextHandler.JspConfig
Deprecated.static class
ServletContextHandler.JspPropertyGroup
Deprecated.static interface
ServletContextHandler.ServletContainerInitializerCaller
Deprecated.static class
ServletContextHandler.TagLib
Deprecated.-
Nested classes/interfaces inherited from class org.eclipse.jetty.server.handler.ContextHandler
ContextHandler.AliasCheck, ContextHandler.ApproveAliases, ContextHandler.ApproveNonExistentDirectoryAliases, ContextHandler.Availability, ContextHandler.ContextScopeListener, ContextHandler.ContextStatus, ContextHandler.StaticContext
-
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
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.Attributes
Attributes.Wrapper
-
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.Graceful
Graceful.Shutdown
-
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle
LifeCycle.Listener
-
-
Field Summary
Fields Modifier and Type Field Description static int
GZIP
Deprecated.static int
NO_SECURITY
Deprecated.static int
NO_SESSIONS
Deprecated.static int
SECURITY
Deprecated.static int
SESSIONS
Deprecated.-
Fields inherited from class org.eclipse.jetty.server.handler.ContextHandler
DEFAULT_LISTENER_TYPE_INDEX, DEFAULT_MAX_FORM_CONTENT_SIZE, DEFAULT_MAX_FORM_KEYS, EXTENDED_LISTENER_TYPE_INDEX, MANAGED_ATTRIBUTES, MAX_FORM_CONTENT_SIZE_KEY, MAX_FORM_KEYS_KEY, SERVLET_LISTENER_TYPES, SERVLET_MAJOR_VERSION, SERVLET_MINOR_VERSION
-
-
Constructor Summary
Constructors Constructor Description ServletContextHandler()
Deprecated.ServletContextHandler(int options)
Deprecated.ServletContextHandler(HandlerContainer parent, java.lang.String contextPath)
Deprecated.ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, boolean sessions, boolean security)
Deprecated.ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, int options)
Deprecated.ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler)
Deprecated.ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler, int options)
Deprecated.ServletContextHandler(HandlerContainer parent, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler)
Deprecated.
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description void
addDecorator(ServletContextHandler.Decorator decorator)
Deprecated.use theDecoratedObjectFactory
from getAttribute("org.eclipse.jetty.util.DecoratedObjectFactory") orgetObjectFactory()
insteadvoid
addEventListener(java.util.EventListener listener)
Deprecated.Add EventListener Adds an EventListener to the list.FilterHolder
addFilter(java.lang.Class<? extends Filter> filterClass, java.lang.String pathSpec, java.util.EnumSet<DispatcherType> dispatches)
Deprecated.Convenience method to add a filterFilterHolder
addFilter(java.lang.String filterClass, java.lang.String pathSpec, java.util.EnumSet<DispatcherType> dispatches)
Deprecated.Convenience method to add a filtervoid
addFilter(FilterHolder holder, java.lang.String pathSpec, java.util.EnumSet<DispatcherType> dispatches)
Deprecated.Convenience method to add a filterServletHolder
addServlet(java.lang.Class<? extends Servlet> servlet, java.lang.String pathSpec)
Deprecated.Convenience method to add a servlet.ServletHolder
addServlet(java.lang.String className, java.lang.String pathSpec)
Deprecated.Convenience method to add a servlet.void
addServlet(ServletHolder servlet, java.lang.String pathSpec)
Deprecated.Convenience method to add a servlet.void
callContextDestroyed(ServletContextListener l, ServletContextEvent e)
Deprecated.void
callContextInitialized(ServletContextListener l, ServletContextEvent e)
Deprecated.java.util.List<ServletContextHandler.Decorator>
getDecorators()
Deprecated.use theDecoratedObjectFactory
from getAttribute("org.eclipse.jetty.util.DecoratedObjectFactory") orgetObjectFactory()
insteadjava.lang.Class<? extends SecurityHandler>
getDefaultSecurityHandlerClass()
Deprecated.Get the defaultSecurityHandlerClass.GzipHandler
getGzipHandler()
Deprecated.DecoratedObjectFactory
getObjectFactory()
Deprecated.The DecoratedObjectFactory for use by IoC containers (weld / spring / etc)SecurityHandler
getSecurityHandler()
Deprecated.static ServletContextHandler
getServletContextHandler(ServletContext context)
Deprecated.ServletHandler
getServletHandler()
Deprecated.SessionHandler
getSessionHandler()
Deprecated.void
insertHandler(HandlerWrapper handler)
Deprecated.Insert a HandlerWrapper before the first Session,Security or ServletHandler but after any other HandlerWrappers.void
setDecorators(java.util.List<ServletContextHandler.Decorator> decorators)
Deprecated.use theDecoratedObjectFactory
from getAttribute("org.eclipse.jetty.util.DecoratedObjectFactory") orgetObjectFactory()
insteadvoid
setDefaultSecurityHandlerClass(java.lang.Class<? extends SecurityHandler> defaultSecurityHandlerClass)
Deprecated.Set the defaultSecurityHandlerClass.void
setGzipHandler(GzipHandler gzipHandler)
Deprecated.void
setHandler(Handler handler)
Deprecated.void
setSecurityHandler(SecurityHandler securityHandler)
Deprecated.void
setServletHandler(ServletHandler servletHandler)
Deprecated.java.util.Set<java.lang.String>
setServletSecurity(ServletRegistration.Dynamic registration, ServletSecurityElement servletSecurityElement)
Deprecated.Delegate for ServletRegistration.Dynamic.setServletSecurity methodvoid
setSessionHandler(SessionHandler sessionHandler)
Deprecated.-
Methods inherited from class org.eclipse.jetty.server.handler.ContextHandler
addAliasCheck, addLocaleEncoding, addVirtualHosts, checkAlias, checkContext, checkContextPath, checkVirtualHost, clearAliasChecks, clearAttributes, contextDestroyed, contextInitialized, doHandle, doScope, dump, getAliasChecks, getAllowNullPathInfo, getAttribute, getAttributeNames, getAttributeNameSet, getAttributes, getBaseResource, getClassLoader, getClassPath, getContextHandler, getContextPath, getContextPathEncoded, getCurrentContext, getDisplayName, getErrorHandler, getEventListeners, getInitParameter, getInitParameterNames, getInitParams, getLocaleEncoding, getLocaleEncoding, getLocaleEncodings, getLogger, getMaxFormContentSize, getMaxFormKeys, getMimeTypes, getProtectedTargets, getRequestContextPath, getResource, getResourceBase, getResourcePaths, getServerInfo, getServletContext, getVirtualHosts, getWelcomeFiles, handle, handle, isAvailable, isCompactPath, isDurableListener, isProgrammaticListener, isProtectedTarget, isShutdown, isUsingSecurityManager, loadClass, newResource, newResource, newResource, removeAttribute, removeEventListener, removeVirtualHosts, setAliasChecks, setAllowNullPathInfo, setAttribute, setAttributes, setAvailable, setBaseResource, setClassLoader, setCompactPath, setContextPath, setDisplayName, setErrorHandler, setEventListeners, setInitParameter, setLogger, setManagedAttribute, setMaxFormContentSize, setMaxFormKeys, setMimeTypes, setProtectedTargets, setResourceBase, setServer, setServerInfo, setUsingSecurityManager, setVirtualHosts, setWelcomeFiles, shutdown, toString
-
Methods inherited from class org.eclipse.jetty.server.handler.ScopedHandler
handle, nextHandle, nextScope
-
Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper
destroy, getHandler, getHandlers
-
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer
findContainerOf, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass
-
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler
getServer
-
Methods inherited from class org.eclipse.jetty.util.component.ContainerLifeCycle
addBean, addBean, addEventListener, addManaged, contains, dump, dump, dump, dump, dumpObject, dumpStdErr, getBean, getBeans, getBeans, getContainedBeans, isAuto, isManaged, isUnmanaged, manage, removeBean, removeBeans, removeEventListener, setBeans, setStopTimeout, unmanage, updateBean, updateBean, updateBeans
-
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle
addLifeCycleListener, getState, getState, getStopTimeout, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
-
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface org.eclipse.jetty.util.component.Dumpable.DumpableContainer
isDumpable
-
Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop
-
-
-
-
Field Detail
-
SESSIONS
public static final int SESSIONS
Deprecated.- See Also:
- Constant Field Values
-
SECURITY
public static final int SECURITY
Deprecated.- See Also:
- Constant Field Values
-
GZIP
public static final int GZIP
Deprecated.- See Also:
- Constant Field Values
-
NO_SESSIONS
public static final int NO_SESSIONS
Deprecated.- See Also:
- Constant Field Values
-
NO_SECURITY
public static final int NO_SECURITY
Deprecated.- See Also:
- Constant Field Values
-
-
Constructor Detail
-
ServletContextHandler
public ServletContextHandler()
Deprecated.
-
ServletContextHandler
public ServletContextHandler(int options)
Deprecated.
-
ServletContextHandler
public ServletContextHandler(HandlerContainer parent, java.lang.String contextPath)
Deprecated.
-
ServletContextHandler
public ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, int options)
Deprecated.
-
ServletContextHandler
public ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, boolean sessions, boolean security)
Deprecated.
-
ServletContextHandler
public ServletContextHandler(HandlerContainer parent, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler)
Deprecated.
-
ServletContextHandler
public ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler)
Deprecated.
-
ServletContextHandler
public ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler, int options)
Deprecated.
-
-
Method Detail
-
addEventListener
public void addEventListener(java.util.EventListener listener)
Deprecated.Add EventListener Adds an EventListener to the list. @see org.eclipse.jetty.server.handler.ContextHandler#addEventListener(). Also adds any listeners that are session related to the SessionHandler.- Overrides:
addEventListener
in classContextHandler
- Parameters:
listener
- the listener to add- See Also:
ServletContextListener
,ServletContextAttributeListener
,ServletRequestListener
,ServletRequestAttributeListener
-
setHandler
public void setHandler(Handler handler)
Deprecated.- Overrides:
setHandler
in classHandlerWrapper
- Parameters:
handler
- Set theHandler
which should be wrapped.
-
getDefaultSecurityHandlerClass
public java.lang.Class<? extends SecurityHandler> getDefaultSecurityHandlerClass()
Deprecated.Get the defaultSecurityHandlerClass.- Returns:
- the defaultSecurityHandlerClass
-
setDefaultSecurityHandlerClass
public void setDefaultSecurityHandlerClass(java.lang.Class<? extends SecurityHandler> defaultSecurityHandlerClass)
Deprecated.Set the defaultSecurityHandlerClass.- Parameters:
defaultSecurityHandlerClass
- the defaultSecurityHandlerClass to set
-
getSecurityHandler
@ManagedAttribute(value="context security handler", readonly=true) public SecurityHandler getSecurityHandler()
Deprecated.- Returns:
- Returns the securityHandler.
-
getServletHandler
@ManagedAttribute(value="context servlet handler", readonly=true) public ServletHandler getServletHandler()
Deprecated.- Returns:
- Returns the servletHandler.
-
getSessionHandler
@ManagedAttribute(value="context session handler", readonly=true) public SessionHandler getSessionHandler()
Deprecated.- Returns:
- Returns the sessionHandler.
-
getGzipHandler
@ManagedAttribute(value="context gzip handler", readonly=true) public GzipHandler getGzipHandler()
Deprecated.- Returns:
- Returns the gzipHandler.
-
addServlet
public ServletHolder addServlet(java.lang.String className, java.lang.String pathSpec)
Deprecated.Convenience method to add a servlet.- Parameters:
className
- the servlet class namepathSpec
- the path spec to map servlet to- Returns:
- the ServletHolder for the added servlet
-
addServlet
public ServletHolder addServlet(java.lang.Class<? extends Servlet> servlet, java.lang.String pathSpec)
Deprecated.Convenience method to add a servlet.- Parameters:
servlet
- the servlet classpathSpec
- the path spec to map servlet to- Returns:
- the ServletHolder for the added servlet
-
addServlet
public void addServlet(ServletHolder servlet, java.lang.String pathSpec)
Deprecated.Convenience method to add a servlet.- Parameters:
servlet
- the servlet holderpathSpec
- the path spec
-
addFilter
public void addFilter(FilterHolder holder, java.lang.String pathSpec, java.util.EnumSet<DispatcherType> dispatches)
Deprecated.Convenience method to add a filter- Parameters:
holder
- the filter holderpathSpec
- the path specdispatches
- the dispatcher types for this filter
-
addFilter
public FilterHolder addFilter(java.lang.Class<? extends Filter> filterClass, java.lang.String pathSpec, java.util.EnumSet<DispatcherType> dispatches)
Deprecated.Convenience method to add a filter- Parameters:
filterClass
- the filter classpathSpec
- the path specdispatches
- the dispatcher types for this filter- Returns:
- the FilterHolder that was created
-
addFilter
public FilterHolder addFilter(java.lang.String filterClass, java.lang.String pathSpec, java.util.EnumSet<DispatcherType> dispatches)
Deprecated.Convenience method to add a filter- Parameters:
filterClass
- the filter class namepathSpec
- the path specdispatches
- the dispatcher types for this filter- Returns:
- the FilterHolder that was created
-
setServletSecurity
public java.util.Set<java.lang.String> setServletSecurity(ServletRegistration.Dynamic registration, ServletSecurityElement servletSecurityElement)
Deprecated.Delegate for ServletRegistration.Dynamic.setServletSecurity method- Parameters:
registration
- ServletRegistration.Dynamic instance that setServletSecurity was called onservletSecurityElement
- new security info- 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.
-
callContextInitialized
public void callContextInitialized(ServletContextListener l, ServletContextEvent e)
Deprecated.
-
callContextDestroyed
public void callContextDestroyed(ServletContextListener l, ServletContextEvent e)
Deprecated.
-
setSessionHandler
public void setSessionHandler(SessionHandler sessionHandler)
Deprecated.- Parameters:
sessionHandler
- The sessionHandler to set.
-
setSecurityHandler
public void setSecurityHandler(SecurityHandler securityHandler)
Deprecated.- Parameters:
securityHandler
- TheSecurityHandler
to set on this context.
-
setGzipHandler
public void setGzipHandler(GzipHandler gzipHandler)
Deprecated.- Parameters:
gzipHandler
- TheGzipHandler
to set on this context.
-
setServletHandler
public void setServletHandler(ServletHandler servletHandler)
Deprecated.- Parameters:
servletHandler
- The servletHandler to set.
-
insertHandler
public void insertHandler(HandlerWrapper handler)
Deprecated.Insert a HandlerWrapper before the first Session,Security or ServletHandler but after any other HandlerWrappers.- Overrides:
insertHandler
in classHandlerWrapper
- Parameters:
handler
- the wrapper to insert
-
getObjectFactory
public DecoratedObjectFactory getObjectFactory()
Deprecated.The DecoratedObjectFactory for use by IoC containers (weld / spring / etc)- Returns:
- The DecoratedObjectFactory
-
getDecorators
@Deprecated public java.util.List<ServletContextHandler.Decorator> getDecorators()
Deprecated.use theDecoratedObjectFactory
from getAttribute("org.eclipse.jetty.util.DecoratedObjectFactory") orgetObjectFactory()
instead- Returns:
- The decorator list used to resource inject new Filters, Servlets and EventListeners
-
setDecorators
@Deprecated public void setDecorators(java.util.List<ServletContextHandler.Decorator> decorators)
Deprecated.use theDecoratedObjectFactory
from getAttribute("org.eclipse.jetty.util.DecoratedObjectFactory") orgetObjectFactory()
instead- Parameters:
decorators
- The list ofServletContextHandler.Decorator
s
-
addDecorator
@Deprecated public void addDecorator(ServletContextHandler.Decorator decorator)
Deprecated.use theDecoratedObjectFactory
from getAttribute("org.eclipse.jetty.util.DecoratedObjectFactory") orgetObjectFactory()
instead- Parameters:
decorator
- The decorator to add
-
getServletContextHandler
public static ServletContextHandler getServletContextHandler(ServletContext context)
Deprecated.
-
-