org.eclipse.jetty.servlet
Class ServletContextHandler
java.lang.Object
org.eclipse.jetty.util.component.AbstractLifeCycle
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.server.handler.ContextHandler
org.eclipse.jetty.servlet.ServletContextHandler
- All Implemented Interfaces:
- Handler, HandlerContainer, Server.Graceful, Attributes, LifeCycle
- Direct Known Subclasses:
- WebAppContext
public class ServletContextHandler
- extends ContextHandler
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
.
Constructor Summary |
ServletContextHandler()
|
ServletContextHandler(HandlerContainer parent,
SessionHandler sessionHandler,
SecurityHandler securityHandler,
ServletHandler servletHandler,
ErrorHandler errorHandler)
|
ServletContextHandler(HandlerContainer parent,
String contextPath)
|
ServletContextHandler(HandlerContainer parent,
String contextPath,
boolean sessions,
boolean security)
|
ServletContextHandler(HandlerContainer parent,
String contextPath,
int options)
|
ServletContextHandler(HandlerContainer parent,
String contextPath,
SessionHandler sessionHandler,
SecurityHandler securityHandler,
ServletHandler servletHandler,
ErrorHandler errorHandler)
|
ServletContextHandler(int options)
|
Method Summary |
FilterHolder |
addFilter(Class<? extends Filter> filterClass,
String pathSpec,
EnumSet<DispatcherType> dispatches)
convenience method to add a filter |
void |
addFilter(FilterHolder holder,
String pathSpec,
EnumSet<DispatcherType> dispatches)
conveniance method to add a filter |
FilterHolder |
addFilter(String filterClass,
String pathSpec,
EnumSet<DispatcherType> dispatches)
convenience method to add a filter |
ServletHolder |
addServlet(Class<? extends Servlet> servlet,
String pathSpec)
conveniance method to add a servlet. |
void |
addServlet(ServletHolder servlet,
String pathSpec)
conveniance method to add a servlet. |
ServletHolder |
addServlet(String className,
String pathSpec)
conveniance method to add a servlet. |
void |
callContextDestroyed(ServletContextListener l,
ServletContextEvent e)
|
void |
callContextInitialized(ServletContextListener l,
ServletContextEvent e)
|
protected void |
doStart()
|
protected void |
doStop()
|
ServletContextHandler.Decorator |
getDecorator()
|
Class<? extends SecurityHandler> |
getDefaultSecurityHandlerClass()
Get the defaultSecurityHandlerClass. |
SecurityHandler |
getSecurityHandler()
|
ServletHandler |
getServletHandler()
|
SessionHandler |
getSessionHandler()
|
boolean |
isCreatedInstance(Object instance)
Check if instance was created by a call to ServletContext.createFilter(Class) ,
ServletContext.createServlet(Class) or ServletContext.createListener(Class) |
protected SecurityHandler |
newSecurityHandler()
|
protected ServletHandler |
newServletHandler()
|
protected SessionHandler |
newSessionHandler()
|
void |
restrictEventListener(EventListener e)
Apply any necessary restrictions on a programmatically added
listener. |
void |
setDecorator(ServletContextHandler.Decorator decorator)
|
void |
setDefaultSecurityHandlerClass(Class<? extends SecurityHandler> defaultSecurityHandlerClass)
Set the defaultSecurityHandlerClass. |
void |
setSecurityHandler(SecurityHandler securityHandler)
|
void |
setServletHandler(ServletHandler servletHandler)
|
void |
setSessionHandler(SessionHandler sessionHandler)
|
protected void |
startContext()
Finish constructing handlers and link them together. |
Methods inherited from class org.eclipse.jetty.server.handler.ContextHandler |
addEventListener, addLocaleEncoding, checkContext, checkManagedAttribute, clearAttributes, doHandle, doScope, getAllowNullPathInfo, getAttribute, getAttributeNames, getAttributes, getBaseResource, getClassLoader, getClassPath, getConnectorNames, getContextPath, getCurrentContext, getDisplayName, getErrorHandler, getEventListeners, getHosts, getInitParameter, getInitParameterNames, getInitParams, getLocaleEncoding, getLocaleEncoding, getLogger, getMaxFormContentSize, getMimeTypes, getResource, getResourceBase, getResourcePaths, getServletContext, getVirtualHosts, getWelcomeFiles, handle, isAliases, isAvailable, isCompactPath, isProtectedTarget, isShutdown, loadClass, newResource, newResource, removeAttribute, setAliases, setAllowNullPathInfo, setAttribute, setAttributes, setAvailable, setBaseResource, setClassLoader, setCompactPath, setConnectorNames, setContextPath, setDisplayName, setErrorHandler, setEventListeners, setHosts, setLogger, setManagedAttribute, setMaxFormContentSize, setMimeTypes, setResourceBase, setServer, setShutdown, setVirtualHosts, setWelcomeFiles, toString |
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle |
addLifeCycleListener, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop |
SESSIONS
public static final int SESSIONS
- See Also:
- Constant Field Values
SECURITY
public static final int SECURITY
- See Also:
- Constant Field Values
NO_SESSIONS
public static final int NO_SESSIONS
- See Also:
- Constant Field Values
NO_SECURITY
public static final int NO_SECURITY
- See Also:
- Constant Field Values
_defaultSecurityHandlerClass
protected Class<? extends SecurityHandler> _defaultSecurityHandlerClass
_sessionHandler
protected SessionHandler _sessionHandler
_securityHandler
protected SecurityHandler _securityHandler
_servletHandler
protected ServletHandler _servletHandler
_options
protected int _options
_decorator
protected ServletContextHandler.Decorator _decorator
_jspConfig
protected JspConfigDescriptor _jspConfig
_restrictedContextListeners
protected Object _restrictedContextListeners
_created
protected final Set<Object> _created
ServletContextHandler
public ServletContextHandler()
ServletContextHandler
public ServletContextHandler(int options)
ServletContextHandler
public ServletContextHandler(HandlerContainer parent,
String contextPath)
ServletContextHandler
public ServletContextHandler(HandlerContainer parent,
String contextPath,
int options)
ServletContextHandler
public ServletContextHandler(HandlerContainer parent,
String contextPath,
boolean sessions,
boolean security)
ServletContextHandler
public ServletContextHandler(HandlerContainer parent,
SessionHandler sessionHandler,
SecurityHandler securityHandler,
ServletHandler servletHandler,
ErrorHandler errorHandler)
ServletContextHandler
public ServletContextHandler(HandlerContainer parent,
String contextPath,
SessionHandler sessionHandler,
SecurityHandler securityHandler,
ServletHandler servletHandler,
ErrorHandler errorHandler)
doStart
protected void doStart()
throws Exception
- Overrides:
doStart
in class ContextHandler
- Throws:
Exception
- See Also:
ContextHandler.doStart()
doStop
protected void doStop()
throws Exception
- Overrides:
doStop
in class ContextHandler
- Throws:
Exception
- See Also:
ContextHandler.doStop()
isCreatedInstance
public boolean isCreatedInstance(Object instance)
- Check if instance was created by a call to
ServletContext.createFilter(Class)
,
ServletContext.createServlet(Class)
or ServletContext.createListener(Class)
- Parameters:
instance
- Instance of Servlet
, Filter
or EventListener
- Returns:
- True if the instance was created by a call to
ServletContext.createFilter(Class)
,
ServletContext.createServlet(Class)
or ServletContext.createListener(Class)
getDefaultSecurityHandlerClass
public Class<? extends SecurityHandler> getDefaultSecurityHandlerClass()
- Get the defaultSecurityHandlerClass.
- Returns:
- the defaultSecurityHandlerClass
setDefaultSecurityHandlerClass
public void setDefaultSecurityHandlerClass(Class<? extends SecurityHandler> defaultSecurityHandlerClass)
- Set the defaultSecurityHandlerClass.
- Parameters:
defaultSecurityHandlerClass
- the defaultSecurityHandlerClass to set
newSessionHandler
protected SessionHandler newSessionHandler()
newSecurityHandler
protected SecurityHandler newSecurityHandler()
newServletHandler
protected ServletHandler newServletHandler()
startContext
protected void startContext()
throws Exception
- Finish constructing handlers and link them together.
- Overrides:
startContext
in class ContextHandler
- Throws:
Exception
- See Also:
ContextHandler.startContext()
getSecurityHandler
public SecurityHandler getSecurityHandler()
- Returns:
- Returns the securityHandler.
getServletHandler
public ServletHandler getServletHandler()
- Returns:
- Returns the servletHandler.
getSessionHandler
public SessionHandler getSessionHandler()
- Returns:
- Returns the sessionHandler.
addServlet
public ServletHolder addServlet(String className,
String pathSpec)
- conveniance method to add a servlet.
addServlet
public ServletHolder addServlet(Class<? extends Servlet> servlet,
String pathSpec)
- conveniance method to add a servlet.
addServlet
public void addServlet(ServletHolder servlet,
String pathSpec)
- conveniance method to add a servlet.
addFilter
public void addFilter(FilterHolder holder,
String pathSpec,
EnumSet<DispatcherType> dispatches)
- conveniance method to add a filter
addFilter
public FilterHolder addFilter(Class<? extends Filter> filterClass,
String pathSpec,
EnumSet<DispatcherType> dispatches)
- convenience method to add a filter
addFilter
public FilterHolder addFilter(String filterClass,
String pathSpec,
EnumSet<DispatcherType> dispatches)
- convenience method to add a filter
restrictEventListener
public void restrictEventListener(EventListener e)
- Description copied from class:
ContextHandler
- Apply any necessary restrictions on a programmatically added
listener.
Superclasses should implement.
- Overrides:
restrictEventListener
in class ContextHandler
callContextInitialized
public void callContextInitialized(ServletContextListener l,
ServletContextEvent e)
- Overrides:
callContextInitialized
in class ContextHandler
callContextDestroyed
public void callContextDestroyed(ServletContextListener l,
ServletContextEvent e)
- Overrides:
callContextDestroyed
in class ContextHandler
setSessionHandler
public void setSessionHandler(SessionHandler sessionHandler)
- Parameters:
sessionHandler
- The sessionHandler to set.
setSecurityHandler
public void setSecurityHandler(SecurityHandler securityHandler)
- Parameters:
securityHandler
- The SecurityHandler
to set on this context.
setServletHandler
public void setServletHandler(ServletHandler servletHandler)
- Parameters:
servletHandler
- The servletHandler to set.
getDecorator
public ServletContextHandler.Decorator getDecorator()
- Returns:
- The decorator used to resource inject new Filters, Servlets and EventListeners
setDecorator
public void setDecorator(ServletContextHandler.Decorator decorator)
- Parameters:
decorator
- The inject used to resource inject new Filters, Servlets and EventListeners
Copyright © 1995-2010 Mort Bay Consulting. All Rights Reserved.