org.eclipse.jetty.servlet
类 ServletContextHandler.Context

java.lang.Object
  org.eclipse.jetty.server.handler.ContextHandler.Context
      org.eclipse.jetty.servlet.ServletContextHandler.Context

所有已实现的接口：

ServletContext

直接已知子类：

WebAppContext.Context

包容类：

ServletContextHandler

public class ServletContextHandler.Context
extends ContextHandler.Context

字段摘要

从类 org.eclipse.jetty.server.handler.ContextHandler.Context 继承的字段

_enabled, _majorVersion, _minorVersion

从接口 javax.servlet.ServletContext 继承的字段

ORDERED_LIBS, TEMPDIR

构造方法摘要

ServletContextHandler.Context()

方法摘要

FilterRegistration.Dynamic	addFilter(String filterName, Class<? extends Filter> filterClass) Adds the filter with the given name and class type to this servlet context.
FilterRegistration.Dynamic	addFilter(String filterName, Filter filter) Registers the given filter instance with this ServletContext under the given filterName.
FilterRegistration.Dynamic	addFilter(String filterName, String className) Adds the filter with the given name and class name to this servlet context.
void	addListener(Class<? extends EventListener> listenerClass) Adds a listener of the given class type to this ServletContext.
void	addListener(String className) Adds the listener with the given class name to this ServletContext.
<T extends EventListener> void	addListener(T t) Adds the given listener to this ServletContext.
ServletRegistration.Dynamic	addServlet(String servletName, Class<? extends Servlet> servletClass) Adds the servlet with the given name and class type to this servlet context.
ServletRegistration.Dynamic	addServlet(String servletName, Servlet servlet) Registers the given servlet instance with this ServletContext under the given servletName.
ServletRegistration.Dynamic	addServlet(String servletName, String className) Adds the servlet with the given name and class name to this servlet context.
<T extends Filter> T	createFilter(Class<T> c) Instantiates the given Filter class.
<T extends EventListener> T	createListener(Class<T> clazz) Instantiates the given EventListener class.
<T extends Servlet> T	createServlet(Class<T> c) Instantiates the given Servlet class.
void	declareRoles(String... roleNames) Declares role names that are tested using isUserInRole.
Set<SessionTrackingMode>	getDefaultSessionTrackingModes() Gets the session tracking modes that are supported by default for this ServletContext.
Set<SessionTrackingMode>	getEffectiveSessionTrackingModes() Gets the session tracking modes that are in effect for this ServletContext.
FilterRegistration	getFilterRegistration(String filterName) Gets the FilterRegistration corresponding to the filter with the given filterName.
Map<String,? extends FilterRegistration>	getFilterRegistrations() Gets a (possibly empty) Map of the FilterRegistration objects (keyed by filter name) corresponding to all filters registered with this ServletContext.
JspConfigDescriptor	getJspConfigDescriptor() Gets the <jsp-config> related configuration that was aggregated from the web.xml and web-fragment.xml descriptor files of the web application represented by this ServletContext.
RequestDispatcher	getNamedDispatcher(String name) Returns a RequestDispatcher object that acts as a wrapper for the named servlet.
ServletRegistration	getServletRegistration(String servletName) Gets the ServletRegistration corresponding to the servlet with the given servletName.
Map<String,? extends ServletRegistration>	getServletRegistrations() Gets a (possibly empty) Map of the ServletRegistration objects (keyed by servlet name) corresponding to all servlets registered with this ServletContext.
SessionCookieConfig	getSessionCookieConfig() Gets the SessionCookieConfig object through which various properties of the session tracking cookies created on behalf of this ServletContext may be configured.
boolean	setInitParameter(String name, String value) Sets the context initialization parameter with the given name and value on this ServletContext.
void	setJspConfigDescriptor(JspConfigDescriptor d)
void	setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes) Sets the session tracking modes that are to become effective for this ServletContext.

从类 org.eclipse.jetty.server.handler.ContextHandler.Context 继承的方法

getAttribute, getAttributeNames, getClassLoader, getContext, getContextHandler, getContextPath, getEffectiveMajorVersion, getEffectiveMinorVersion, getInitParameter, getInitParameterNames, getMajorVersion, getMimeType, getMinorVersion, getRealPath, getRequestDispatcher, getResource, getResourceAsStream, getResourcePaths, getServerInfo, getServlet, getServletContextName, getServletNames, getServlets, isEnabled, log, log, log, removeAttribute, setAttribute, setEffectiveMajorVersion, setEffectiveMinorVersion, setEnabled, toString

从类 java.lang.Object 继承的方法

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造方法详细信息

ServletContextHandler.Context

public ServletContextHandler.Context()

方法详细信息

getNamedDispatcher

public RequestDispatcher getNamedDispatcher(String name)

从接口 ServletContext 复制的描述

Returns a RequestDispatcher object that acts as a wrapper for the named servlet.

Servlets (and JSP pages also) may be given names via server administration or via a web application deployment descriptor. A servlet instance can determine its name using ServletConfig.getServletName().

This method returns null if the ServletContext cannot return a RequestDispatcher for any reason.

指定者：

接口 ServletContext 中的 getNamedDispatcher

覆盖：

类 ContextHandler.Context 中的 getNamedDispatcher

参数：

name - a String specifying the name of a servlet to wrap

返回：

a RequestDispatcher object that acts as a wrapper for the named servlet, or null if the ServletContext cannot return a RequestDispatcher

另请参见：

RequestDispatcher, ServletContext.getContext(java.lang.String), ServletConfig.getServletName()

addFilter

public FilterRegistration.Dynamic addFilter(String filterName,
                                            Class<? extends Filter> filterClass)

从接口 ServletContext 复制的描述

Adds the filter with the given name and class type to this servlet context.

The registered filter may be further configured via the returned FilterRegistration object.

If this ServletContext already contains a preliminary FilterRegistration for a filter with the given filterName, it will be completed (by assigning the name of the given filterClass to it) and returned.

This method supports resource injection if the given filterClass represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.

指定者：

接口 ServletContext 中的 addFilter

覆盖：

类 ContextHandler.Context 中的 addFilter

参数：

filterName - the name of the filter

filterClass - the class object from which the filter will be instantiated

返回：

a FilterRegistration object that may be used to further configure the registered filter, or null if this ServletContext already contains a complete FilterRegistration for a filter with the given filterName

从以下版本开始：

servlet-api-3.0

addFilter

public FilterRegistration.Dynamic addFilter(String filterName,
                                            String className)

从接口 ServletContext 复制的描述

Adds the filter with the given name and class name to this servlet context.

The registered filter may be further configured via the returned FilterRegistration object.

The specified className will be loaded using the classloader associated with the application represented by this ServletContext.

If this ServletContext already contains a preliminary FilterRegistration for a filter with the given filterName, it will be completed (by assigning the given className to it) and returned.

This method supports resource injection if the class with the given className represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.

指定者：

接口 ServletContext 中的 addFilter

覆盖：

类 ContextHandler.Context 中的 addFilter

参数：

filterName - the name of the filter

className - the fully qualified class name of the filter

返回：

a FilterRegistration object that may be used to further configure the registered filter, or null if this ServletContext already contains a complete FilterRegistration for a filter with the given filterName

从以下版本开始：

servlet-api-3.0

addFilter

public FilterRegistration.Dynamic addFilter(String filterName,
                                            Filter filter)

从接口 ServletContext 复制的描述

Registers the given filter instance with this ServletContext under the given filterName.

The registered filter may be further configured via the returned FilterRegistration object.

If this ServletContext already contains a preliminary FilterRegistration for a filter with the given filterName, it will be completed (by assigning the class name of the given filter instance to it) and returned.

指定者：

接口 ServletContext 中的 addFilter

覆盖：

类 ContextHandler.Context 中的 addFilter

参数：

filterName - the name of the filter

filter - the filter instance to register

返回：

a FilterRegistration object that may be used to further configure the given filter, or null if this ServletContext already contains a complete FilterRegistration for a filter with the given filterName or if the same filter instance has already been registered with this or another ServletContext in the same container

从以下版本开始：

servlet-api-3.0

addServlet

public ServletRegistration.Dynamic addServlet(String servletName,
                                              Class<? extends Servlet> servletClass)

从接口 ServletContext 复制的描述

Adds the servlet with the given name and class type to this servlet context.

The registered servlet may be further configured via the returned ServletRegistration object.

If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the name of the given servletClass to it) and returned.

This method introspects the given servletClass for the ServletSecurity, MultipartConfig, javax.annotation.security.RunAs, and javax.annotation.security.DeclareRoles annotations. In addition, this method supports resource injection if the given servletClass represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.

指定者：

接口 ServletContext 中的 addServlet

覆盖：

类 ContextHandler.Context 中的 addServlet

参数：

servletName - the name of the servlet

servletClass - the class object from which the servlet will be instantiated

返回：

a ServletRegistration object that may be used to further configure the registered servlet, or null if this ServletContext already contains a complete ServletRegistration for the given servletName

从以下版本开始：

servlet-api-3.0

addServlet

public ServletRegistration.Dynamic addServlet(String servletName,
                                              String className)

从接口 ServletContext 复制的描述

Adds the servlet with the given name and class name to this servlet context.

The registered servlet may be further configured via the returned ServletRegistration object.

The specified className will be loaded using the classloader associated with the application represented by this ServletContext.

If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the given className to it) and returned.

This method introspects the class with the given className for the ServletSecurity, MultipartConfig, javax.annotation.security.RunAs, and javax.annotation.security.DeclareRoles annotations. In addition, this method supports resource injection if the class with the given className represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.

指定者：

接口 ServletContext 中的 addServlet

覆盖：

类 ContextHandler.Context 中的 addServlet

参数：

servletName - the name of the servlet

className - the fully qualified class name of the servlet

返回：

a ServletRegistration object that may be used to further configure the registered servlet, or null if this ServletContext already contains a complete ServletRegistration for a servlet with the given servletName

从以下版本开始：

servlet-api-3.0

addServlet

public ServletRegistration.Dynamic addServlet(String servletName,
                                              Servlet servlet)

从接口 ServletContext 复制的描述

Registers the given servlet instance with this ServletContext under the given servletName.

The registered servlet may be further configured via the returned ServletRegistration object.

If this ServletContext already contains a preliminary ServletRegistration for a servlet with the given servletName, it will be completed (by assigning the class name of the given servlet instance to it) and returned.

指定者：

接口 ServletContext 中的 addServlet

覆盖：

类 ContextHandler.Context 中的 addServlet

参数：

servletName - the name of the servlet

servlet - the servlet instance to register

返回：

a ServletRegistration object that may be used to further configure the given servlet, or null if this ServletContext already contains a complete ServletRegistration for a servlet with the given servletName or if the same servlet instance has already been registered with this or another ServletContext in the same container

从以下版本开始：

servlet-api-3.0

setInitParameter

public boolean setInitParameter(String name,
                                String value)

从接口 ServletContext 复制的描述

Sets the context initialization parameter with the given name and value on this ServletContext.

指定者：

接口 ServletContext 中的 setInitParameter

覆盖：

类 ContextHandler.Context 中的 setInitParameter

参数：

name - the name of the context initialization parameter to set

value - the value of the context initialization parameter to set

返回：

true if the context initialization parameter with the given name and value was set successfully on this ServletContext, and false if it was not set because this ServletContext already contains a context initialization parameter with a matching name

createFilter

public <T extends Filter> T createFilter(Class<T> c)
                              throws ServletException

从接口 ServletContext 复制的描述

Instantiates the given Filter class.

The returned Filter instance may be further customized before it is registered with this ServletContext via a call to ServletContext.addFilter(String,Filter).

The given Filter class must define a zero argument constructor, which is used to instantiate it.

This method supports resource injection if the given clazz represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.

指定者：

接口 ServletContext 中的 createFilter

覆盖：

类 ContextHandler.Context 中的 createFilter

参数：

c - the Filter class to instantiate

返回：

the new Filter instance

抛出：

ServletException - if the given clazz fails to be instantiated

createServlet

public <T extends Servlet> T createServlet(Class<T> c)
                                throws ServletException

从接口 ServletContext 复制的描述

Instantiates the given Servlet class.

The returned Servlet instance may be further customized before it is registered with this ServletContext via a call to ServletContext.addServlet(String,Servlet).

The given Servlet class must define a zero argument constructor, which is used to instantiate it.

This method introspects the given clazz for the following annotations: ServletSecurity, MultipartConfig, javax.annotation.security.RunAs, and javax.annotation.security.DeclareRoles. In addition, this method supports resource injection if the given clazz represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.

指定者：

接口 ServletContext 中的 createServlet

覆盖：

类 ContextHandler.Context 中的 createServlet

参数：

c - the Servlet class to instantiate

返回：

the new Servlet instance

抛出：

ServletException - if the given clazz fails to be instantiated

getDefaultSessionTrackingModes

public Set<SessionTrackingMode> getDefaultSessionTrackingModes()

从接口 ServletContext 复制的描述

Gets the session tracking modes that are supported by default for this ServletContext.

指定者：

接口 ServletContext 中的 getDefaultSessionTrackingModes

覆盖：

类 ContextHandler.Context 中的 getDefaultSessionTrackingModes

返回：

set of the session tracking modes supported by default for this ServletContext

getEffectiveSessionTrackingModes

public Set<SessionTrackingMode> getEffectiveSessionTrackingModes()

从接口 ServletContext 复制的描述

Gets the session tracking modes that are in effect for this ServletContext.

The session tracking modes in effect are those provided to setSessionTrackingModes.

By default, the session tracking modes returned by getDefaultSessionTrackingModes are in effect.

指定者：

接口 ServletContext 中的 getEffectiveSessionTrackingModes

覆盖：

类 ContextHandler.Context 中的 getEffectiveSessionTrackingModes

返回：

set of the session tracking modes in effect for this ServletContext

getFilterRegistration

public FilterRegistration getFilterRegistration(String filterName)

从接口 ServletContext 复制的描述

Gets the FilterRegistration corresponding to the filter with the given filterName.

指定者：

接口 ServletContext 中的 getFilterRegistration

覆盖：

类 ContextHandler.Context 中的 getFilterRegistration

返回：

the (complete or preliminary) FilterRegistration for the filter with the given filterName, or null if no FilterRegistration exists under that name

getFilterRegistrations

public Map<String,? extends FilterRegistration> getFilterRegistrations()

从接口 ServletContext 复制的描述

Gets a (possibly empty) Map of the FilterRegistration objects (keyed by filter name) corresponding to all filters registered with this ServletContext.

The returned Map includes the FilterRegistration objects corresponding to all declared and annotated filters, as well as the FilterRegistration objects corresponding to all filters that have been added via one of the addFilter methods.

Any changes to the returned Map must not affect this ServletContext.

指定者：

接口 ServletContext 中的 getFilterRegistrations

覆盖：

类 ContextHandler.Context 中的 getFilterRegistrations

返回：

Map of the (complete and preliminary) FilterRegistration objects corresponding to all filters currently registered with this ServletContext

getServletRegistration

public ServletRegistration getServletRegistration(String servletName)

从接口 ServletContext 复制的描述

Gets the ServletRegistration corresponding to the servlet with the given servletName.

指定者：

接口 ServletContext 中的 getServletRegistration

覆盖：

类 ContextHandler.Context 中的 getServletRegistration

返回：

the (complete or preliminary) ServletRegistration for the servlet with the given servletName, or null if no ServletRegistration exists under that name

getServletRegistrations

public Map<String,? extends ServletRegistration> getServletRegistrations()

从接口 ServletContext 复制的描述

Gets a (possibly empty) Map of the ServletRegistration objects (keyed by servlet name) corresponding to all servlets registered with this ServletContext.

The returned Map includes the ServletRegistration objects corresponding to all declared and annotated servlets, as well as the ServletRegistration objects corresponding to all servlets that have been added via one of the addServlet methods.

If permitted, any changes to the returned Map must not affect this ServletContext.

指定者：

接口 ServletContext 中的 getServletRegistrations

覆盖：

类 ContextHandler.Context 中的 getServletRegistrations

返回：

Map of the (complete and preliminary) ServletRegistration objects corresponding to all servlets currently registered with this ServletContext

getSessionCookieConfig

public SessionCookieConfig getSessionCookieConfig()

从接口 ServletContext 复制的描述

Gets the SessionCookieConfig object through which various properties of the session tracking cookies created on behalf of this ServletContext may be configured.

Repeated invocations of this method will return the same SessionCookieConfig instance.

指定者：

接口 ServletContext 中的 getSessionCookieConfig

覆盖：

类 ContextHandler.Context 中的 getSessionCookieConfig

返回：

the SessionCookieConfig object through which various properties of the session tracking cookies created on behalf of this ServletContext may be configured

setSessionTrackingModes

public void setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)

从接口 ServletContext 复制的描述

Sets the session tracking modes that are to become effective for this ServletContext.

The given sessionTrackingModes replaces any session tracking modes set by a previous invocation of this method on this ServletContext.

指定者：

接口 ServletContext 中的 setSessionTrackingModes

覆盖：

类 ContextHandler.Context 中的 setSessionTrackingModes

参数：

sessionTrackingModes - the set of session tracking modes to become effective for this ServletContext

addListener

public void addListener(String className)

从接口 ServletContext 复制的描述

Adds the listener with the given class name to this ServletContext.

The class with the given name will be loaded using the classloader associated with the application represented by this ServletContext, and must implement one or more of the following interfaces:

• ServletContextAttributeListener
• ServletRequestListener
• ServletRequestAttributeListener
• HttpSessionListener
• HttpSessionAttributeListener

If this ServletContext was passed to ServletContainerInitializer.onStartup(java.util.Set>, javax.servlet.ServletContext), then the class with the given name may also implement ServletContextListener, in addition to the interfaces listed above.

As part of this method call, the container must load the class with the specified class name to ensure that it implements one of the required interfaces.

If the class with the given name implements a listener interface whose invocation order corresponds to the declaration order (i.e., if it implements ServletRequestListener, ServletContextListener, or HttpSessionListener), then the new listener will be added to the end of the ordered list of listeners of that interface.

This method supports resource injection if the class with the given className represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.

指定者：

接口 ServletContext 中的 addListener

覆盖：

类 ContextHandler.Context 中的 addListener

参数：

className - the fully qualified class name of the listener

addListener

public <T extends EventListener> void addListener(T t)

从接口 ServletContext 复制的描述

Adds the given listener to this ServletContext.

The given listener must be an instance of one or more of the following interfaces:

• ServletContextAttributeListener
• ServletRequestListener
• ServletRequestAttributeListener
• HttpSessionListener
• HttpSessionAttributeListener

If this ServletContext was passed to ServletContainerInitializer.onStartup(java.util.Set>, javax.servlet.ServletContext), then the given listener may also be an instance of ServletContextListener, in addition to the interfaces listed above.

If the given listener is an instance of a listener interface whose invocation order corresponds to the declaration order (i.e., if it is an instance of ServletRequestListener, ServletContextListener, or HttpSessionListener), then the listener will be added to the end of the ordered list of listeners of that interface.

指定者：

接口 ServletContext 中的 addListener

覆盖：

类 ContextHandler.Context 中的 addListener

参数：

t - the listener to be added

addListener

public void addListener(Class<? extends EventListener> listenerClass)

从接口 ServletContext 复制的描述

Adds a listener of the given class type to this ServletContext.

The given listenerClass must implement one or more of the following interfaces:

• ServletContextAttributeListener
• ServletRequestListener
• ServletRequestAttributeListener
• HttpSessionListener
• HttpSessionAttributeListener

If this ServletContext was passed to ServletContainerInitializer.onStartup(java.util.Set>, javax.servlet.ServletContext), then the given listenerClass may also implement ServletContextListener, in addition to the interfaces listed above.

If the given listenerClass implements a listener interface whose invocation order corresponds to the declaration order (i.e., if it implements ServletRequestListener, ServletContextListener, or HttpSessionListener), then the new listener will be added to the end of the ordered list of listeners of that interface.

This method supports resource injection if the given listenerClass represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.

指定者：

接口 ServletContext 中的 addListener

覆盖：

类 ContextHandler.Context 中的 addListener

参数：

listenerClass - the listener class to be instantiated

createListener

public <T extends EventListener> T createListener(Class<T> clazz)
                                       throws ServletException

从接口 ServletContext 复制的描述

Instantiates the given EventListener class.

The specified EventListener class must implement at least one of the ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener, HttpSessionListener, or HttpSessionAttributeListener interfaces.

The returned EventListener instance may be further customized before it is registered with this ServletContext via a call to ServletContext.addListener(EventListener).

The given EventListener class must define a zero argument constructor, which is used to instantiate it.

This method supports resource injection if the given clazz represents a Managed Bean. See the Java EE platform and JSR 299 specifications for additional details about Managed Beans and resource injection.

指定者：

接口 ServletContext 中的 createListener

覆盖：

类 ContextHandler.Context 中的 createListener

参数：

clazz - the EventListener class to instantiate

返回：

the new EventListener instance

抛出：

ServletException - if the given clazz fails to be instantiated

getJspConfigDescriptor

public JspConfigDescriptor getJspConfigDescriptor()

从接口 ServletContext 复制的描述

Gets the <jsp-config> related configuration that was aggregated from the web.xml and web-fragment.xml descriptor files of the web application represented by this ServletContext.

指定者：

接口 ServletContext 中的 getJspConfigDescriptor

覆盖：

类 ContextHandler.Context 中的 getJspConfigDescriptor

返回：

the <jsp-config> related configuration that was aggregated from the web.xml and web-fragment.xml descriptor files of the web application represented by this ServletContext, or null if no such configuration exists

另请参见：

JspConfigDescriptor

setJspConfigDescriptor

public void setJspConfigDescriptor(JspConfigDescriptor d)

覆盖：

类 ContextHandler.Context 中的 setJspConfigDescriptor

declareRoles

public void declareRoles(String... roleNames)

从接口 ServletContext 复制的描述

Declares role names that are tested using isUserInRole.

Roles that are implicitly declared as a result of their use within the setServletSecurity or setRunAsRole methods of the ServletRegistration interface need not be declared.

指定者：

接口 ServletContext 中的 declareRoles

覆盖：

类 ContextHandler.Context 中的 declareRoles

参数：

roleNames - the role names being declared