类 MockServletContext

构造器详细资料

• MockServletContext

  public MockServletContext()

  Create a new MockServletContext, using no base path and a DefaultResourceLoader (i.e. the classpath root as WAR root).

  另请参阅:

  DefaultResourceLoader

• MockServletContext

  public MockServletContext​(String resourceBasePath)

  Create a new MockServletContext, using a DefaultResourceLoader.

  参数:

  resourceBasePath - the root directory of the WAR (should not end with a slash)

  另请参阅:

  DefaultResourceLoader

• MockServletContext

  public MockServletContext​(@Nullable
                            ResourceLoader resourceLoader)

  Create a new MockServletContext, using the specified ResourceLoader and no base path.

  参数:

  resourceLoader - the ResourceLoader to use (or null for the default)

• MockServletContext

  public MockServletContext​(String resourceBasePath,
                            @Nullable
                            ResourceLoader resourceLoader)

  Create a new MockServletContext using the supplied resource base path and resource loader.

  Registers a MockRequestDispatcher for the Servlet named 'default'.

  参数:

  resourceBasePath - the root directory of the WAR (should not end with a slash)

  resourceLoader - the ResourceLoader to use (or null for the default)

  另请参阅:

  registerNamedDispatcher(java.lang.String, javax.servlet.RequestDispatcher)

方法详细资料

• getResourceLocation

  protected String getResourceLocation​(String path)

  Build a full resource location for the given path, prepending the resource base path of this MockServletContext.

  参数:

  path - the path as specified

  返回:

  the full resource path

• setContextPath

  public void setContextPath​(String contextPath)

• getContextPath

  public String getContextPath()

  从接口复制的说明: javax.servlet.ServletContext
  Returns the context path of the web application.

  The context path is the portion of the request URI that is used to select the context of the request. The context path always comes first in a request URI. If this context is the "root" context rooted at the base of the Web server's URL name space, this path will be an empty string. Otherwise, if the context is not rooted at the root of the server's name space, the path starts with a / character but does not end with a / character.

  It is possible that a servlet container may match a context by more than one context path. In such cases the HttpServletRequest.getContextPath() will return the actual context path used by the request and it may differ from the path returned by this method. The context path returned by this method should be considered as the prime or preferred context path of the application.

  指定者:

  getContextPath 在接口中 ServletContext

  返回:

  The context path of the web application, or "" for the root context

  另请参阅:

  HttpServletRequest.getContextPath()

• registerContext

  public void registerContext​(String contextPath,
                              ServletContext context)

• getContext

  public ServletContext getContext​(String contextPath)

  从接口复制的说明: javax.servlet.ServletContext
  Returns a ServletContext object that corresponds to a specified URL on the server.

  This method allows servlets to gain access to the context for various parts of the server, and as needed obtain RequestDispatcher objects from the context. The given path must be begin with /, is interpreted relative to the server's document root and is matched against the context roots of other web applications hosted on this container.

  In a security conscious environment, the servlet container may return null for a given URL.

  指定者:

  getContext 在接口中 ServletContext

  参数:

  contextPath - a String specifying the context path of another web application in the container.

  返回:

  the ServletContext object that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access.

  另请参阅:

  RequestDispatcher

• setMajorVersion

  public void setMajorVersion​(int majorVersion)

• getMajorVersion

  public int getMajorVersion()

  从接口复制的说明: javax.servlet.ServletContext
  Returns the major version of the Servlet API that this servlet container supports. All implementations that comply with Version 4.0 must have this method return the integer 4.

  指定者:

  getMajorVersion 在接口中 ServletContext

  返回:

  4

• setMinorVersion

  public void setMinorVersion​(int minorVersion)

• getMinorVersion

  public int getMinorVersion()

  从接口复制的说明: javax.servlet.ServletContext
  Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 4.0 must have this method return the integer 0.

  指定者:

  getMinorVersion 在接口中 ServletContext

  返回:

  0

• setEffectiveMajorVersion

  public void setEffectiveMajorVersion​(int effectiveMajorVersion)

• getEffectiveMajorVersion

  public int getEffectiveMajorVersion()

  从接口复制的说明: javax.servlet.ServletContext
  Gets the major version of the Servlet specification that the application represented by this ServletContext is based on.

  The value returned may be different from ServletContext.getMajorVersion(), which returns the major version of the Servlet specification supported by the Servlet container.

  指定者:

  getEffectiveMajorVersion 在接口中 ServletContext

  返回:

  the major version of the Servlet specification that the application represented by this ServletContext is based on

• setEffectiveMinorVersion

  public void setEffectiveMinorVersion​(int effectiveMinorVersion)

• getEffectiveMinorVersion

  public int getEffectiveMinorVersion()

  从接口复制的说明: javax.servlet.ServletContext
  Gets the minor version of the Servlet specification that the application represented by this ServletContext is based on.

  The value returned may be different from ServletContext.getMinorVersion(), which returns the minor version of the Servlet specification supported by the Servlet container.

  指定者:

  getEffectiveMinorVersion 在接口中 ServletContext

  返回:

  the minor version of the Servlet specification that the application represented by this ServletContext is based on

• getMimeType

  @Nullable
  public String getMimeType​(String filePath)

  从接口复制的说明: javax.servlet.ServletContext
  Returns the MIME type of the specified file, or null if the MIME type is not known. The MIME type is determined by the configuration of the servlet container, and may be specified in a web application deployment descriptor. Common MIME types include text/html and image/gif.

  指定者:

  getMimeType 在接口中 ServletContext

  参数:

  filePath - a String specifying the name of a file

  返回:

  a String specifying the file's MIME type

• addMimeType

  public void addMimeType​(String fileExtension,
                          MediaType mimeType)

  Adds a mime type mapping for use by getMimeType(String).

  参数:

  fileExtension - a file extension, such as txt, gif

  mimeType - the mime type

• getResourcePaths

  @Nullable
  public Set<String> getResourcePaths​(String path)

  从接口复制的说明: javax.servlet.ServletContext
  Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument.

  Paths indicating subdirectory paths end with a /.

  The returned paths are all relative to the root of the web application, or relative to the /META-INF/resources directory of a JAR file inside the web application's /WEB-INF/lib directory, and have a leading /.

  The returned set is not backed by the ServletContext object, so changes in the returned set are not reflected in the ServletContext object, and vice-versa.

  For example, for a web application containing:

  
     /welcome.html
     /catalog/index.html
     /catalog/products.html
     /catalog/offers/books.html
     /catalog/offers/music.html
     /customer/login.jsp
     /WEB-INF/web.xml
     /WEB-INF/classes/com.acme.OrderServlet.class
     /WEB-INF/lib/catalog.jar!/META-INF/resources/catalog/moreOffers/books.html
   

  getResourcePaths("/") would return {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}, and getResourcePaths("/catalog/") would return {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/", "/catalog/moreOffers/"}.

  指定者:

  getResourcePaths 在接口中 ServletContext

  参数:

  path - the partial path used to match the resources, which must start with a /

  返回:

  a Set containing the directory listing, or null if there are no resources in the web application whose path begins with the supplied path.

• getResource

  @Nullable
  public URL getResource​(String path)
                  throws MalformedURLException

  从接口复制的说明: javax.servlet.ServletContext
  Returns a URL to the resource that is mapped to the given path.

  The path must begin with a / and is interpreted as relative to the current context root, or relative to the /META-INF/resources directory of a JAR file inside the web application's /WEB-INF/lib directory. This method will first search the document root of the web application for the requested resource, before searching any of the JAR files inside /WEB-INF/lib. The order in which the JAR files inside /WEB-INF/lib are searched is undefined.

  This method allows the servlet container to make a resource available to servlets from any source. Resources can be located on a local or remote file system, in a database, or in a .war file.

  The servlet container must implement the URL handlers and URLConnection objects that are necessary to access the resource.

  This method returns null if no resource is mapped to the pathname.

  Some containers may allow writing to the URL returned by this method using the methods of the URL class.

  The resource content is returned directly, so be aware that requesting a .jsp page returns the JSP source code. Use a RequestDispatcher instead to include results of an execution.

  This method has a different purpose than java.lang.Class.getResource, which looks up resources based on a class loader. This method does not use class loaders.

  指定者:

  getResource 在接口中 ServletContext

  参数:

  path - a String specifying the path to the resource

  返回:

  the resource located at the named path, or null if there is no resource at that path

  抛出:

  MalformedURLException - if the pathname is not given in the correct form

• getResourceAsStream

  @Nullable
  public InputStream getResourceAsStream​(String path)

  从接口复制的说明: javax.servlet.ServletContext
  Returns the resource located at the named path as an InputStream object.

  The data in the InputStream can be of any type or length. The path must be specified according to the rules given in getResource. This method returns null if no resource exists at the specified path.

  Meta-information such as content length and content type that is available via getResource method is lost when using this method.

  The servlet container must implement the URL handlers and URLConnection objects necessary to access the resource.

  This method is different from java.lang.Class.getResourceAsStream, which uses a class loader. This method allows servlet containers to make a resource available to a servlet from any location, without using a class loader.

  指定者:

  getResourceAsStream 在接口中 ServletContext

  参数:

  path - a String specifying the path to the resource

  返回:

  the InputStream returned to the servlet, or null if no resource exists at the specified path

• getRequestDispatcher

  public RequestDispatcher getRequestDispatcher​(String path)

  从接口复制的说明: javax.servlet.ServletContext
  Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static.

  The pathname must begin with a / and is interpreted as relative to the current context root. Use getContext to obtain a RequestDispatcher for resources in foreign contexts.

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

  指定者:

  getRequestDispatcher 在接口中 ServletContext

  参数:

  path - a String specifying the pathname to the resource

  返回:

  a RequestDispatcher object that acts as a wrapper for the resource at the specified path, or null if the ServletContext cannot return a RequestDispatcher

  另请参阅:

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

• getNamedDispatcher

  public RequestDispatcher getNamedDispatcher​(String path)

  从接口复制的说明: javax.servlet.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.

  指定者:

  getNamedDispatcher 在接口中 ServletContext

  参数:

  path - 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()

• registerNamedDispatcher

  public void registerNamedDispatcher​(String name,
                                      RequestDispatcher requestDispatcher)

  Register a RequestDispatcher (typically a MockRequestDispatcher) that acts as a wrapper for the named Servlet.

  参数:

  name - the name of the wrapped Servlet

  requestDispatcher - the dispatcher that wraps the named Servlet

  另请参阅:

  getNamedDispatcher(java.lang.String), unregisterNamedDispatcher(java.lang.String)

• unregisterNamedDispatcher

  public void unregisterNamedDispatcher​(String name)

  Unregister the RequestDispatcher with the given name.

  参数:

  name - the name of the dispatcher to unregister

  另请参阅:

  getNamedDispatcher(java.lang.String), registerNamedDispatcher(java.lang.String, javax.servlet.RequestDispatcher)

• getDefaultServletName

  public String getDefaultServletName()

  Get the name of the defaultServlet.

  Defaults to 'default'.

  另请参阅:

  setDefaultServletName(java.lang.String)

• setDefaultServletName

  public void setDefaultServletName​(String defaultServletName)

  Set the name of the defaultServlet.

  Also unregisters the current default RequestDispatcher and replaces it with a MockRequestDispatcher for the provided defaultServletName.

  参数:

  defaultServletName - the name of the defaultServlet; never null or empty

  另请参阅:

  getDefaultServletName()

• getServlet

  @Deprecated
  @Nullable
  public Servlet getServlet​(String name)

  已过时。

  指定者:

  getServlet 在接口中 ServletContext

  参数:

  name - the servlet name

  返回:

  the javax.servlet.Servlet Servlet with the given name

• getServlets

  @Deprecated
  public Enumeration<Servlet> getServlets()

  已过时。

  指定者:

  getServlets 在接口中 ServletContext

  返回:

  an Enumeration of javax.servlet.Servlet Servlet

• getServletNames

  @Deprecated
  public Enumeration<String> getServletNames()

  已过时。

  指定者:

  getServletNames 在接口中 ServletContext

  返回:

  an Enumeration of javax.servlet.Servlet Servlet names

• log

  public void log​(String message)

  从接口复制的说明: javax.servlet.ServletContext
  Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container.

  指定者:

  log 在接口中 ServletContext

  参数:

  message - a String specifying the message to be written to the log file

• log

  @Deprecated
  public void log​(Exception ex,
                  String message)

  已过时。

  指定者:

  log 在接口中 ServletContext

  参数:

  ex - the Exception error

  message - a String that describes the exception

• log

  public void log​(String message,
                  Throwable ex)

  从接口复制的说明: javax.servlet.ServletContext
  Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file. The name and type of the servlet log file is specific to the servlet container, usually an event log.

  指定者:

  log 在接口中 ServletContext

  参数:

  message - a String that describes the error or exception

  ex - the Throwable error or exception

• getRealPath

  @Nullable
  public String getRealPath​(String path)

  从接口复制的说明: javax.servlet.ServletContext
  Gets the real path corresponding to the given virtual path.

  For example, if path is equal to /index.html, this method will return the absolute file path on the server's filesystem to which a request of the form http://<host>:<port>/<contextPath>/index.html would be mapped, where <contextPath> corresponds to the context path of this ServletContext.

  The real path returned will be in a form appropriate to the computer and operating system on which the servlet container is running, including the proper path separators.

  Resources inside the /META-INF/resources directories of JAR files bundled in the application's /WEB-INF/lib directory must be considered only if the container has unpacked them from their containing JAR file, in which case the path to the unpacked location must be returned.

  This method returns null if the servlet container is unable to translate the given virtual path to a real path.

  指定者:

  getRealPath 在接口中 ServletContext

  参数:

  path - the virtual path to be translated to a real path

  返回:

  the real path, or null if the translation cannot be performed

• getServerInfo

  public String getServerInfo()

  从接口复制的说明: javax.servlet.ServletContext
  Returns the name and version of the servlet container on which the servlet is running.

  The form of the returned string is servername/versionnumber. For example, the JavaServer Web Development Kit may return the string JavaServer Web Dev Kit/1.0.

  The servlet container may return other optional information after the primary string in parentheses, for example, JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86).

  指定者:

  getServerInfo 在接口中 ServletContext

  返回:

  a String containing at least the servlet container name and version number

• getInitParameter

  public String getInitParameter​(String name)

  从接口复制的说明: javax.servlet.ServletContext
  Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist.

  This method can make available configuration information useful to an entire web application. For example, it can provide a webmaster's email address or the name of a system that holds critical data.

  指定者:

  getInitParameter 在接口中 ServletContext

  参数:

  name - a String containing the name of the parameter whose value is requested

  返回:

  a String containing the value of the context's initialization parameter, or null if the context's initialization parameter does not exist.

  另请参阅:

  ServletConfig.getInitParameter(java.lang.String)

• getInitParameterNames

  public Enumeration<String> getInitParameterNames()

  从接口复制的说明: javax.servlet.ServletContext
  Returns the names of the context's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.

  指定者:

  getInitParameterNames 在接口中 ServletContext

  返回:

  an Enumeration of String objects containing the names of the context's initialization parameters

  另请参阅:

  ServletConfig.getInitParameter(java.lang.String)

• setInitParameter

  public boolean setInitParameter​(String name,
                                  String value)

  从接口复制的说明: javax.servlet.ServletContext
  Sets the context initialization parameter with the given name and value on this ServletContext.

  指定者:

  setInitParameter 在接口中 ServletContext

  参数:

  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

• addInitParameter

  public void addInitParameter​(String name,
                               String value)

• getAttribute

  @Nullable
  public Object getAttribute​(String name)

  从接口复制的说明: javax.servlet.ServletContext
  Returns the servlet container attribute with the given name, or null if there is no attribute by that name.

  An attribute allows a servlet container to give the servlet additional information not already provided by this interface. See your server documentation for information about its attributes. A list of supported attributes can be retrieved using getAttributeNames.

  The attribute is returned as a java.lang.Object or some subclass.

  Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

  指定者:

  getAttribute 在接口中 ServletContext

  参数:

  name - a String specifying the name of the attribute

  返回:

  an Object containing the value of the attribute, or null if no attribute exists matching the given name.

  另请参阅:

  ServletContext.getAttributeNames()

• getAttributeNames

  public Enumeration<String> getAttributeNames()

  从接口复制的说明: javax.servlet.ServletContext
  Returns an Enumeration containing the attribute names available within this ServletContext.

  Use the ServletContext.getAttribute(java.lang.String) method with an attribute name to get the value of an attribute.

  指定者:

  getAttributeNames 在接口中 ServletContext

  返回:

  an Enumeration of attribute names

  另请参阅:

  ServletContext.getAttribute(java.lang.String)

• setAttribute

  public void setAttribute​(String name,
                           @Nullable
                           Object value)

  从接口复制的说明: javax.servlet.ServletContext
  Binds an object to a given attribute name in this ServletContext. If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute.

  If listeners are configured on the ServletContext the container notifies them accordingly.

  If a null value is passed, the effect is the same as calling removeAttribute().

  Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

  指定者:

  setAttribute 在接口中 ServletContext

  参数:

  name - a String specifying the name of the attribute

  value - an Object representing the attribute to be bound

• removeAttribute

  public void removeAttribute​(String name)

  从接口复制的说明: javax.servlet.ServletContext
  Removes the attribute with the given name from this ServletContext. After removal, subsequent calls to ServletContext.getAttribute(java.lang.String) to retrieve the attribute's value will return null.

  If listeners are configured on the ServletContext the container notifies them accordingly.

  指定者:

  removeAttribute 在接口中 ServletContext

  参数:

  name - a String specifying the name of the attribute to be removed

• setServletContextName

  public void setServletContextName​(String servletContextName)

• getServletContextName

  public String getServletContextName()

  从接口复制的说明: javax.servlet.ServletContext
  Returns the name of this web application corresponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.

  指定者:

  getServletContextName 在接口中 ServletContext

  返回:

  The name of the web application or null if no name has been declared in the deployment descriptor.

• getClassLoader

  @Nullable
  public ClassLoader getClassLoader()

  从接口复制的说明: javax.servlet.ServletContext
  Gets the class loader of the web application represented by this ServletContext.

  If a security manager exists, and the caller's class loader is not the same as, or an ancestor of the requested class loader, then the security manager's checkPermission method is called with a RuntimePermission("getClassLoader") permission to check whether access to the requested class loader should be granted.

  指定者:

  getClassLoader 在接口中 ServletContext

  返回:

  the class loader of the web application represented by this ServletContext

• declareRoles

  public void declareRoles​(String... roleNames)

  从接口复制的说明: javax.servlet.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.

  指定者:

  declareRoles 在接口中 ServletContext

  参数:

  roleNames - the role names being declared

• getDeclaredRoles

  public Set<String> getDeclaredRoles()

• setSessionTrackingModes

  public void setSessionTrackingModes​(Set<SessionTrackingMode> sessionTrackingModes)
                               throws IllegalStateException,
                                      IllegalArgumentException

  从接口复制的说明: javax.servlet.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.

  指定者:

  setSessionTrackingModes 在接口中 ServletContext

  参数:

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

  抛出:

  IllegalStateException - if this ServletContext has already been initialized

  IllegalArgumentException - if sessionTrackingModes specifies a combination of SessionTrackingMode.SSL with a session tracking mode other than SessionTrackingMode.SSL, or if sessionTrackingModes specifies a session tracking mode that is not supported by the servlet container

• getDefaultSessionTrackingModes

  public Set<SessionTrackingMode> getDefaultSessionTrackingModes()

  从接口复制的说明: javax.servlet.ServletContext
  Gets the session tracking modes that are supported by default for this ServletContext.

  The returned set is not backed by the ServletContext object, so changes in the returned set are not reflected in the ServletContext object, and vice-versa.

  指定者:

  getDefaultSessionTrackingModes 在接口中 ServletContext

  返回:

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

• getEffectiveSessionTrackingModes

  public Set<SessionTrackingMode> getEffectiveSessionTrackingModes()

  从接口复制的说明: javax.servlet.ServletContext
  Gets the session tracking modes that are in effect for this ServletContext.

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

  The returned set is not backed by the ServletContext object, so changes in the returned set are not reflected in the ServletContext object, and vice-versa.

  指定者:

  getEffectiveSessionTrackingModes 在接口中 ServletContext

  返回:

  set of the session tracking modes in effect for this ServletContext

• getSessionCookieConfig

  public SessionCookieConfig getSessionCookieConfig()

  从接口复制的说明: javax.servlet.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.

  指定者:

  getSessionCookieConfig 在接口中 ServletContext

  返回:

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

• setSessionTimeout

  public void setSessionTimeout​(int sessionTimeout)

  从接口复制的说明: javax.servlet.ServletContext
  Sets the session timeout in minutes for this ServletContext.

  指定者:

  setSessionTimeout 在接口中 ServletContext

  参数:

  sessionTimeout - session timeout in minutes

• getSessionTimeout

  public int getSessionTimeout()

  从接口复制的说明: javax.servlet.ServletContext
  Gets the session timeout in minutes that are supported by default for this ServletContext.

  指定者:

  getSessionTimeout 在接口中 ServletContext

  返回:

  the session timeout in minutes that are supported by default for this ServletContext

• setRequestCharacterEncoding

  public void setRequestCharacterEncoding​(@Nullable
                                          String requestCharacterEncoding)

  从接口复制的说明: javax.servlet.ServletContext
  Sets the request character encoding for this ServletContext.

  指定者:

  setRequestCharacterEncoding 在接口中 ServletContext

  参数:

  requestCharacterEncoding - request character encoding

• getRequestCharacterEncoding

  @Nullable
  public String getRequestCharacterEncoding()

  从接口复制的说明: javax.servlet.ServletContext
  Gets the request character encoding that are supported by default for this ServletContext. This method returns null if no request encoding character encoding has been specified in deployment descriptor or container specific configuration (for all web applications in the container).

  指定者:

  getRequestCharacterEncoding 在接口中 ServletContext

  返回:

  the request character encoding that are supported by default for this ServletContext

• setResponseCharacterEncoding

  public void setResponseCharacterEncoding​(@Nullable
                                           String responseCharacterEncoding)

  从接口复制的说明: javax.servlet.ServletContext
  Sets the response character encoding for this ServletContext.

  指定者:

  setResponseCharacterEncoding 在接口中 ServletContext

  参数:

  responseCharacterEncoding - response character encoding

• getResponseCharacterEncoding

  @Nullable
  public String getResponseCharacterEncoding()

  从接口复制的说明: javax.servlet.ServletContext
  Gets the response character encoding that are supported by default for this ServletContext. This method returns null if no response encoding character encoding has been specified in deployment descriptor or container specific configuration (for all web applications in the container).

  指定者:

  getResponseCharacterEncoding 在接口中 ServletContext

  返回:

  the request character encoding that are supported by default for this ServletContext

• getJspConfigDescriptor

  public JspConfigDescriptor getJspConfigDescriptor()

  从接口复制的说明: javax.servlet.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.

  指定者:

  getJspConfigDescriptor 在接口中 ServletContext

  返回:

  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

• addJspFile

  public ServletRegistration.Dynamic addJspFile​(String servletName,
                                                String jspFile)

  从接口复制的说明: javax.servlet.ServletContext
  Adds the servlet with the given jsp file 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 given jspFile to it) and returned.

  指定者:

  addJspFile 在接口中 ServletContext

  参数:

  servletName - the name of the servlet

  jspFile - the full path to a JSP file within the web application beginning with a `/'.

  返回:

  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

• addServlet

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

  从接口复制的说明: javax.servlet.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.

  指定者:

  addServlet 在接口中 ServletContext

  参数:

  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

• addServlet

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

  从接口复制的说明: javax.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.

  指定者:

  addServlet 在接口中 ServletContext

  参数:

  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

• addServlet

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

  从接口复制的说明: javax.servlet.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.

  指定者:

  addServlet 在接口中 ServletContext

  参数:

  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

• createServlet

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

  从接口复制的说明: javax.servlet.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.

  指定者:

  createServlet 在接口中 ServletContext

  类型参数:

  T - the class of the Servlet to create

  参数:

  c - the Servlet class to instantiate

  返回:

  the new Servlet instance

  抛出:

  ServletException - if the given clazz fails to be instantiated

• getServletRegistration

  @Nullable
  public ServletRegistration getServletRegistration​(String servletName)

  This method always returns null.

  指定者:

  getServletRegistration 在接口中 ServletContext

  参数:

  servletName - the name of a servlet

  返回:

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

  另请参阅:

  ServletContext.getServletRegistration(java.lang.String)

• getServletRegistrations

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

  This method always returns an empty map.

  指定者:

  getServletRegistrations 在接口中 ServletContext

  返回:

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

  另请参阅:

  ServletContext.getServletRegistrations()

• addFilter

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

  从接口复制的说明: javax.servlet.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.

  指定者:

  addFilter 在接口中 ServletContext

  参数:

  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

• addFilter

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

  从接口复制的说明: javax.servlet.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.

  指定者:

  addFilter 在接口中 ServletContext

  参数:

  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

• addFilter

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

  从接口复制的说明: javax.servlet.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.

  指定者:

  addFilter 在接口中 ServletContext

  参数:

  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

• createFilter

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

  从接口复制的说明: javax.servlet.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.

  指定者:

  createFilter 在接口中 ServletContext

  类型参数:

  T - the class of the Filter to create

  参数:

  c - the Filter class to instantiate

  返回:

  the new Filter instance

  抛出:

  ServletException - if the given clazz fails to be instantiated

• getFilterRegistration

  @Nullable
  public FilterRegistration getFilterRegistration​(String filterName)

  This method always returns null.

  指定者:

  getFilterRegistration 在接口中 ServletContext

  参数:

  filterName - the name of a filter

  返回:

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

  另请参阅:

  ServletContext.getFilterRegistration(java.lang.String)

• getFilterRegistrations

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

  This method always returns an empty map.

  指定者:

  getFilterRegistrations 在接口中 ServletContext

  返回:

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

  另请参阅:

  ServletContext.getFilterRegistrations()

• addListener

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

  从接口复制的说明: javax.servlet.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
  • HttpSessionAttributeListener
  • HttpSessionIdListener
  • HttpSessionListener

  If this ServletContext was passed to ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, 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.

  指定者:

  addListener 在接口中 ServletContext

  参数:

  listenerClass - the listener class to be instantiated

• addListener

  public void addListener​(String className)

  从接口复制的说明: javax.servlet.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
  • HttpSessionAttributeListener
  • HttpSessionIdListener
  • HttpSessionListener

  If this ServletContext was passed to ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, 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.

  指定者:

  addListener 在接口中 ServletContext

  参数:

  className - the fully qualified class name of the listener

• addListener

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

  从接口复制的说明: javax.servlet.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
  • HttpSessionAttributeListener
  • HttpSessionIdListener
  • HttpSessionListener

  If this ServletContext was passed to ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, 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.

  指定者:

  addListener 在接口中 ServletContext

  类型参数:

  T - the class of the EventListener to add

  参数:

  t - the listener to be added

• createListener

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

  从接口复制的说明: javax.servlet.ServletContext
  Instantiates the given EventListener class.

  The specified EventListener class must implement at least one of the ServletContextListener, ServletContextAttributeListener, ServletRequestListener, ServletRequestAttributeListener, HttpSessionAttributeListener, HttpSessionIdListener, or HttpSessionListener 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.

  指定者:

  createListener 在接口中 ServletContext

  类型参数:

  T - the class of the EventListener to create

  参数:

  c - the EventListener class to instantiate

  返回:

  the new EventListener instance

  抛出:

  ServletException - if the given clazz fails to be instantiated

• getVirtualServerName

  public String getVirtualServerName()

  从接口复制的说明: javax.servlet.ServletContext
  Returns the configuration name of the logical host on which the ServletContext is deployed. Servlet containers may support multiple logical hosts. This method must return the same name for all the servlet contexts deployed on a logical host, and the name returned by this method must be distinct, stable per logical host, and suitable for use in associating server configuration information with the logical host. The returned value is NOT expected or required to be equivalent to a network address or hostname of the logical host.

  指定者:

  getVirtualServerName 在接口中 ServletContext

  返回:

  a String containing the configuration name of the logical host on which the servlet context is deployed.