public interface ServletContext
There is one context per "web application" per Java Virtual Machine. (A "web application" is a collection of servlets
and content installed under a specific subset of the server's URL namespace such as /catalog
and
possibly installed via a .war
file.)
In the case of a web application marked "distributed" in its deployment descriptor, there will be one context instance for each virtual machine. In this situation, the context cannot be used as a location to share global information (because the information won't be truly global). Use an external resource like a database instead.
The ServletContext
object is contained within the ServletConfig
object, which the Web server
provides the servlet when the servlet is initialized.
Servlet.getServletConfig()
,
ServletConfig.getServletContext()
Modifier and Type | Field and Description |
---|---|
static String |
ORDERED_LIBS
The name of the
ServletContext attribute whose value (of type
java.util.List<java.lang.String> ) contains the list of names of JAR files in
WEB-INF/lib ordered by their web fragment names (with possible exclusions if
<absolute-ordering> without any <others/> is being used), or null if no
absolute or relative ordering has been specified |
static String |
TEMPDIR
The name of the ServletContext attribute which stores the private temporary directory (of type
java.io.File) provided by the servlet container for the ServletContext
|
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.
|
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.
|
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> clazz)
Instantiates the given Filter class.
|
<T extends EventListener> |
createListener(Class<T> clazz)
Instantiates the given EventListener class.
|
<T extends Servlet> |
createServlet(Class<T> clazz)
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 uripath)
Returns a
ServletContext object that corresponds to a specified URL on the server. |
String |
getContextPath()
Returns the context path of the web application.
|
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)
Gets the FilterRegistration corresponding to the filter with the given filterName.
|
Map<String,? extends FilterRegistration> |
getFilterRegistrations()
Gets a (possibly empty) Map of the FilterRegistration objects (keyed by filter name) corresponding to all filters
registered with this ServletContext.
|
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 Jakarta Servlet that this container supports.
|
String |
getMimeType(String file)
Returns the MIME type of the specified file, or
null if the MIME type is not known. |
int |
getMinorVersion()
Returns the minor version of Jakarta Servlet that this container supports.
|
RequestDispatcher |
getNamedDispatcher(String name)
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. |
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.
As of Java Servlet API 2.1, with no direct replacement.
This method was originally defined to retrieve a servlet from a
In lieu of this method, servlets can share information using the |
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.
As of Java Servlet API 2.1, with no replacement.
This method was originally defined to return an |
ServletRegistration |
getServletRegistration(String servletName)
Gets the ServletRegistration corresponding to the servlet with the given servletName.
|
Map<String,? extends ServletRegistration> |
getServletRegistrations()
Gets a (possibly empty) Map of the ServletRegistration objects (keyed by servlet name) corresponding to all
servlets registered with this ServletContext.
|
Enumeration<Servlet> |
getServlets()
Deprecated.
As of Java Servlet API 2.0, with no replacement.
This method was originally defined to return an |
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 exception,
String msg)
Deprecated.
As of Java Servlet API 2.1, use
log(String message, Throwable throwable) instead.
This method was originally defined to write an exception's stack trace and an explanatory error message to the servlet log file. |
void |
log(String msg)
Writes the specified message to a servlet log file, usually an event log.
|
void |
log(String message,
Throwable throwable)
Writes an explanatory message and a stack trace for a given
Throwable exception to the servlet log
file. |
void |
removeAttribute(String name)
Removes the attribute with the given name from this ServletContext.
|
void |
setAttribute(String name,
Object object)
Binds an object to a given attribute name in this ServletContext.
|
boolean |
setInitParameter(String name,
String value)
Sets the context initialization parameter with the given name and value on this ServletContext.
|
void |
setRequestCharacterEncoding(String encoding)
Sets the request character encoding for this ServletContext.
|
void |
setResponseCharacterEncoding(String encoding)
Sets the response character encoding for this ServletContext.
|
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.
|
static final String TEMPDIR
static final String ORDERED_LIBS
ServletContext
attribute whose value (of type
java.util.List<java.lang.String>
) contains the list of names of JAR files in
WEB-INF/lib
ordered by their web fragment names (with possible exclusions if
<absolute-ordering>
without any <others/>
is being used), or null if no
absolute or relative ordering has been specifiedString getContextPath()
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.
HttpServletRequest.getContextPath()
ServletContext getContext(String uripath)
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.
uripath
- 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
int getMajorVersion()
int getMinorVersion()
int getEffectiveMajorVersion()
The value returned may be different from getMajorVersion()
, which returns the major version of the Servlet
specification supported by the Servlet container.
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
int getEffectiveMinorVersion()
The value returned may be different from getMinorVersion()
, which returns the minor version of the Servlet
specification supported by the Servlet container.
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
String getMimeType(String file)
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
.file
- a String
specifying the name of a fileString
specifying the file's MIME typeSet<String> getResourcePaths(String path)
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/"}.path
- the partial path used to match the resources, which must start with a /URL getResource(String path) throws MalformedURLException
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.
This method bypasses both implicit (no direct access to WEB-INF or META-INF) and explicit (defined by the web application) security constraints. Care should be taken both when constructing the path (e.g. avoid unsanitized user provided data) and when using the result not to create a security vulnerability in the application.
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 formInputStream getResourceAsStream(String path)
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.
This method bypasses both implicit (no direct access to WEB-INF or META-INF) and explicit (defined by the web application) security constraints. Care should be taken both when constructing the path (e.g. avoid unsanitized user provided data) and when using the result not to create a security vulnerability in the application.
path
- a String
specifying the path to the resourceInputStream
returned to the servlet, or null
if no resource exists at the
specified pathRequestDispatcher getRequestDispatcher(String path)
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
.
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
,
getContext(java.lang.String)
RequestDispatcher getNamedDispatcher(String name)
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.
name
- 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
,
getContext(java.lang.String)
,
ServletConfig.getServletName()
@Deprecated Servlet getServlet(String name) throws ServletException
This method was originally defined to retrieve a servlet from a ServletContext
. In this
version, this method always returns null
and remains only to preserve binary
compatibility. This method will be permanently removed in a future version of Jakarta Servlets.
In lieu of this method, servlets can share information using the ServletContext
class
and can perform shared business logic by invoking methods on common non-servlet classes.
name
- the servlet namejavax.servlet.Servlet Servlet
with the given nameServletException
- if an exception has occurred that interfaces with servlet's normal operation@Deprecated Enumeration<Servlet> getServlets()
This method was originally defined to return an Enumeration
of all the servlets known to
this servlet context. In this version, this method always returns an empty enumeration and remains
only to preserve binary compatibility. This method will be permanently removed in a future version of
Jakarta Servlets.
Enumeration
of javax.servlet.Servlet Servlet
@Deprecated Enumeration<String> getServletNames()
This method was originally defined to return an Enumeration
of all the servlet names
known to this context. In this version, this method always returns an empty Enumeration
and remains only to preserve binary compatibility. This method will be permanently removed in a
future version of Jakarta Servlets.
Enumeration
of javax.servlet.Servlet Servlet
namesvoid log(String msg)
msg
- a String
specifying the message to be written to the log file@Deprecated void log(Exception exception, String msg)
log(String message, Throwable throwable)
instead.
This method was originally defined to write an exception's stack trace and an explanatory error message to the servlet log file.
exception
- the Exception
errormsg
- a String
that describes the exceptionvoid log(String message, Throwable throwable)
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.message
- a String
that describes the error or exceptionthrowable
- the Throwable
error or exceptionString getRealPath(String 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.
path
- the virtual path to be translated to a real pathString getServerInfo()
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)
.
String
containing at least the servlet container name and version numberString getInitParameter(String name)
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.
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.NullPointerException
- if the argument name
is null
ServletConfig.getInitParameter(java.lang.String)
Enumeration<String> getInitParameterNames()
Enumeration
of
String
objects, or an empty Enumeration
if the context has no initialization
parameters.Enumeration
of String
objects containing the names of the context's
initialization parametersServletConfig.getInitParameter(java.lang.String)
boolean setInitParameter(String name, String value)
name
- the name of the context initialization parameter to setvalue
- the value of the context initialization parameter to setIllegalStateException
- if this ServletContext has already been initializedNullPointerException
- if the name parameter is null
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
Object getAttribute(String name)
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 Jakarta Servlet specification reserves
names matching java.*
, javax.*
, and sun.*
.
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.NullPointerException
- if the argument name
is null
getAttributeNames()
Enumeration<String> getAttributeNames()
Enumeration
containing the attribute names available within this ServletContext.
Use the getAttribute(java.lang.String)
method with an attribute name to get the value of an attribute.
Enumeration
of attribute namesgetAttribute(java.lang.String)
void setAttribute(String name, Object object)
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 Jakarta Servlet specification reserves
names matching java.*
, javax.*
, and sun.*
.
name
- a String
specifying the name of the attributeobject
- an Object
representing the attribute to be boundNullPointerException
- if the name parameter is null
void removeAttribute(String name)
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.
name
- a String
specifying the name of the attribute to be removedString getServletContextName()
ServletRegistration.Dynamic addServlet(String servletName, String className)
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 Jakarta EE platform and CDI specifications for additional details about Managed Beans and
resource injection.
servletName
- the name of the servletclassName
- the fully qualified class name of the servletIllegalStateException
- if this ServletContext has already been initializedIllegalArgumentException
- if servletName
is null or an empty StringUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
ServletRegistration.Dynamic addServlet(String servletName, Servlet servlet)
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.
servletName
- the name of the servletservlet
- the servlet instance to registerIllegalStateException
- if this ServletContext has already been initializedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
IllegalArgumentException
- if the given servlet instance implements SingleThreadModel
, or
servletName
is null or an empty StringServletRegistration.Dynamic addServlet(String servletName, Class<? extends Servlet> servletClass)
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 Jakarta EE platform and CDI specifications
for additional details about Managed Beans and resource injection.
servletName
- the name of the servletservletClass
- the class object from which the servlet will be instantiatedIllegalStateException
- if this ServletContext has already been initializedIllegalArgumentException
- if servletName
is null or an empty StringUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
ServletRegistration.Dynamic addJspFile(String servletName, String jspFile)
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.
servletName
- the name of the servletjspFile
- the full path to a JSP file within the web application beginning with a `/'.IllegalStateException
- if this ServletContext has already been initializedIllegalArgumentException
- if servletName
is null or an empty StringUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
<T extends Servlet> T createServlet(Class<T> clazz) throws ServletException
The returned Servlet instance may be further customized before it is registered with this ServletContext via a
call to 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 Jakarta EE
platform and CDI specifications for additional details about Managed Beans and resource injection.
T
- the class of the Servlet to createclazz
- the Servlet class to instantiateServletException
- if the given clazz fails to be instantiatedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
ServletRegistration getServletRegistration(String servletName)
servletName
- the name of a servletUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
Map<String,? extends ServletRegistration> getServletRegistrations()
The returned Map includes the ServletRegistration objects corresponding to all declared and annotated servlets, as well as the ServletRegistration objects corresponding to all servlets that have been added via one of the addServlet and addJspFile methods.
If permitted, any changes to the returned Map must not affect this ServletContext.
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
FilterRegistration.Dynamic addFilter(String filterName, String className)
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 Jakarta EE platform and CDI specifications for additional details about Managed Beans and resource injection.
filterName
- the name of the filterclassName
- the fully qualified class name of the filterIllegalStateException
- if this ServletContext has already been initializedIllegalArgumentException
- if filterName
is null or an empty StringUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
FilterRegistration.Dynamic addFilter(String filterName, Filter filter)
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.
filterName
- the name of the filterfilter
- the filter instance to registerIllegalStateException
- if this ServletContext has already been initializedIllegalArgumentException
- if filterName
is null or an empty StringUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
FilterRegistration.Dynamic addFilter(String filterName, Class<? extends Filter> filterClass)
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 CDI specifications for additional details about Managed Beans and resource injection.
filterName
- the name of the filterfilterClass
- the class object from which the filter will be instantiatedIllegalStateException
- if this ServletContext has already been initializedIllegalArgumentException
- if filterName
is null or an empty StringUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
<T extends Filter> T createFilter(Class<T> clazz) throws ServletException
The returned Filter instance may be further customized before it is registered with this ServletContext via a
call to 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 Jakarta EE platform and CDI specifications for additional details about Managed Beans and resource injection.
T
- the class of the Filter to createclazz
- the Filter class to instantiateServletException
- if the given clazz fails to be instantiatedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
FilterRegistration getFilterRegistration(String filterName)
filterName
- the name of a filterUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
Map<String,? extends FilterRegistration> getFilterRegistrations()
The returned Map includes the FilterRegistration objects corresponding to all declared and annotated filters, as well as the FilterRegistration objects corresponding to all filters that have been added via one of the addFilter methods.
Any changes to the returned Map must not affect this ServletContext.
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
SessionCookieConfig getSessionCookieConfig()
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.
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
void setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)
The given sessionTrackingModes replaces any session tracking modes set by a previous invocation of this method on this ServletContext.
sessionTrackingModes
- the set of session tracking modes to become effective for this
ServletContextIllegalStateException
- if this ServletContext has already been initializedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
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
containerSet<SessionTrackingMode> getDefaultSessionTrackingModes()
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.
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
Set<SessionTrackingMode> getEffectiveSessionTrackingModes()
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.
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
void addListener(String className)
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 Jakarta EE platform and CDI specifications for additional details about Managed Beans and resource injection.
className
- the fully qualified class name of the listenerIllegalArgumentException
- if the class with the given name does not implement any of the above
interfaces, or if it implements ServletContextListener
and this
ServletContext was not passed to
ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, javax.servlet.ServletContext)
IllegalStateException
- if this ServletContext has already been initializedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
<T extends EventListener> void addListener(T t)
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.
T
- the class of the EventListener to addt
- the listener to be addedIllegalArgumentException
- if the given listener is not an instance of any of the above interfaces, or
if it is an instance of ServletContextListener
and this
ServletContext was not passed to
ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, javax.servlet.ServletContext)
IllegalStateException
- if this ServletContext has already been initializedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
void addListener(Class<? extends EventListener> listenerClass)
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 Jakarta EE platform and CDI specifications for additional details about Managed Beans and resource injection.
listenerClass
- the listener class to be instantiatedIllegalArgumentException
- if the given listenerClass does not implement any of the above
interfaces, or if it implements ServletContextListener
and this
ServletContext was not passed to
ServletContainerInitializer.onStartup(java.util.Set<java.lang.Class<?>>, javax.servlet.ServletContext)
IllegalStateException
- if this ServletContext has already been initializedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
<T extends EventListener> T createListener(Class<T> clazz) throws ServletException
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 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 Jakarta EE platform and CDI specifications for additional details about Managed Beans and resource injection.
T
- the class of the EventListener to createclazz
- the EventListener class to instantiateServletException
- if the given clazz fails to be instantiatedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
IllegalArgumentException
- if the specified EventListener class does not implement any of the
ServletContextListener
, ServletContextAttributeListener
,
ServletRequestListener
, ServletRequestAttributeListener
,
HttpSessionAttributeListener
,
HttpSessionIdListener
, or
HttpSessionListener
interfaces.JspConfigDescriptor getJspConfigDescriptor()
<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.<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 existsUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
JspConfigDescriptor
ClassLoader getClassLoader()
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.
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
SecurityException
- if a security manager denies access to the requested class loadervoid declareRoles(String... roleNames)
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.
roleNames
- the role names being declaredUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
IllegalArgumentException
- if any of the argument roleNames is null or the empty stringIllegalStateException
- if the ServletContext has already been initializedString getVirtualServerName()
String
containing the configuration name of the logical host on which the servlet context
is deployed.UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
int getSessionTimeout()
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
void setSessionTimeout(int sessionTimeout)
sessionTimeout
- session timeout in minutesIllegalStateException
- if this ServletContext has already been initializedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
String getRequestCharacterEncoding()
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
void setRequestCharacterEncoding(String encoding)
encoding
- request character encodingIllegalStateException
- if this ServletContext has already been initializedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
String getResponseCharacterEncoding()
UnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
void setResponseCharacterEncoding(String encoding)
encoding
- response character encodingIllegalStateException
- if this ServletContext has already been initializedUnsupportedOperationException
- if this ServletContext was passed to the
ServletContextListener.contextInitialized(javax.servlet.ServletContextEvent)
method of a
ServletContextListener
that was neither declared in
web.xml
or web-fragment.xml
, nor annotated with
WebListener
Copyright © 2021 JBoss by Red Hat. All rights reserved.