Class ApplicationContextFacade
- java.lang.Object
-
- org.apache.catalina.core.ApplicationContextFacade
-
- All Implemented Interfaces:
ServletContext
public class ApplicationContextFacade extends java.lang.Object implements ServletContext
Facade object which masks the internalApplicationContext
object from the web application.- Author:
- Remy Maucherat
-
-
Field Summary
-
Fields inherited from interface jakarta.servlet.ServletContext
ORDERED_LIBS, TEMPDIR
-
-
Constructor Summary
Constructors Constructor Description ApplicationContextFacade(ApplicationContext context)
Construct a new instance of this class, associated with the specified Context instance.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description FilterRegistration.Dynamic
addFilter(java.lang.String filterName, Filter filter)
Add filter to context.FilterRegistration.Dynamic
addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)
Add filter to context.FilterRegistration.Dynamic
addFilter(java.lang.String filterName, java.lang.String className)
Add filter to context.ServletRegistration.Dynamic
addJspFile(java.lang.String jspName, java.lang.String jspFile)
void
addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
TODO SERVLET3 - Add commentsvoid
addListener(java.lang.String className)
TODO SERVLET3 - Add comments<T extends java.util.EventListener>
voidaddListener(T t)
TODO SERVLET3 - Add commentsServletRegistration.Dynamic
addServlet(java.lang.String servletName, Servlet servlet)
Register a servlet instance for use in this ServletContext.ServletRegistration.Dynamic
addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)
Add servlet to context.ServletRegistration.Dynamic
addServlet(java.lang.String servletName, java.lang.String className)
Register a servlet implementation for use in this ServletContext.<T extends Filter>
TcreateFilter(java.lang.Class<T> c)
Create a Filter instance using the given class.<T extends java.util.EventListener>
TcreateListener(java.lang.Class<T> c)
TODO SERVLET3 - Add comments<T extends Servlet>
TcreateServlet(java.lang.Class<T> c)
Create an Servlet instance using the given class.void
declareRoles(java.lang.String... roleNames)
Add to the declared roles for this ServletContext.java.lang.Object
getAttribute(java.lang.String name)
Returns the servlet container attribute with the given name, ornull
if there is no attribute by that name.java.util.Enumeration<java.lang.String>
getAttributeNames()
Returns anEnumeration
containing the attribute names available within this servlet context.java.lang.ClassLoader
getClassLoader()
Get the web application class loader associated with this ServletContext.ServletContext
getContext(java.lang.String uripath)
Returns aServletContext
object that corresponds to a specified URL on the server.java.lang.String
getContextPath()
Return the main path associated with this context.java.util.Set<SessionTrackingMode>
getDefaultSessionTrackingModes()
Obtains the default session tracking modes for this web application.int
getEffectiveMajorVersion()
Obtain the major version of the servlet specification for which this web application is implemented.int
getEffectiveMinorVersion()
Obtain the minor version of the servlet specification for which this web application is implemented.java.util.Set<SessionTrackingMode>
getEffectiveSessionTrackingModes()
Obtains the currently enabled session tracking modes for this web application.FilterRegistration
getFilterRegistration(java.lang.String filterName)
TODO SERVLET3 - Add commentsjava.util.Map<java.lang.String,? extends FilterRegistration>
getFilterRegistrations()
java.lang.String
getInitParameter(java.lang.String name)
Returns aString
containing the value of the named context-wide initialization parameter, ornull
if the parameter does not exist.java.util.Enumeration<java.lang.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.JspConfigDescriptor
getJspConfigDescriptor()
int
getMajorVersion()
Returns the major version of the Java Servlet API that this servlet container supports.java.lang.String
getMimeType(java.lang.String file)
Returns the MIME type of the specified file, ornull
if the MIME type is not known.int
getMinorVersion()
Returns the minor version of the Servlet API that this servlet container supports.RequestDispatcher
getNamedDispatcher(java.lang.String name)
Returns aRequestDispatcher
object that acts as a wrapper for the named servlet.java.lang.String
getRealPath(java.lang.String path)
Returns aString
containing the real path for a given virtual path.java.lang.String
getRequestCharacterEncoding()
Get the default character encoding for reading request bodies.RequestDispatcher
getRequestDispatcher(java.lang.String path)
Returns aRequestDispatcher
object that acts as a wrapper for the resource located at the given path.java.net.URL
getResource(java.lang.String path)
Returns a URL to the resource that is mapped to a specified path.java.io.InputStream
getResourceAsStream(java.lang.String path)
Returns the resource located at the named path as anInputStream
object.java.util.Set<java.lang.String>
getResourcePaths(java.lang.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.java.lang.String
getResponseCharacterEncoding()
Get the default character encoding for writing response bodies.java.lang.String
getServerInfo()
Returns the name and version of the servlet container on which the servlet is running.Servlet
getServlet(java.lang.String name)
Deprecated.As of Java Servlet API 2.1, with no direct replacement.java.lang.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.java.util.Enumeration<java.lang.String>
getServletNames()
Deprecated.As of Java Servlet API 2.1, with no direct replacement.ServletRegistration
getServletRegistration(java.lang.String servletName)
Obtain the details of the named servlet.java.util.Map<java.lang.String,? extends ServletRegistration>
getServletRegistrations()
Obtain a Map of servlet names to servlet registrations for all servlets registered with this context.java.util.Enumeration<Servlet>
getServlets()
Deprecated.As of Java Servlet API 2.1, with no direct replacement.SessionCookieConfig
getSessionCookieConfig()
int
getSessionTimeout()
Get the default session timeout.java.lang.String
getVirtualServerName()
Get the primary name of the virtual host on which this context is deployed.void
log(java.lang.Exception exception, java.lang.String msg)
Deprecated.As of Java Servlet API 2.1, uselog(String, Throwable)
insteadvoid
log(java.lang.String msg)
Writes the specified message to a servlet log file, usually an event log.void
log(java.lang.String message, java.lang.Throwable throwable)
Writes an explanatory message and a stack trace for a givenThrowable
exception to the servlet log file.void
removeAttribute(java.lang.String name)
Removes the attribute with the given name from the servlet context.void
setAttribute(java.lang.String name, java.lang.Object object)
Binds an object to a given attribute name in this servlet context.boolean
setInitParameter(java.lang.String name, java.lang.String value)
Set the given initialisation parameter to the given value.void
setRequestCharacterEncoding(java.lang.String encoding)
Set the default character encoding to use for reading request bodies.void
setResponseCharacterEncoding(java.lang.String encoding)
Set the default character encoding to use for writing response bodies.void
setSessionTimeout(int sessionTimeout)
Set the default session timeout.void
setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)
Configures the available session tracking modes for this web application.
-
-
-
Constructor Detail
-
ApplicationContextFacade
public ApplicationContextFacade(ApplicationContext context)
Construct a new instance of this class, associated with the specified Context instance.- Parameters:
context
- The associated Context instance
-
-
Method Detail
-
getContext
public ServletContext getContext(java.lang.String uripath)
Description copied from interface:jakarta.servlet.ServletContext
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.- Specified by:
getContext
in interfaceServletContext
- 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:
RequestDispatcher
-
getMajorVersion
public int getMajorVersion()
Description copied from interface:jakarta.servlet.ServletContext
Returns the major version of the Java Servlet API that this servlet container supports. All implementations that comply with Version 5.0 must have this method return the integer 5.- Specified by:
getMajorVersion
in interfaceServletContext
- Returns:
- 5
-
getMinorVersion
public int getMinorVersion()
Description copied from interface:jakarta.servlet.ServletContext
Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 5.0 must have this method return the integer 0.- Specified by:
getMinorVersion
in interfaceServletContext
- Returns:
- 0
-
getMimeType
public java.lang.String getMimeType(java.lang.String file)
Description copied from interface:jakarta.servlet.ServletContext
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"
.- Specified by:
getMimeType
in interfaceServletContext
- Parameters:
file
- aString
specifying the name of a file- Returns:
- a
String
specifying the file's MIME type
-
getResourcePaths
public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
Description copied from interface:jakarta.servlet.ServletContext
Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are all relative to the root of the web application 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/"}.- Specified by:
getResourcePaths
in interfaceServletContext
- 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.
-
getResource
public java.net.URL getResource(java.lang.String path) throws java.net.MalformedURLException
Description copied from interface:jakarta.servlet.ServletContext
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.- Specified by:
getResource
in interfaceServletContext
- 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:
java.net.MalformedURLException
- if the pathname is not given in the correct form
-
getResourceAsStream
public java.io.InputStream getResourceAsStream(java.lang.String path)
Description copied from interface:jakarta.servlet.ServletContext
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.- Specified by:
getResourceAsStream
in interfaceServletContext
- 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
public RequestDispatcher getRequestDispatcher(java.lang.String path)
Description copied from interface:jakarta.servlet.ServletContext
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
.- Specified by:
getRequestDispatcher
in interfaceServletContext
- 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:
RequestDispatcher
,ServletContext.getContext(java.lang.String)
-
getNamedDispatcher
public RequestDispatcher getNamedDispatcher(java.lang.String name)
Description copied from interface:jakarta.servlet.ServletContext
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.- Specified by:
getNamedDispatcher
in interfaceServletContext
- 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:
RequestDispatcher
,ServletContext.getContext(java.lang.String)
,ServletConfig.getServletName()
-
getServlet
@Deprecated public Servlet getServlet(java.lang.String name) throws ServletException
Deprecated.As of Java Servlet API 2.1, with no direct replacement.Description copied from interface:jakarta.servlet.ServletContext
Do not use. This method was originally defined to retrieve a servlet from aServletContext
. In this version, this method always returnsnull
and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.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.- Specified by:
getServlet
in interfaceServletContext
- Parameters:
name
- Not used- Returns:
- Always
null
- Throws:
ServletException
- never
-
getServlets
@Deprecated public java.util.Enumeration<Servlet> getServlets()
Deprecated.As of Java Servlet API 2.1, with no direct replacement.Description copied from interface:jakarta.servlet.ServletContext
Do not use. This method was originally defined to return anEnumeration
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 the Java Servlet API.- Specified by:
getServlets
in interfaceServletContext
- Returns:
- Always and empty Enumeration
-
getServletNames
@Deprecated public java.util.Enumeration<java.lang.String> getServletNames()
Deprecated.As of Java Servlet API 2.1, with no direct replacement.Description copied from interface:jakarta.servlet.ServletContext
Do not use. This method was originally defined to return anEnumeration
of all the servlet names known to this context. In this version, this method always returns an emptyEnumeration
and remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.- Specified by:
getServletNames
in interfaceServletContext
- Returns:
- Always and empty Enumeration
-
log
public void log(java.lang.String msg)
Description copied from interface:jakarta.servlet.ServletContext
Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container.- Specified by:
log
in interfaceServletContext
- Parameters:
msg
- aString
specifying the message to be written to the log file
-
log
@Deprecated public void log(java.lang.Exception exception, java.lang.String msg)
Deprecated.As of Java Servlet API 2.1, uselog(String, Throwable)
insteadDescription copied from interface:jakarta.servlet.ServletContext
Do not use.- Specified by:
log
in interfaceServletContext
- Parameters:
exception
- The exception to logmsg
- The message to log with the exception
-
log
public void log(java.lang.String message, java.lang.Throwable throwable)
Description copied from interface:jakarta.servlet.ServletContext
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.- Specified by:
log
in interfaceServletContext
- Parameters:
message
- aString
that describes the error or exceptionthrowable
- theThrowable
error or exception
-
getRealPath
public java.lang.String getRealPath(java.lang.String path)
Description copied from interface:jakarta.servlet.ServletContext
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).- Specified by:
getRealPath
in interfaceServletContext
- Parameters:
path
- aString
specifying a virtual path- Returns:
- a
String
specifying the real path, or null if the translation cannot be performed
-
getServerInfo
public java.lang.String getServerInfo()
Description copied from interface:jakarta.servlet.ServletContext
Returns the name and version of the servlet container on which the servlet is running.The form of the returned string is servername/versionnumber. For example, the JavaServer Web Development Kit may return the string
JavaServer Web Dev Kit/1.0
.The servlet container may return other optional information after the primary string in parentheses, for example,
JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86)
.- Specified by:
getServerInfo
in interfaceServletContext
- Returns:
- a
String
containing at least the servlet container name and version number
-
getInitParameter
public java.lang.String getInitParameter(java.lang.String name)
Description copied from interface:jakarta.servlet.ServletContext
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.
- Specified by:
getInitParameter
in interfaceServletContext
- Parameters:
name
- aString
containing the name of the parameter whose value is requested- Returns:
- a
String
containing the value of the initialization parameter - See Also:
ServletConfig.getInitParameter(java.lang.String)
-
getInitParameterNames
public java.util.Enumeration<java.lang.String> getInitParameterNames()
Description copied from interface:jakarta.servlet.ServletContext
Returns the names of the context's initialization parameters as anEnumeration
ofString
objects, or an emptyEnumeration
if the context has no initialization parameters.- Specified by:
getInitParameterNames
in interfaceServletContext
- Returns:
- an
Enumeration
ofString
objects containing the names of the context's initialization parameters - See Also:
ServletConfig.getInitParameter(java.lang.String)
-
getAttribute
public java.lang.Object getAttribute(java.lang.String name)
Description copied from interface:jakarta.servlet.ServletContext
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 Java Servlet API specification reserves names matchingjava.*
,javax.*
, andsun.*
.- Specified by:
getAttribute
in interfaceServletContext
- 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 - See Also:
ServletContext.getAttributeNames()
-
getAttributeNames
public java.util.Enumeration<java.lang.String> getAttributeNames()
Description copied from interface:jakarta.servlet.ServletContext
Returns anEnumeration
containing the attribute names available within this servlet context. Use theServletContext.getAttribute(java.lang.String)
method with an attribute name to get the value of an attribute.- Specified by:
getAttributeNames
in interfaceServletContext
- Returns:
- an
Enumeration
of attribute names - See Also:
ServletContext.getAttribute(java.lang.String)
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.Object object)
Description copied from interface:jakarta.servlet.ServletContext
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 Java Servlet API specification reserves names matching
java.*
,javax.*
, andsun.*
.- Specified by:
setAttribute
in interfaceServletContext
- Parameters:
name
- aString
specifying the name of the attributeobject
- anObject
representing the attribute to be bound
-
removeAttribute
public void removeAttribute(java.lang.String name)
Description copied from interface:jakarta.servlet.ServletContext
Removes the attribute with the given name from the servlet context. After removal, subsequent calls toServletContext.getAttribute(java.lang.String)
to retrieve the attribute's value will returnnull
.If listeners are configured on the
ServletContext
the container notifies them accordingly.- Specified by:
removeAttribute
in interfaceServletContext
- Parameters:
name
- aString
specifying the name of the attribute to be removed
-
getServletContextName
public java.lang.String getServletContextName()
Description copied from interface:jakarta.servlet.ServletContext
Returns the name of this web application corresponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.- Specified by:
getServletContextName
in interfaceServletContext
- Returns:
- The name of the web application or null if no name has been declared in the deployment descriptor.
-
getContextPath
public java.lang.String getContextPath()
Description copied from interface:jakarta.servlet.ServletContext
Return the main path associated with this context.- Specified by:
getContextPath
in interfaceServletContext
- Returns:
- The main context path
-
addFilter
public FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.String className)
Description copied from interface:jakarta.servlet.ServletContext
Add filter to context.- Specified by:
addFilter
in interfaceServletContext
- 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
-
addFilter
public FilterRegistration.Dynamic addFilter(java.lang.String filterName, Filter filter)
Description copied from interface:jakarta.servlet.ServletContext
Add filter to context.- Specified by:
addFilter
in interfaceServletContext
- 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
-
addFilter
public FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)
Description copied from interface:jakarta.servlet.ServletContext
Add filter to context.- Specified by:
addFilter
in interfaceServletContext
- 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
-
createFilter
public <T extends Filter> T createFilter(java.lang.Class<T> c) throws ServletException
Description copied from interface:jakarta.servlet.ServletContext
Create a Filter instance using the given class. The instance is just created. No initialisation occurs.- Specified by:
createFilter
in interfaceServletContext
- 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 created
-
getFilterRegistration
public FilterRegistration getFilterRegistration(java.lang.String filterName)
Description copied from interface:jakarta.servlet.ServletContext
TODO SERVLET3 - Add comments- Specified by:
getFilterRegistration
in interfaceServletContext
- Parameters:
filterName
- TODO- Returns:
- TODO
-
addServlet
public ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.String className)
Description copied from interface:jakarta.servlet.ServletContext
Register a servlet implementation for use in this ServletContext.- Specified by:
addServlet
in interfaceServletContext
- Parameters:
servletName
- The name of the servlet to registerclassName
- The implementation class for the servlet- Returns:
- The registration object that enables further configuration
-
addServlet
public ServletRegistration.Dynamic addServlet(java.lang.String servletName, Servlet servlet)
Description copied from interface:jakarta.servlet.ServletContext
Register a servlet instance for use in this ServletContext.- Specified by:
addServlet
in interfaceServletContext
- Parameters:
servletName
- The name of the servlet to registerservlet
- The Servlet instance to register- Returns:
- The registration object that enables further configuration
-
addServlet
public ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)
Description copied from interface:jakarta.servlet.ServletContext
Add servlet to context.- Specified by:
addServlet
in interfaceServletContext
- 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
-
addJspFile
public ServletRegistration.Dynamic addJspFile(java.lang.String jspName, java.lang.String jspFile)
- Specified by:
addJspFile
in interfaceServletContext
- 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
-
createServlet
public <T extends Servlet> T createServlet(java.lang.Class<T> c) throws ServletException
Description copied from interface:jakarta.servlet.ServletContext
Create an Servlet instance using the given class. The instance is just created. No initialisation occurs.- Specified by:
createServlet
in interfaceServletContext
- 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.
-
getServletRegistration
public ServletRegistration getServletRegistration(java.lang.String servletName)
Description copied from interface:jakarta.servlet.ServletContext
Obtain the details of the named servlet.- Specified by:
getServletRegistration
in interfaceServletContext
- 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
-
getDefaultSessionTrackingModes
public java.util.Set<SessionTrackingMode> getDefaultSessionTrackingModes()
Description copied from interface:jakarta.servlet.ServletContext
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
.- Specified by:
getDefaultSessionTrackingModes
in interfaceServletContext
- Returns:
- The set of default session tracking modes for this web application
-
getEffectiveSessionTrackingModes
public java.util.Set<SessionTrackingMode> getEffectiveSessionTrackingModes()
Description copied from interface:jakarta.servlet.ServletContext
Obtains the currently enabled session tracking modes for this web application.- Specified by:
getEffectiveSessionTrackingModes
in interfaceServletContext
- Returns:
- The value supplied via
ServletContext.setSessionTrackingModes(Set)
if one was previously set, else return the defaults
-
getSessionCookieConfig
public SessionCookieConfig getSessionCookieConfig()
- Specified by:
getSessionCookieConfig
in interfaceServletContext
- Returns:
- TODO
-
setSessionTrackingModes
public void setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)
Description copied from interface:jakarta.servlet.ServletContext
Configures the available session tracking modes for this web application.- Specified by:
setSessionTrackingModes
in interfaceServletContext
- Parameters:
sessionTrackingModes
- The session tracking modes to use for this web application
-
setInitParameter
public boolean setInitParameter(java.lang.String name, java.lang.String value)
Description copied from interface:jakarta.servlet.ServletContext
Set the given initialisation parameter to the given value.- Specified by:
setInitParameter
in interfaceServletContext
- 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
-
addListener
public void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
Description copied from interface:jakarta.servlet.ServletContext
TODO SERVLET3 - Add comments- Specified by:
addListener
in interfaceServletContext
- Parameters:
listenerClass
- TODO
-
addListener
public void addListener(java.lang.String className)
Description copied from interface:jakarta.servlet.ServletContext
TODO SERVLET3 - Add comments- Specified by:
addListener
in interfaceServletContext
- Parameters:
className
- TODO
-
addListener
public <T extends java.util.EventListener> void addListener(T t)
Description copied from interface:jakarta.servlet.ServletContext
TODO SERVLET3 - Add comments- Specified by:
addListener
in interfaceServletContext
- Type Parameters:
T
- TODO- Parameters:
t
- TODO
-
createListener
public <T extends java.util.EventListener> T createListener(java.lang.Class<T> c) throws ServletException
Description copied from interface:jakarta.servlet.ServletContext
TODO SERVLET3 - Add comments- Specified by:
createListener
in interfaceServletContext
- Type Parameters:
T
- TODO- Parameters:
c
- TODO- Returns:
- TODO
- Throws:
ServletException
- TODO
-
declareRoles
public void declareRoles(java.lang.String... roleNames)
Description copied from interface:jakarta.servlet.ServletContext
Add to the declared roles for this ServletContext.- Specified by:
declareRoles
in interfaceServletContext
- Parameters:
roleNames
- The roles to add
-
getClassLoader
public java.lang.ClassLoader getClassLoader()
Description copied from interface:jakarta.servlet.ServletContext
Get the web application class loader associated with this ServletContext.- Specified by:
getClassLoader
in interfaceServletContext
- Returns:
- The associated web application class loader
-
getEffectiveMajorVersion
public int getEffectiveMajorVersion()
Description copied from interface:jakarta.servlet.ServletContext
Obtain the major version of the servlet specification for which this web application is implemented.- Specified by:
getEffectiveMajorVersion
in interfaceServletContext
- Returns:
- The major version declared in web.xml
-
getEffectiveMinorVersion
public int getEffectiveMinorVersion()
Description copied from interface:jakarta.servlet.ServletContext
Obtain the minor version of the servlet specification for which this web application is implemented.- Specified by:
getEffectiveMinorVersion
in interfaceServletContext
- Returns:
- The minor version declared in web.xml
-
getFilterRegistrations
public java.util.Map<java.lang.String,? extends FilterRegistration> getFilterRegistrations()
- Specified by:
getFilterRegistrations
in interfaceServletContext
- Returns:
- TODO
-
getJspConfigDescriptor
public JspConfigDescriptor getJspConfigDescriptor()
- Specified by:
getJspConfigDescriptor
in interfaceServletContext
- Returns:
- TODO
-
getServletRegistrations
public java.util.Map<java.lang.String,? extends ServletRegistration> getServletRegistrations()
Description copied from interface:jakarta.servlet.ServletContext
Obtain a Map of servlet names to servlet registrations for all servlets registered with this context.- Specified by:
getServletRegistrations
in interfaceServletContext
- Returns:
- A Map of servlet names to servlet registrations for all servlets registered with this context
-
getVirtualServerName
public java.lang.String getVirtualServerName()
Description copied from interface:jakarta.servlet.ServletContext
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.- Specified by:
getVirtualServerName
in interfaceServletContext
- Returns:
- The primary name of the virtual host on which this context is deployed
-
getSessionTimeout
public int getSessionTimeout()
Description copied from interface:jakarta.servlet.ServletContext
Get the default session timeout.- Specified by:
getSessionTimeout
in interfaceServletContext
- Returns:
- The current default session timeout in minutes
-
setSessionTimeout
public void setSessionTimeout(int sessionTimeout)
Description copied from interface:jakarta.servlet.ServletContext
Set the default session timeout. This method may only be called before the ServletContext is initialised.- Specified by:
setSessionTimeout
in interfaceServletContext
- Parameters:
sessionTimeout
- The new default session timeout in minutes.
-
getRequestCharacterEncoding
public java.lang.String getRequestCharacterEncoding()
Description copied from interface:jakarta.servlet.ServletContext
Get the default character encoding for reading request bodies.- Specified by:
getRequestCharacterEncoding
in interfaceServletContext
- Returns:
- The character encoding name or
null
if no default has been specified
-
setRequestCharacterEncoding
public void setRequestCharacterEncoding(java.lang.String encoding)
Description copied from interface:jakarta.servlet.ServletContext
Set the default character encoding to use for reading request bodies. Calling this method will over-ride any value set in the deployment descriptor.- Specified by:
setRequestCharacterEncoding
in interfaceServletContext
- Parameters:
encoding
- The name of the character encoding to use
-
getResponseCharacterEncoding
public java.lang.String getResponseCharacterEncoding()
Description copied from interface:jakarta.servlet.ServletContext
Get the default character encoding for writing response bodies.- Specified by:
getResponseCharacterEncoding
in interfaceServletContext
- Returns:
- The character encoding name or
null
if no default has been specified
-
setResponseCharacterEncoding
public void setResponseCharacterEncoding(java.lang.String encoding)
Description copied from interface:jakarta.servlet.ServletContext
Set the default character encoding to use for writing response bodies. Calling this method will over-ride any value set in the deployment descriptor.- Specified by:
setResponseCharacterEncoding
in interfaceServletContext
- Parameters:
encoding
- The name of the character encoding to use
-
-