|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.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
public class ServletContextHandler
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 | |
---|---|
class |
ServletContextHandler.Context
|
static interface |
ServletContextHandler.Decorator
Interface to decorate loaded classes. |
Nested classes/interfaces inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle |
---|
AbstractLifeCycle.AbstractLifeCycleListener |
Nested classes/interfaces inherited from interface org.eclipse.jetty.util.component.LifeCycle |
---|
LifeCycle.Listener |
Field Summary | |
---|---|
protected java.util.List<ServletContextHandler.Decorator> |
_decorators
|
protected java.lang.Class<? extends SecurityHandler> |
_defaultSecurityHandlerClass
|
protected javax.servlet.descriptor.JspConfigDescriptor |
_jspConfig
|
protected int |
_options
|
protected java.lang.Object |
_restrictedContextListeners
|
protected SecurityHandler |
_securityHandler
|
protected ServletHandler |
_servletHandler
|
protected SessionHandler |
_sessionHandler
|
static int |
NO_SECURITY
|
static int |
NO_SESSIONS
|
static int |
SECURITY
|
static int |
SESSIONS
|
Fields inherited from class org.eclipse.jetty.server.handler.ContextHandler |
---|
_scontext, MANAGED_ATTRIBUTES |
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 |
---|
_listeners, FAILED, RUNNING, STARTED, STARTING, STOPPED, STOPPING |
Constructor Summary | |
---|---|
ServletContextHandler()
|
|
ServletContextHandler(HandlerContainer parent,
SessionHandler sessionHandler,
SecurityHandler securityHandler,
ServletHandler servletHandler,
ErrorHandler errorHandler)
|
|
ServletContextHandler(HandlerContainer parent,
java.lang.String contextPath)
|
|
ServletContextHandler(HandlerContainer parent,
java.lang.String contextPath,
boolean sessions,
boolean security)
|
|
ServletContextHandler(HandlerContainer parent,
java.lang.String contextPath,
int options)
|
|
ServletContextHandler(HandlerContainer parent,
java.lang.String contextPath,
SessionHandler sessionHandler,
SecurityHandler securityHandler,
ServletHandler servletHandler,
ErrorHandler errorHandler)
|
|
ServletContextHandler(int options)
|
Method Summary | |
---|---|
void |
addDecorator(ServletContextHandler.Decorator decorator)
|
FilterHolder |
addFilter(java.lang.Class<? extends javax.servlet.Filter> filterClass,
java.lang.String pathSpec,
java.util.EnumSet<javax.servlet.DispatcherType> dispatches)
convenience method to add a filter |
void |
addFilter(FilterHolder holder,
java.lang.String pathSpec,
java.util.EnumSet<javax.servlet.DispatcherType> dispatches)
conveniance method to add a filter |
FilterHolder |
addFilter(java.lang.String filterClass,
java.lang.String pathSpec,
java.util.EnumSet<javax.servlet.DispatcherType> dispatches)
convenience method to add a filter |
protected void |
addRoles(java.lang.String... roleNames)
delegate for ServletContext.declareRole method |
ServletHolder |
addServlet(java.lang.Class<? extends javax.servlet.Servlet> servlet,
java.lang.String pathSpec)
conveniance method to add a servlet. |
void |
addServlet(ServletHolder servlet,
java.lang.String pathSpec)
conveniance method to add a servlet. |
ServletHolder |
addServlet(java.lang.String className,
java.lang.String pathSpec)
conveniance method to add a servlet. |
void |
callContextDestroyed(javax.servlet.ServletContextListener l,
javax.servlet.ServletContextEvent e)
|
void |
callContextInitialized(javax.servlet.ServletContextListener l,
javax.servlet.ServletContextEvent e)
|
protected void |
doStop()
|
protected javax.servlet.ServletRegistration.Dynamic |
dynamicHolderAdded(ServletHolder holder)
notification that a ServletRegistration has been created so we can track the annotations |
java.util.List<ServletContextHandler.Decorator> |
getDecorators()
|
java.lang.Class<? extends SecurityHandler> |
getDefaultSecurityHandlerClass()
Get the defaultSecurityHandlerClass. |
SecurityHandler |
getSecurityHandler()
|
ServletHandler |
getServletHandler()
|
SessionHandler |
getSessionHandler()
|
boolean |
isRestrictListeners()
|
protected SecurityHandler |
newSecurityHandler()
|
protected ServletHandler |
newServletHandler()
|
protected SessionHandler |
newSessionHandler()
|
void |
restrictEventListener(java.util.EventListener e)
Apply any necessary restrictions on a programmatically added listener. |
void |
setDecorators(java.util.List<ServletContextHandler.Decorator> decorators)
|
void |
setDefaultSecurityHandlerClass(java.lang.Class<? extends SecurityHandler> defaultSecurityHandlerClass)
Set the defaultSecurityHandlerClass. |
void |
setRestrictListeners(boolean restrictListeners)
|
void |
setSecurityHandler(SecurityHandler securityHandler)
|
void |
setServletHandler(ServletHandler servletHandler)
|
java.util.Set<java.lang.String> |
setServletSecurity(javax.servlet.ServletRegistration.Dynamic registration,
javax.servlet.ServletSecurityElement servletSecurityElement)
Delegate for ServletRegistration.Dynamic.setServletSecurity method |
void |
setSessionHandler(SessionHandler sessionHandler)
|
protected void |
startContext()
Finish constructing handlers and link them together. |
Methods inherited from class org.eclipse.jetty.server.handler.ScopedHandler |
---|
handle, never, nextHandle, nextScope |
Methods inherited from class org.eclipse.jetty.server.handler.HandlerWrapper |
---|
expandChildren, getHandler, getHandlers, getNestedHandlerByClass, setHandler |
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandlerContainer |
---|
dumpHandlers, expandHandler, getChildHandlerByClass, getChildHandlers, getChildHandlersByClass |
Methods inherited from class org.eclipse.jetty.server.handler.AbstractHandler |
---|
destroy, dump, dump, getServer |
Methods inherited from class org.eclipse.jetty.util.component.AbstractLifeCycle |
---|
addLifeCycleListener, getState, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.eclipse.jetty.server.Handler |
---|
destroy, getServer, handle |
Methods inherited from interface org.eclipse.jetty.util.component.LifeCycle |
---|
addLifeCycleListener, isFailed, isRunning, isStarted, isStarting, isStopped, isStopping, removeLifeCycleListener, start, stop |
Field Detail |
---|
public static final int SESSIONS
public static final int SECURITY
public static final int NO_SESSIONS
public static final int NO_SECURITY
protected final java.util.List<ServletContextHandler.Decorator> _decorators
protected java.lang.Class<? extends SecurityHandler> _defaultSecurityHandlerClass
protected SessionHandler _sessionHandler
protected SecurityHandler _securityHandler
protected ServletHandler _servletHandler
protected int _options
protected javax.servlet.descriptor.JspConfigDescriptor _jspConfig
protected java.lang.Object _restrictedContextListeners
Constructor Detail |
---|
public ServletContextHandler()
public ServletContextHandler(int options)
public ServletContextHandler(HandlerContainer parent, java.lang.String contextPath)
public ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, int options)
public ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, boolean sessions, boolean security)
public ServletContextHandler(HandlerContainer parent, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler)
public ServletContextHandler(HandlerContainer parent, java.lang.String contextPath, SessionHandler sessionHandler, SecurityHandler securityHandler, ServletHandler servletHandler, ErrorHandler errorHandler)
Method Detail |
---|
protected void doStop() throws java.lang.Exception
doStop
in class ContextHandler
java.lang.Exception
ContextHandler.doStop()
public java.lang.Class<? extends SecurityHandler> getDefaultSecurityHandlerClass()
public void setDefaultSecurityHandlerClass(java.lang.Class<? extends SecurityHandler> defaultSecurityHandlerClass)
defaultSecurityHandlerClass
- the defaultSecurityHandlerClass to setprotected SessionHandler newSessionHandler()
protected SecurityHandler newSecurityHandler()
protected ServletHandler newServletHandler()
protected void startContext() throws java.lang.Exception
startContext
in class ContextHandler
java.lang.Exception
ContextHandler.startContext()
public SecurityHandler getSecurityHandler()
public ServletHandler getServletHandler()
public SessionHandler getSessionHandler()
public ServletHolder addServlet(java.lang.String className, java.lang.String pathSpec)
public ServletHolder addServlet(java.lang.Class<? extends javax.servlet.Servlet> servlet, java.lang.String pathSpec)
public void addServlet(ServletHolder servlet, java.lang.String pathSpec)
public void addFilter(FilterHolder holder, java.lang.String pathSpec, java.util.EnumSet<javax.servlet.DispatcherType> dispatches)
public FilterHolder addFilter(java.lang.Class<? extends javax.servlet.Filter> filterClass, java.lang.String pathSpec, java.util.EnumSet<javax.servlet.DispatcherType> dispatches)
public FilterHolder addFilter(java.lang.String filterClass, java.lang.String pathSpec, java.util.EnumSet<javax.servlet.DispatcherType> dispatches)
protected javax.servlet.ServletRegistration.Dynamic dynamicHolderAdded(ServletHolder holder)
holder
- new holder created through the api.
protected void addRoles(java.lang.String... roleNames)
roleNames
- role names to addpublic java.util.Set<java.lang.String> setServletSecurity(javax.servlet.ServletRegistration.Dynamic registration, javax.servlet.ServletSecurityElement servletSecurityElement)
registration
- ServletRegistration.Dynamic instance that setServletSecurity was called onservletSecurityElement
- new security info
public void restrictEventListener(java.util.EventListener e)
ContextHandler
restrictEventListener
in class ContextHandler
public boolean isRestrictListeners()
public void setRestrictListeners(boolean restrictListeners)
public void callContextInitialized(javax.servlet.ServletContextListener l, javax.servlet.ServletContextEvent e)
callContextInitialized
in class ContextHandler
public void callContextDestroyed(javax.servlet.ServletContextListener l, javax.servlet.ServletContextEvent e)
callContextDestroyed
in class ContextHandler
public void setSessionHandler(SessionHandler sessionHandler)
sessionHandler
- The sessionHandler to set.public void setSecurityHandler(SecurityHandler securityHandler)
securityHandler
- The SecurityHandler
to set on this context.public void setServletHandler(ServletHandler servletHandler)
servletHandler
- The servletHandler to set.public java.util.List<ServletContextHandler.Decorator> getDecorators()
public void setDecorators(java.util.List<ServletContextHandler.Decorator> decorators)
decorators
- The lis of ServletContextHandler.Decorator
spublic void addDecorator(ServletContextHandler.Decorator decorator)
decorator
- The decorator to add
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |