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.
- See Also:
-
Field Summary
-
Method Summary
Modifier and TypeMethodDescriptionAdd filter to context.Add filter to context.Add filter to context.addJspFile
(String jspName, String jspFile) Add a JSP to the context.void
addListener
(Class<? extends EventListener> listenerClass) TODO SERVLET3 - Add commentsvoid
addListener
(String className) TODO SERVLET3 - Add comments<T extends EventListener>
voidaddListener
(T t) TODO SERVLET3 - Add commentsaddServlet
(String servletName, Servlet servlet) Register a servlet instance for use in this ServletContext.addServlet
(String servletName, Class<? extends Servlet> servletClass) Add servlet to the context.addServlet
(String servletName, String className) Register a servlet implementation for use in this ServletContext.<T extends Filter>
TcreateFilter
(Class<T> c) Create a Filter instance using the given class.<T extends EventListener>
TcreateListener
(Class<T> c) TODO SERVLET3 - Add comments<T extends Servlet>
TcreateServlet
(Class<T> c) Create an Servlet instance using the given class.void
declareRoles
(String... roleNames) Add to the declared roles for this ServletContext.getAttribute
(String name) Returns the servlet container attribute with the given name, ornull
if there is no attribute by that name.Returns anEnumeration
containing the attribute names available within this servlet context.Get the web application class loader associated with this ServletContext.getContext
(String uripath) Returns aServletContext
object that corresponds to a specified URL on the server.Return the main path associated with this context.Obtains the default session tracking modes for this web application.int
Obtain the major version of the servlet specification for which this web application is implemented.int
Obtain the minor version of the servlet specification for which this web application is implemented.Obtains the currently enabled session tracking modes for this web application.getFilterRegistration
(String filterName) TODO SERVLET3 - Add commentsMap
<String, ? extends FilterRegistration> getInitParameter
(String name) Returns aString
containing the value of the named context-wide initialization parameter, ornull
if the parameter does not exist.Returns the names of the context's initialization parameters as anEnumeration
ofString
objects, or an emptyEnumeration
if the context has no initialization parameters.int
Returns the major version of the Java Servlet API that this servlet container supports.getMimeType
(String file) Returns the MIME type of the specified file, ornull
if the MIME type is not known.int
Returns the minor version of the Servlet API that this servlet container supports.getNamedDispatcher
(String name) Returns aRequestDispatcher
object that acts as a wrapper for the named servlet.getRealPath
(String path) Returns aString
containing the real path for a given virtual path.Get the default character encoding for reading request bodies.getRequestDispatcher
(String path) Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path.getResource
(String path) Returns a URL to the resource that is mapped to a specified path.getResourceAsStream
(String path) Returns the resource located at the named path as anInputStream
object.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.Get the default character encoding for writing response bodies.Returns the name and version of the servlet container on which the servlet is running.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.getServletRegistration
(String servletName) Obtain the details of the named servlet.Map
<String, ? extends ServletRegistration> Obtain a Map of servlet names to servlet registrations for all servlets registered with this context.int
Get the default session timeout.Get the primary name of the virtual host on which this context is deployed.void
Writes the specified message to a servlet log file, usually an event log.void
Writes an explanatory message and a stack trace for a givenThrowable
exception to the servlet log file.void
removeAttribute
(String name) Removes the attribute with the given name from the servlet context.void
setAttribute
(String name, Object object) Binds an object to a given attribute name in this servlet context.boolean
setInitParameter
(String name, String value) Set the given initialisation parameter to the given value.void
setRequestCharacterEncoding
(String encoding) Set the default character encoding to use for reading request bodies.void
setResponseCharacterEncoding
(String encoding) Set the default character encoding to use for writing response bodies.void
setSessionTimeout
(int sessionTimeout) Set the default session timeout.void
setSessionTrackingModes
(Set<SessionTrackingMode> sessionTrackingModes) Configures the available session tracking modes for this web application.
-
Field Details
-
TEMPDIR
The name of the ServletContext attribute that holds the temporary file location for the web application.- See Also:
-
ORDERED_LIBS
The name of the ServletContext attribute that holds the ordered list of web fragments for this web application.- Since:
- Servlet 3.0
- See Also:
-
-
Method Details
-
getContextPath
String getContextPath()Return the main path associated with this context.- Returns:
- The main context path
- Since:
- Servlet 2.5
-
getContext
Returns aServletContext
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.- Parameters:
uripath
- aString
specifying the context path of another web application in the container.- Returns:
- the
ServletContext
object that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access. - See Also:
-
getMajorVersion
int getMajorVersion()Returns the major version of the Java Servlet API that this servlet container supports. All implementations that comply with Version 6.0 must have this method return the integer 6.- Returns:
- 6
-
getMinorVersion
int getMinorVersion()Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 6.0 must have this method return the integer 0.- Returns:
- 0
-
getEffectiveMajorVersion
int getEffectiveMajorVersion()Obtain the major version of the servlet specification for which this web application is implemented.- Returns:
- The major version declared in web.xml
- Since:
- Servlet 3.0
-
getEffectiveMinorVersion
int getEffectiveMinorVersion()Obtain the minor version of the servlet specification for which this web application is implemented.- Returns:
- The minor version declared in web.xml
- Since:
- Servlet 3.0
-
getMimeType
Returns the MIME type of the specified file, ornull
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 are"text/html"
and"image/gif"
.- Parameters:
file
- aString
specifying the name of a file- Returns:
- a
String
specifying the file's MIME type
-
getResourcePaths
Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are all relative to the root of the web application and have a leading '/'. 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,
getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}
getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}.- Parameters:
path
- the partial path used to match the resources, which must start with a /- Returns:
- a Set containing the directory listing, or null if there are no resources in the web application whose path begins with the supplied path.
- Since:
- Servlet 2.3
-
getResource
Returns a URL to the resource that is mapped to a specified path. The path must begin with a "/" and is interpreted as relative to the current context root.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 aRequestDispatcher
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.- Parameters:
path
- aString
specifying the path to the resource- Returns:
- the resource located at the named path, or
null
if there is no resource at that path - Throws:
MalformedURLException
- if the pathname is not given in the correct form
-
getResourceAsStream
Returns the resource located at the named path as anInputStream
object.The data in the
InputStream
can be of any type or length. The path must be specified according to the rules given ingetResource
. This method returnsnull
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.- Parameters:
path
- aString
specifying the path to the resource- Returns:
- the
InputStream
returned to the servlet, ornull
if no resource exists at the specified path
-
getRequestDispatcher
Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path. ARequestDispatcher
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 aRequestDispatcher
for resources in foreign contexts. This method returnsnull
if theServletContext
cannot return aRequestDispatcher
.- Parameters:
path
- aString
specifying the pathname to the resource- Returns:
- a
RequestDispatcher
object that acts as a wrapper for the resource at the specified path, ornull
if theServletContext
cannot return aRequestDispatcher
- See Also:
-
getNamedDispatcher
Returns aRequestDispatcher
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 theServletContext
cannot return aRequestDispatcher
for any reason.- Parameters:
name
- aString
specifying the name of a servlet to wrap- Returns:
- a
RequestDispatcher
object that acts as a wrapper for the named servlet, ornull
if theServletContext
cannot return aRequestDispatcher
- See Also:
-
log
Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container.- Parameters:
msg
- aString
specifying the message to be written to the log file
-
log
Writes an explanatory message and a stack trace for a givenThrowable
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.- Parameters:
message
- aString
that describes the error or exceptionthrowable
- theThrowable
error or exception
-
getRealPath
Returns aString
containing the real path for a given virtual path. For example, the path "/index.html" returns the absolute file path on the server's filesystem would be served by a request for "http://host/contextPath/index.html", where contextPath is 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. This method returns
null
if the servlet container cannot translate the virtual path to a real path for any reason (such as when the content is being made available from a.war
archive).- Parameters:
path
- aString
specifying a virtual path- Returns:
- a
String
specifying the real path, or null if the translation cannot be performed
-
getServerInfo
String getServerInfo()Returns the name and version of the servlet container on which the servlet is running.The form of the returned string is servername/versionnumber. For example, the JavaServer Web Development Kit may return the string
JavaServer Web Dev Kit/1.0
.The servlet container may return other optional information after the primary string in parentheses, for example,
JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86)
.- Returns:
- a
String
containing at least the servlet container name and version number
-
getInitParameter
Returns aString
containing the value of the named context-wide initialization parameter, ornull
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 web site administrator's email address or the name of a system that holds critical data.
- Parameters:
name
- aString
containing the name of the parameter whose value is requested- Returns:
- a
String
containing the value of the initialization parameter - Throws:
NullPointerException
- If the provided parameter name isnull
- See Also:
-
getInitParameterNames
Enumeration<String> getInitParameterNames()Returns the names of the context's initialization parameters as anEnumeration
ofString
objects, or an emptyEnumeration
if the context has no initialization parameters.- Returns:
- an
Enumeration
ofString
objects containing the names of the context's initialization parameters - See Also:
-
setInitParameter
Set the given initialisation parameter to the given value.- Parameters:
name
- Name of initialisation parametervalue
- Value for initialisation parameter- Returns:
true
if the call succeeds orfalse
if the call fails because an initialisation parameter with the same name has already been set- Throws:
IllegalStateException
- If initialisation of this ServletContext has already completedUnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.NullPointerException
- If the provided parameter name isnull
- Since:
- Servlet 3.0
-
getAttribute
Returns the servlet container attribute with the given name, ornull
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 usinggetAttributeNames
.The attribute is returned as a
java.lang.Object
or some subclass. Attribute names should follow the same convention as package names. The Jakarta EE platform reserves names matchingjakarta.*
.- Parameters:
name
- aString
specifying the name of the attribute- Returns:
- an
Object
containing the value of the attribute, ornull
if no attribute exists matching the given name - Throws:
NullPointerException
- If the provided attribute name isnull
- See Also:
-
getAttributeNames
Enumeration<String> getAttributeNames()Returns anEnumeration
containing the attribute names available within this servlet context. Use thegetAttribute(java.lang.String)
method with an attribute name to get the value of an attribute.- Returns:
- an
Enumeration
of attribute names - See Also:
-
setAttribute
Binds an object to a given attribute name in this servlet context. If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute.If listeners are configured on the
ServletContext
the container notifies them accordingly.If a null value is passed, the effect is the same as calling
removeAttribute()
.Attribute names should follow the same convention as package names. The Jakarta EE platform reserves names matching
jakarta.*
.- Parameters:
name
- aString
specifying the name of the attributeobject
- anObject
representing the attribute to be bound- Throws:
NullPointerException
- If the provided attribute name isnull
-
removeAttribute
Removes the attribute with the given name from the servlet context. After removal, subsequent calls togetAttribute(java.lang.String)
to retrieve the attribute's value will returnnull
.If listeners are configured on the
ServletContext
the container notifies them accordingly.- Parameters:
name
- aString
specifying the name of the attribute to be removed
-
getServletContextName
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.- Returns:
- The name of the web application or null if no name has been declared in the deployment descriptor.
- Since:
- Servlet 2.3
-
addServlet
Register a servlet implementation for use in this ServletContext.- Parameters:
servletName
- The name of the servlet to registerclassName
- The implementation class for the servlet- Returns:
- The registration object that enables further configuration
- Throws:
IllegalStateException
- If the context has already been initialisedUnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
addServlet
Register a servlet instance for use in this ServletContext.- Parameters:
servletName
- The name of the servlet to registerservlet
- The Servlet instance to register- Returns:
- The registration object that enables further configuration
- Throws:
IllegalStateException
- If the context has already been initialisedUnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
addServlet
Add servlet to the context.- Parameters:
servletName
- Name of servlet to addservletClass
- Class of servlet to add- Returns:
null
if the servlet has already been fully defined, else aServletRegistration.Dynamic
object that can be used to further configure the servlet- Throws:
IllegalStateException
- If the context has already been initialisedUnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
addJspFile
Add a JSP to the context.- Parameters:
jspName
- The servlet name under which this JSP file should be registeredjspFile
- The path, relative to the web application root, for the JSP file to be used for this servlet- Returns:
- a
ServletRegistration.Dynamic
object that can be used to further configure the servlet - Since:
- Servlet 4.0
-
createServlet
Create an Servlet instance using the given class. The instance is just created. No initialisation occurs.- Type Parameters:
T
- The type for the given class- Parameters:
c
- The the class for which an instance should be created- Returns:
- The created Servlet instance.
- Throws:
ServletException
- If the servlet instance cannot be created.UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
getServletRegistration
Obtain the details of the named servlet.- Parameters:
servletName
- The name of the Servlet of interest- Returns:
- The registration details for the named Servlet or
null
if no Servlet has been registered with the given name - Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
getServletRegistrations
Map<String,? extends ServletRegistration> getServletRegistrations()Obtain a Map of servlet names to servlet registrations for all servlets registered with this context.- Returns:
- A Map of servlet names to servlet registrations for all servlets registered with this context
- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
addFilter
Add filter to context.- Parameters:
filterName
- Name of filter to addclassName
- Name of filter class- Returns:
null
if the filter has already been fully defined, else aFilterRegistration.Dynamic
object that can be used to further configure the filter- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.IllegalStateException
- If the context has already been initialised- Since:
- Servlet 3.0
-
addFilter
Add filter to context.- Parameters:
filterName
- Name of filter to addfilter
- Filter to add- Returns:
null
if the filter has already been fully defined, else aFilterRegistration.Dynamic
object that can be used to further configure the filter- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.IllegalStateException
- If the context has already been initialised- Since:
- Servlet 3.0
-
addFilter
Add filter to context.- Parameters:
filterName
- Name of filter to addfilterClass
- Class of filter to add- Returns:
null
if the filter has already been fully defined, else aFilterRegistration.Dynamic
object that can be used to further configure the filter- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.IllegalStateException
- If the context has already been initialised- Since:
- Servlet 3.0
-
createFilter
Create a Filter instance using the given class. The instance is just created. No initialisation occurs.- Type Parameters:
T
- The type for the given class- Parameters:
c
- The the class for which an instance should be created- Returns:
- The created Filter instance.
- Throws:
ServletException
- If the Filter instance cannot be createdUnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
getFilterRegistration
TODO SERVLET3 - Add comments- Parameters:
filterName
- TODO- Returns:
- TODO
- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
getFilterRegistrations
Map<String,? extends FilterRegistration> getFilterRegistrations()- Returns:
- TODO
- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0 TODO SERVLET3 - Add comments
-
getSessionCookieConfig
SessionCookieConfig getSessionCookieConfig()- Returns:
- TODO
- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0 TODO SERVLET3 - Add comments
-
setSessionTrackingModes
Configures the available session tracking modes for this web application.- Parameters:
sessionTrackingModes
- The session tracking modes to use for this web application- Throws:
IllegalArgumentException
- If sessionTrackingModes specifiesSessionTrackingMode.SSL
in combination with any otherSessionTrackingMode
IllegalStateException
- If the context has already been initialisedUnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
getDefaultSessionTrackingModes
Set<SessionTrackingMode> getDefaultSessionTrackingModes()Obtains the default session tracking modes for this web application. By defaultSessionTrackingMode.URL
is always supported,SessionTrackingMode.COOKIE
is supported unless thecookies
attribute has been set tofalse
for the context andSessionTrackingMode.SSL
is supported if at least one of the connectors used by this context has the attributesecure
set totrue
.- Returns:
- The set of default session tracking modes for this web application
- Since:
- Servlet 3.0
-
getEffectiveSessionTrackingModes
Set<SessionTrackingMode> getEffectiveSessionTrackingModes()Obtains the currently enabled session tracking modes for this web application.- Returns:
- The value supplied via
setSessionTrackingModes(Set)
if one was previously set, else return the defaults - Since:
- Servlet 3.0
-
addListener
TODO SERVLET3 - Add comments- Parameters:
className
- TODO- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
addListener
TODO SERVLET3 - Add comments- Type Parameters:
T
- TODO- Parameters:
t
- TODO- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
addListener
TODO SERVLET3 - Add comments- Parameters:
listenerClass
- TODO- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
createListener
TODO SERVLET3 - Add comments- Type Parameters:
T
- TODO- Parameters:
c
- TODO- Returns:
- TODO
- Throws:
ServletException
- TODOUnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.- Since:
- Servlet 3.0
-
getJspConfigDescriptor
JspConfigDescriptor getJspConfigDescriptor()- Returns:
- TODO
- Since:
- Servlet 3.0 TODO SERVLET3 - Add comments
-
getClassLoader
ClassLoader getClassLoader()Get the web application class loader associated with this ServletContext.- Returns:
- The associated web application class loader
- Throws:
SecurityException
- if access to the class loader is prevented by a SecurityManager- Since:
- Servlet 3.0
-
declareRoles
Add to the declared roles for this ServletContext.- Parameters:
roleNames
- The roles to add- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.IllegalArgumentException
- If the list of roleNames is null or emptyIllegalStateException
- If the ServletContext has already been initialised- Since:
- Servlet 3.0
-
getVirtualServerName
String getVirtualServerName()Get the primary name of the virtual host on which this context is deployed. The name may or may not be a valid host name.- Returns:
- The primary name of the virtual host on which this context is deployed
- Since:
- Servlet 3.1
-
getSessionTimeout
int getSessionTimeout()Get the default session timeout.- Returns:
- The current default session timeout in minutes
- Since:
- Servlet 4.0
-
setSessionTimeout
void setSessionTimeout(int sessionTimeout) Set the default session timeout. This method may only be called before the ServletContext is initialised.- Parameters:
sessionTimeout
- The new default session timeout in minutes.- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.IllegalStateException
- If the ServletContext has already been initialised- Since:
- Servlet 4.0
-
getRequestCharacterEncoding
String getRequestCharacterEncoding()Get the default character encoding for reading request bodies.- Returns:
- The character encoding name or
null
if no default has been specified - Since:
- Servlet 4.0
-
setRequestCharacterEncoding
Set the default character encoding to use for reading request bodies. Calling this method will over-ride any value set in the deployment descriptor.- Parameters:
encoding
- The name of the character encoding to use- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.IllegalStateException
- If the ServletContext has already been initialised- Since:
- Servlet 4.0
-
getResponseCharacterEncoding
String getResponseCharacterEncoding()Get the default character encoding for writing response bodies.- Returns:
- The character encoding name or
null
if no default has been specified - Since:
- Servlet 4.0
-
setResponseCharacterEncoding
Set the default character encoding to use for writing response bodies. Calling this method will over-ride any value set in the deployment descriptor.- Parameters:
encoding
- The name of the character encoding to use- Throws:
UnsupportedOperationException
- If called from aServletContextListener.contextInitialized(ServletContextEvent)
method of aServletContextListener
that was not defined in a web.xml file, a web-fragment.xml file nor annotated withWebListener
. For example, aServletContextListener
defined in a TLD would not be able to use this method.IllegalStateException
- If the ServletContext has already been initialised- Since:
- Servlet 4.0
-