public class MockServletContext extends Object implements ServletContext
ServletContext
interface.
As of Spring 5.0, this set of mocks is designed on a Servlet 4.0 baseline.
Compatible with Servlet 3.1 but can be configured to expose a specific version
through setMajorVersion(int)
/setMinorVersion(int)
; default is 3.1.
Note that Servlet 3.1 support is limited: servlet, filter and listener
registration methods are not supported; neither is JSP configuration.
We generally do not recommend to unit test your ServletContainerInitializers and
WebApplicationInitializers which is where those registration methods would be used.
For setting up a full WebApplicationContext
in a test environment, you can
use AnnotationConfigWebApplicationContext
, XmlWebApplicationContext
,
or GenericWebApplicationContext
, passing in a corresponding
MockServletContext
instance. Consider configuring your
MockServletContext
with a FileSystemResourceLoader
in order to
interpret resource paths as relative filesystem locations.
MockServletContext(org.springframework.core.io.ResourceLoader)
,
AnnotationConfigWebApplicationContext
,
XmlWebApplicationContext
,
GenericWebApplicationContext
ORDERED_LIBS, TEMPDIR
Constructor and Description |
---|
MockServletContext()
Create a new
MockServletContext , using no base path and a
DefaultResourceLoader (i.e. |
MockServletContext(ResourceLoader resourceLoader)
Create a new
MockServletContext , using the specified ResourceLoader
and no base path. |
MockServletContext(String resourceBasePath)
Create a new
MockServletContext , using a DefaultResourceLoader . |
MockServletContext(String resourceBasePath,
ResourceLoader resourceLoader)
Create a new
MockServletContext using the supplied resource base
path and resource loader. |
Modifier and Type | Method and Description |
---|---|
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 |
addInitParameter(String name,
String value) |
ServletRegistration.Dynamic |
addJspFile(String servletName,
String jspFile)
Adds the servlet with the given jsp file 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> |
addListener(T t)
Adds the given listener to this ServletContext.
|
void |
addMimeType(String fileExtension,
MediaType mimeType)
Adds a mime type mapping for use by
getMimeType(String) . |
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> |
createFilter(Class<T> c)
Instantiates the given Filter class.
|
<T extends EventListener> |
createListener(Class<T> c)
Instantiates the given EventListener class.
|
<T extends Servlet> |
createServlet(Class<T> c)
Instantiates the given Servlet class.
|
void |
declareRoles(String... roleNames)
Declares role names that are tested using
isUserInRole . |
Object |
getAttribute(String name)
Returns the servlet container attribute with the given name, or
null if there is no attribute by that name. |
Enumeration<String> |
getAttributeNames()
Returns an
Enumeration containing the
attribute names available within this ServletContext. |
ClassLoader |
getClassLoader()
Gets the class loader of the web application represented by this
ServletContext.
|
ServletContext |
getContext(String contextPath)
Returns a
ServletContext object that
corresponds to a specified URL on the server. |
String |
getContextPath()
Returns the context path of the web application.
|
Set<String> |
getDeclaredRoles() |
String |
getDefaultServletName()
Get the name of the default
Servlet . |
Set<SessionTrackingMode> |
getDefaultSessionTrackingModes()
Gets the session tracking modes that are supported by default for this
ServletContext.
|
int |
getEffectiveMajorVersion()
Gets the major version of the Servlet specification that the
application represented by this ServletContext is based on.
|
int |
getEffectiveMinorVersion()
Gets the minor version of the Servlet specification that the
application represented by this ServletContext is based on.
|
Set<SessionTrackingMode> |
getEffectiveSessionTrackingModes()
Gets the session tracking modes that are in effect for this
ServletContext.
|
FilterRegistration |
getFilterRegistration(String filterName)
This method always returns
null . |
Map<String,? extends FilterRegistration> |
getFilterRegistrations()
This method always returns an empty map.
|
String |
getInitParameter(String name)
Returns a
String containing the value of the named
context-wide initialization parameter, or null if
the parameter does not exist. |
Enumeration<String> |
getInitParameterNames()
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. |
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. |
int |
getMajorVersion()
Returns the major version of the Servlet API that this
servlet container supports.
|
String |
getMimeType(String filePath)
Returns the MIME type of the specified file, or
null if
the MIME type is not known. |
int |
getMinorVersion()
Returns the minor version of the Servlet API that this
servlet container supports.
|
RequestDispatcher |
getNamedDispatcher(String path)
Returns a
RequestDispatcher object that acts
as a wrapper for the named servlet. |
String |
getRealPath(String path)
Gets the real path corresponding to the given
virtual path.
|
String |
getRequestCharacterEncoding()
Gets the request character encoding that are supported by default for
this ServletContext.
|
RequestDispatcher |
getRequestDispatcher(String path)
Returns a
RequestDispatcher object that acts
as a wrapper for the resource located at the given path. |
URL |
getResource(String path)
Returns a URL to the resource that is mapped to the given path.
|
InputStream |
getResourceAsStream(String path)
Returns the resource located at the named path as
an
InputStream object. |
protected String |
getResourceLocation(String path)
Build a full resource location for the given path, prepending the resource
base path of this
MockServletContext . |
Set<String> |
getResourcePaths(String path)
Returns a directory-like listing of all the paths to resources
within the web application whose longest sub-path matches the
supplied path argument.
|
String |
getResponseCharacterEncoding()
Gets the response character encoding that are supported by default for
this ServletContext.
|
String |
getServerInfo()
Returns the name and version of the servlet container on which
the servlet is running.
|
Servlet |
getServlet(String name)
Deprecated.
|
String |
getServletContextName()
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.
|
Enumeration<String> |
getServletNames()
Deprecated.
|
ServletRegistration |
getServletRegistration(String servletName)
This method always returns
null . |
Map<String,? extends ServletRegistration> |
getServletRegistrations()
This method always returns an empty map.
|
Enumeration<Servlet> |
getServlets()
Deprecated.
|
SessionCookieConfig |
getSessionCookieConfig()
Gets the
SessionCookieConfig object through which various
properties of the session tracking cookies created on behalf of this
ServletContext may be configured. |
int |
getSessionTimeout()
Gets the session timeout in minutes that are supported by default for
this ServletContext.
|
String |
getVirtualServerName()
Returns the configuration name of the logical host on which the
ServletContext is deployed.
|
void |
log(Exception ex,
String message)
Deprecated.
|
void |
log(String message)
Writes the specified message to a servlet log file, usually
an event log.
|
void |
log(String message,
Throwable ex)
Writes an explanatory message and a stack trace
for a given
Throwable exception
to the servlet log file. |
void |
registerContext(String contextPath,
ServletContext context) |
void |
registerNamedDispatcher(String name,
RequestDispatcher requestDispatcher)
Register a
RequestDispatcher (typically a MockRequestDispatcher )
that acts as a wrapper for the named Servlet. |
void |
removeAttribute(String name)
Removes the attribute with the given name from
this ServletContext.
|
void |
setAttribute(String name,
Object value)
Binds an object to a given attribute name in this ServletContext.
|
void |
setContextPath(String contextPath) |
void |
setDefaultServletName(String defaultServletName)
Set the name of the default
Servlet . |
void |
setEffectiveMajorVersion(int effectiveMajorVersion) |
void |
setEffectiveMinorVersion(int effectiveMinorVersion) |
boolean |
setInitParameter(String name,
String value)
Sets the context initialization parameter with the given name and
value on this ServletContext.
|
void |
setMajorVersion(int majorVersion) |
void |
setMinorVersion(int minorVersion) |
void |
setRequestCharacterEncoding(String requestCharacterEncoding)
Sets the request character encoding for this ServletContext.
|
void |
setResponseCharacterEncoding(String responseCharacterEncoding)
Sets the response character encoding for this ServletContext.
|
void |
setServletContextName(String servletContextName) |
void |
setSessionTimeout(int sessionTimeout)
Sets the session timeout in minutes for this ServletContext.
|
void |
setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)
Sets the session tracking modes that are to become effective for this
ServletContext.
|
void |
unregisterNamedDispatcher(String name)
Unregister the
RequestDispatcher with the given name. |
public MockServletContext()
MockServletContext
, using no base path and a
DefaultResourceLoader
(i.e. the classpath root as WAR root).DefaultResourceLoader
public MockServletContext(String resourceBasePath)
MockServletContext
, using a DefaultResourceLoader
.resourceBasePath
- the root directory of the WAR (should not end with a slash)DefaultResourceLoader
public MockServletContext(@Nullable ResourceLoader resourceLoader)
MockServletContext
, using the specified ResourceLoader
and no base path.resourceLoader
- the ResourceLoader to use (or null for the default)public MockServletContext(String resourceBasePath, @Nullable ResourceLoader resourceLoader)
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)
protected String getResourceLocation(String path)
MockServletContext
.path
- the path as specifiedpublic void setContextPath(String contextPath)
public String getContextPath()
javax.servlet.ServletContext
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
in interface ServletContext
HttpServletRequest.getContextPath()
public void registerContext(String contextPath, ServletContext context)
public ServletContext getContext(String contextPath)
javax.servlet.ServletContext
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
in interface ServletContext
contextPath
- a String
specifying the context path of
another web application in the container.ServletContext
object that
corresponds to the named URL, or null if either
none exists or the container wishes to restrict
this access.RequestDispatcher
public void setMajorVersion(int majorVersion)
public int getMajorVersion()
javax.servlet.ServletContext
getMajorVersion
in interface ServletContext
public void setMinorVersion(int minorVersion)
public int getMinorVersion()
javax.servlet.ServletContext
getMinorVersion
in interface ServletContext
public void setEffectiveMajorVersion(int effectiveMajorVersion)
public int getEffectiveMajorVersion()
javax.servlet.ServletContext
The value returned may be different from ServletContext.getMajorVersion()
,
which returns the major version of the Servlet specification
supported by the Servlet container.
getEffectiveMajorVersion
in interface ServletContext
public void setEffectiveMinorVersion(int effectiveMinorVersion)
public int getEffectiveMinorVersion()
javax.servlet.ServletContext
The value returned may be different from ServletContext.getMinorVersion()
,
which returns the minor version of the Servlet specification
supported by the Servlet container.
getEffectiveMinorVersion
in interface ServletContext
@Nullable public String getMimeType(String filePath)
javax.servlet.ServletContext
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
in interface ServletContext
filePath
- a String
specifying the name of a fileString
specifying the file's MIME typepublic void addMimeType(String fileExtension, MediaType mimeType)
getMimeType(String)
.fileExtension
- a file extension, such as txt
, gif
mimeType
- the mime type@Nullable public Set<String> getResourcePaths(String path)
javax.servlet.ServletContext
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
in interface ServletContext
path
- the partial path used to match the resources,
which must start with a /@Nullable public URL getResource(String path) throws MalformedURLException
javax.servlet.ServletContext
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
in interface ServletContext
path
- a String
specifying
the path to the resourcenull
if there is no resource at that pathMalformedURLException
- if the pathname is not given in
the correct form@Nullable public InputStream getResourceAsStream(String path)
javax.servlet.ServletContext
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
in interface ServletContext
path
- a String
specifying the path
to the resourceInputStream
returned to the
servlet, or null
if no resource
exists at the specified pathpublic RequestDispatcher getRequestDispatcher(String path)
javax.servlet.ServletContext
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
in interface ServletContext
path
- a String
specifying the pathname
to the resourceRequestDispatcher
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)
public RequestDispatcher getNamedDispatcher(String path)
javax.servlet.ServletContext
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
in interface ServletContext
path
- a String
specifying the name
of a servlet to wrapRequestDispatcher
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()
public void registerNamedDispatcher(String name, RequestDispatcher requestDispatcher)
RequestDispatcher
(typically a MockRequestDispatcher
)
that acts as a wrapper for the named Servlet.name
- the name of the wrapped ServletrequestDispatcher
- the dispatcher that wraps the named ServletgetNamedDispatcher(java.lang.String)
,
unregisterNamedDispatcher(java.lang.String)
public void unregisterNamedDispatcher(String name)
RequestDispatcher
with the given name.name
- the name of the dispatcher to unregistergetNamedDispatcher(java.lang.String)
,
registerNamedDispatcher(java.lang.String, javax.servlet.RequestDispatcher)
public String getDefaultServletName()
Servlet
.
Defaults to 'default'.
setDefaultServletName(java.lang.String)
public void setDefaultServletName(String defaultServletName)
Servlet
.
Also unregisters
the current default
RequestDispatcher
and replaces
it with a MockRequestDispatcher
for the provided
defaultServletName
.
defaultServletName
- the name of the default Servlet
;
never null
or emptygetDefaultServletName()
@Deprecated @Nullable public Servlet getServlet(String name)
getServlet
in interface ServletContext
name
- the servlet namejavax.servlet.Servlet Servlet
with the given name@Deprecated public Enumeration<Servlet> getServlets()
getServlets
in interface ServletContext
Enumeration
of javax.servlet.Servlet Servlet
@Deprecated public Enumeration<String> getServletNames()
getServletNames
in interface ServletContext
Enumeration
of javax.servlet.Servlet Servlet
namespublic void log(String message)
javax.servlet.ServletContext
log
in interface ServletContext
message
- a String
specifying the
message to be written to the log file@Deprecated public void log(Exception ex, String message)
log
in interface ServletContext
ex
- the Exception
errormessage
- a String
that describes the exceptionpublic void log(String message, Throwable ex)
javax.servlet.ServletContext
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
in interface ServletContext
message
- a String
that
describes the error or exceptionex
- the Throwable
error
or exception@Nullable public String getRealPath(String path)
javax.servlet.ServletContext
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
in interface ServletContext
path
- the virtual path to be translated to a
real pathpublic String getServerInfo()
javax.servlet.ServletContext
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
in interface ServletContext
String
containing at least the
servlet container name and version numberpublic String getInitParameter(String name)
javax.servlet.ServletContext
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
in interface ServletContext
name
- a String
containing the name of the
parameter whose value is requestedString
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)
public Enumeration<String> getInitParameterNames()
javax.servlet.ServletContext
Enumeration
of String
objects, or an
empty Enumeration
if the context has no initialization
parameters.getInitParameterNames
in interface ServletContext
Enumeration
of String
objects containing the names of the context's
initialization parametersServletConfig.getInitParameter(java.lang.String)
public boolean setInitParameter(String name, String value)
javax.servlet.ServletContext
setInitParameter
in interface ServletContext
name
- the name of the context initialization parameter to setvalue
- the value of the context initialization parameter to set@Nullable public Object getAttribute(String name)
javax.servlet.ServletContext
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
in interface ServletContext
name
- a String
specifying the name
of the attributeObject
containing the value of the
attribute, or null
if no attribute
exists matching the given name.ServletContext.getAttributeNames()
public Enumeration<String> getAttributeNames()
javax.servlet.ServletContext
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
in interface ServletContext
Enumeration
of attribute
namesServletContext.getAttribute(java.lang.String)
public void setAttribute(String name, @Nullable Object value)
javax.servlet.ServletContext
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
in interface ServletContext
name
- a String
specifying the name
of the attributevalue
- an Object
representing the
attribute to be boundpublic void removeAttribute(String name)
javax.servlet.ServletContext
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
in interface ServletContext
name
- a String
specifying the name
of the attribute to be removedpublic void setServletContextName(String servletContextName)
public String getServletContextName()
javax.servlet.ServletContext
getServletContextName
in interface ServletContext
@Nullable public ClassLoader getClassLoader()
javax.servlet.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
in interface ServletContext
public void declareRoles(String... roleNames)
javax.servlet.ServletContext
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
in interface ServletContext
roleNames
- the role names being declaredpublic void setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes) throws IllegalStateException, IllegalArgumentException
javax.servlet.ServletContext
The given sessionTrackingModes replaces any session tracking modes set by a previous invocation of this method on this ServletContext.
setSessionTrackingModes
in interface ServletContext
sessionTrackingModes
- the set of session tracking modes to
become effective for this ServletContextIllegalStateException
- if this ServletContext has already
been initializedIllegalArgumentException
- 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 containerpublic Set<SessionTrackingMode> getDefaultSessionTrackingModes()
javax.servlet.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
in interface ServletContext
public Set<SessionTrackingMode> getEffectiveSessionTrackingModes()
javax.servlet.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
in interface ServletContext
public SessionCookieConfig getSessionCookieConfig()
javax.servlet.ServletContext
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
in interface ServletContext
public void setSessionTimeout(int sessionTimeout)
javax.servlet.ServletContext
setSessionTimeout
in interface ServletContext
sessionTimeout
- session timeout in minutespublic int getSessionTimeout()
javax.servlet.ServletContext
getSessionTimeout
in interface ServletContext
public void setRequestCharacterEncoding(@Nullable String requestCharacterEncoding)
javax.servlet.ServletContext
setRequestCharacterEncoding
in interface ServletContext
requestCharacterEncoding
- request character encoding@Nullable public String getRequestCharacterEncoding()
javax.servlet.ServletContext
getRequestCharacterEncoding
in interface ServletContext
public void setResponseCharacterEncoding(@Nullable String responseCharacterEncoding)
javax.servlet.ServletContext
setResponseCharacterEncoding
in interface ServletContext
responseCharacterEncoding
- response character encoding@Nullable public String getResponseCharacterEncoding()
javax.servlet.ServletContext
getResponseCharacterEncoding
in interface ServletContext
public JspConfigDescriptor getJspConfigDescriptor()
javax.servlet.ServletContext
<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
in interface ServletContext
<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
existsJspConfigDescriptor
public ServletRegistration.Dynamic addJspFile(String servletName, String jspFile)
javax.servlet.ServletContext
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
in interface ServletContext
servletName
- the name of the servletjspFile
- the full path to a JSP file within the web application
beginning with a `/'.public ServletRegistration.Dynamic addServlet(String servletName, String className)
javax.servlet.ServletContext
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
in interface ServletContext
servletName
- the name of the servletclassName
- the fully qualified class name of the servletpublic ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet)
javax.servlet.ServletContext
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
in interface ServletContext
servletName
- the name of the servletservlet
- the servlet instance to registerpublic ServletRegistration.Dynamic addServlet(String servletName, Class<? extends Servlet> servletClass)
javax.servlet.ServletContext
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
in interface ServletContext
servletName
- the name of the servletservletClass
- the class object from which the servlet will be
instantiatedpublic <T extends Servlet> T createServlet(Class<T> c) throws ServletException
javax.servlet.ServletContext
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
in interface ServletContext
T
- the class of the Servlet to createc
- the Servlet class to instantiateServletException
- if the given clazz fails to be
instantiated@Nullable public ServletRegistration getServletRegistration(String servletName)
null
.getServletRegistration
in interface ServletContext
servletName
- the name of a servletServletContext.getServletRegistration(java.lang.String)
public Map<String,? extends ServletRegistration> getServletRegistrations()
getServletRegistrations
in interface ServletContext
ServletContext.getServletRegistrations()
public FilterRegistration.Dynamic addFilter(String filterName, String className)
javax.servlet.ServletContext
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
in interface ServletContext
filterName
- the name of the filterclassName
- the fully qualified class name of the filterpublic FilterRegistration.Dynamic addFilter(String filterName, Filter filter)
javax.servlet.ServletContext
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
in interface ServletContext
filterName
- the name of the filterfilter
- the filter instance to registerpublic FilterRegistration.Dynamic addFilter(String filterName, Class<? extends Filter> filterClass)
javax.servlet.ServletContext
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
in interface ServletContext
filterName
- the name of the filterfilterClass
- the class object from which the filter will be
instantiatedpublic <T extends Filter> T createFilter(Class<T> c) throws ServletException
javax.servlet.ServletContext
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
in interface ServletContext
T
- the class of the Filter to createc
- the Filter class to instantiateServletException
- if the given clazz fails to be
instantiated@Nullable public FilterRegistration getFilterRegistration(String filterName)
null
.getFilterRegistration
in interface ServletContext
filterName
- the name of a filterServletContext.getFilterRegistration(java.lang.String)
public Map<String,? extends FilterRegistration> getFilterRegistrations()
getFilterRegistrations
in interface ServletContext
ServletContext.getFilterRegistrations()
public void addListener(Class<? extends EventListener> listenerClass)
javax.servlet.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
in interface ServletContext
listenerClass
- the listener class to be instantiatedpublic void addListener(String className)
javax.servlet.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
in interface ServletContext
className
- the fully qualified class name of the listenerpublic <T extends EventListener> void addListener(T t)
javax.servlet.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
in interface ServletContext
T
- the class of the EventListener to addt
- the listener to be addedpublic <T extends EventListener> T createListener(Class<T> c) throws ServletException
javax.servlet.ServletContext
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
in interface ServletContext
T
- the class of the EventListener to createc
- the EventListener class to instantiateServletException
- if the given clazz fails to be
instantiatedpublic String getVirtualServerName()
javax.servlet.ServletContext
getVirtualServerName
in interface ServletContext
String
containing the configuration name of the
logical host on which the servlet context is deployed.