Interface ServletContext
- 
 public interface ServletContextDefines a set of methods that a servlet uses to communicate with its servlet container, for example, to get the MIME type of a file, dispatch requests, or write to a log file.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 /catalogand possibly installed via a.warfile.)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 ServletContextobject is contained within theServletConfigobject, which the Web server provides the servlet when the servlet is initialized.
- 
- 
Field SummaryFields Modifier and Type Field Description static java.lang.StringORDERED_LIBSThe name of the ServletContext attribute that holds the ordered list of web fragments for this web application.static java.lang.StringTEMPDIRThe name of the ServletContext attribute that holds the temporary file location for the web application.
 - 
Method SummaryAll Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description FilterRegistration.DynamicaddFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)Add filter to context.FilterRegistration.DynamicaddFilter(java.lang.String filterName, java.lang.String className)Add filter to context.FilterRegistration.DynamicaddFilter(java.lang.String filterName, Filter filter)Add filter to context.voidaddListener(java.lang.Class<? extends java.util.EventListener> listenerClass)TODO SERVLET3 - Add commentsvoidaddListener(java.lang.String className)TODO SERVLET3 - Add comments<T extends java.util.EventListener>
 voidaddListener(T t)TODO SERVLET3 - Add commentsServletRegistration.DynamicaddServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)Add servlet to context.ServletRegistration.DynamicaddServlet(java.lang.String servletName, java.lang.String className)Register a servlet implementation for use in this ServletContext.ServletRegistration.DynamicaddServlet(java.lang.String servletName, Servlet servlet)Register a servlet instance 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.voiddeclareRoles(java.lang.String... roleNames)Add to the declared roles for this ServletContext.java.lang.ObjectgetAttribute(java.lang.String name)Returns the servlet container attribute with the given name, ornullif there is no attribute by that name.java.util.Enumeration<java.lang.String>getAttributeNames()Returns anEnumerationcontaining the attribute names available within this servlet context.java.lang.ClassLoadergetClassLoader()Get the web application class loader associated with this ServletContext.ServletContextgetContext(java.lang.String uripath)Returns aServletContextobject that corresponds to a specified URL on the server.java.lang.StringgetContextPath()Return the main path associated with this context.java.util.Set<SessionTrackingMode>getDefaultSessionTrackingModes()Obtains the default session tracking modes for this web application.intgetEffectiveMajorVersion()Obtain the major version of the servlet specification for which this web application is implemented.intgetEffectiveMinorVersion()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.FilterRegistrationgetFilterRegistration(java.lang.String filterName)TODO SERVLET3 - Add commentsjava.util.Map<java.lang.String,? extends FilterRegistration>getFilterRegistrations()java.lang.StringgetInitParameter(java.lang.String name)Returns aStringcontaining the value of the named context-wide initialization parameter, ornullif the parameter does not exist.java.util.Enumeration<java.lang.String>getInitParameterNames()Returns the names of the context's initialization parameters as anEnumerationofStringobjects, or an emptyEnumerationif the context has no initialization parameters.JspConfigDescriptorgetJspConfigDescriptor()intgetMajorVersion()Returns the major version of the Java Servlet API that this servlet container supports.java.lang.StringgetMimeType(java.lang.String file)Returns the MIME type of the specified file, ornullif the MIME type is not known.intgetMinorVersion()Returns the minor version of the Servlet API that this servlet container supports.RequestDispatchergetNamedDispatcher(java.lang.String name)Returns aRequestDispatcherobject that acts as a wrapper for the named servlet.java.lang.StringgetRealPath(java.lang.String path)Returns aStringcontaining the real path for a given virtual path.RequestDispatchergetRequestDispatcher(java.lang.String path)Returns aRequestDispatcherobject that acts as a wrapper for the resource located at the given path.java.net.URLgetResource(java.lang.String path)Returns a URL to the resource that is mapped to a specified path.java.io.InputStreamgetResourceAsStream(java.lang.String path)Returns the resource located at the named path as anInputStreamobject.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.StringgetServerInfo()Returns the name and version of the servlet container on which the servlet is running.ServletgetServlet(java.lang.String name)Deprecated.As of Java Servlet API 2.1, with no direct replacement.java.lang.StringgetServletContextName()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 replacement.ServletRegistrationgetServletRegistration(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.0, with no replacement.SessionCookieConfiggetSessionCookieConfig()java.lang.StringgetVirtualServerName()Get the primary name of the virtual host on which this context is deployed.voidlog(java.lang.Exception exception, java.lang.String msg)Deprecated.As of Java Servlet API 2.1, uselog(String message, Throwable throwable)instead.voidlog(java.lang.String msg)Writes the specified message to a servlet log file, usually an event log.voidlog(java.lang.String message, java.lang.Throwable throwable)Writes an explanatory message and a stack trace for a givenThrowableexception to the servlet log file.voidremoveAttribute(java.lang.String name)Removes the attribute with the given name from the servlet context.voidsetAttribute(java.lang.String name, java.lang.Object object)Binds an object to a given attribute name in this servlet context.booleansetInitParameter(java.lang.String name, java.lang.String value)Set the given initialisation parameter to the given value.voidsetSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)Configures the available session tracking modes for this web application.
 
- 
- 
- 
Field Detail- 
TEMPDIRstatic final java.lang.String TEMPDIR The name of the ServletContext attribute that holds the temporary file location for the web application.- See Also:
- Constant Field Values
 
 - 
ORDERED_LIBSstatic final java.lang.String 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:
- Constant Field Values
 
 
- 
 - 
Method Detail- 
getContextPathjava.lang.String getContextPath() Return the main path associated with this context.- Returns:
- The main context path
- Since:
- Servlet 2.5
 
 - 
getContextServletContext getContext(java.lang.String uripath) Returns aServletContextobject 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 RequestDispatcherobjects 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 nullfor a given URL.- Parameters:
- uripath- a- Stringspecifying the context path of another web application in the container.
- Returns:
- the ServletContextobject that corresponds to the named URL, or null if either none exists or the container wishes to restrict this access.
- See Also:
- RequestDispatcher
 
 - 
getMajorVersionint getMajorVersion() Returns the major version of the Java Servlet API that this servlet container supports. All implementations that comply with Version 3.1 must have this method return the integer 3.- Returns:
- 3
 
 - 
getMinorVersionint getMinorVersion() Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 3.1 must have this method return the integer 1.- Returns:
- 1
 
 - 
getEffectiveMajorVersionint getEffectiveMajorVersion() Obtain the major version of the servlet specification for which this web application is implemented.- Returns:
- The major version declared in web.xml
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
getEffectiveMinorVersionint getEffectiveMinorVersion() Obtain the minor version of the servlet specification for which this web application is implemented.- Returns:
- The minor version declared in web.xml
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
getMimeTypejava.lang.String getMimeType(java.lang.String file) Returns the MIME type of the specified file, ornullif 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- a- Stringspecifying the name of a file
- Returns:
- a Stringspecifying the file's MIME type
 
 - 
getResourcePathsjava.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. 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
 
 - 
getResourcejava.net.URL getResource(java.lang.String path) throws java.net.MalformedURLExceptionReturns 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 .warfile.The servlet container must implement the URL handlers and URLConnectionobjects that are necessary to access the resource.This method returns nullif 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 .jsppage returns the JSP source code. Use aRequestDispatcherinstead 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- a- Stringspecifying the path to the resource
- Returns:
- the resource located at the named path, or nullif there is no resource at that path
- Throws:
- java.net.MalformedURLException- if the pathname is not given in the correct form
 
 - 
getResourceAsStreamjava.io.InputStream getResourceAsStream(java.lang.String path) Returns the resource located at the named path as anInputStreamobject.The data in the InputStreamcan be of any type or length. The path must be specified according to the rules given ingetResource. This method returnsnullif no resource exists at the specified path.Meta-information such as content length and content type that is available via getResourcemethod is lost when using this method.The servlet container must implement the URL handlers and URLConnectionobjects 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- a- Stringspecifying the path to the resource
- Returns:
- the InputStreamreturned to the servlet, ornullif no resource exists at the specified path
 
 - 
getRequestDispatcherRequestDispatcher getRequestDispatcher(java.lang.String path) Returns aRequestDispatcherobject that acts as a wrapper for the resource located at the given path. ARequestDispatcherobject 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 getContextto obtain aRequestDispatcherfor resources in foreign contexts. This method returnsnullif theServletContextcannot return aRequestDispatcher.- Parameters:
- path- a- Stringspecifying the pathname to the resource
- Returns:
- a RequestDispatcherobject that acts as a wrapper for the resource at the specified path, ornullif theServletContextcannot return aRequestDispatcher
- See Also:
- RequestDispatcher,- getContext(java.lang.String)
 
 - 
getNamedDispatcherRequestDispatcher getNamedDispatcher(java.lang.String name) Returns aRequestDispatcherobject 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 nullif theServletContextcannot return aRequestDispatcherfor any reason.- Parameters:
- name- a- Stringspecifying the name of a servlet to wrap
- Returns:
- a RequestDispatcherobject that acts as a wrapper for the named servlet, ornullif theServletContextcannot return aRequestDispatcher
- See Also:
- RequestDispatcher,- getContext(java.lang.String),- ServletConfig.getServletName()
 
 - 
getServletServlet getServlet(java.lang.String name) throws ServletException Deprecated.As of Java Servlet API 2.1, with no direct replacement.Do not use. This method was originally defined to retrieve a servlet from aServletContext. In this version, this method always returnsnulland 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 ServletContextclass and can perform shared business logic by invoking methods on common non-servlet classes.- Parameters:
- name- Not used
- Returns:
- Always null
- Throws:
- ServletException- never
 
 - 
getServletsjava.util.Enumeration<Servlet> getServlets() Deprecated.As of Java Servlet API 2.0, with no replacement.Do not use. This method was originally defined to return anEnumerationof 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.- Returns:
- Always and empty Enumeration
 
 - 
getServletNamesjava.util.Enumeration<java.lang.String> getServletNames() Deprecated.As of Java Servlet API 2.1, with no replacement.Do not use. This method was originally defined to return anEnumerationof all the servlet names known to this context. In this version, this method always returns an emptyEnumerationand remains only to preserve binary compatibility. This method will be permanently removed in a future version of the Java Servlet API.- Returns:
- Always and empty Enumeration
 
 - 
logvoid log(java.lang.String msg) 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- a- Stringspecifying the message to be written to the log file
 
 - 
logvoid log(java.lang.Exception exception, java.lang.String msg)Deprecated.As of Java Servlet API 2.1, uselog(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. Do not use.- Parameters:
- exception- The exception to log
- msg- The message to log with the exception
 
 - 
logvoid log(java.lang.String message, java.lang.Throwable throwable)Writes an explanatory message and a stack trace for a givenThrowableexception 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- a- Stringthat describes the error or exception
- throwable- the- Throwableerror or exception
 
 - 
getRealPathjava.lang.String getRealPath(java.lang.String path) Returns aStringcontaining 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 nullif 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.wararchive).- Parameters:
- path- a- Stringspecifying a virtual path
- Returns:
- a Stringspecifying the real path, or null if the translation cannot be performed
 
 - 
getServerInfojava.lang.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 Stringcontaining at least the servlet container name and version number
 
 - 
getInitParameterjava.lang.String getInitParameter(java.lang.String name) Returns aStringcontaining the value of the named context-wide initialization parameter, ornullif 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- a- Stringcontaining the name of the parameter whose value is requested
- Returns:
- a Stringcontaining the value of the initialization parameter
- Throws:
- java.lang.NullPointerException- If the provided parameter name is- null
- See Also:
- ServletConfig.getInitParameter(java.lang.String)
 
 - 
getInitParameterNamesjava.util.Enumeration<java.lang.String> getInitParameterNames() Returns the names of the context's initialization parameters as anEnumerationofStringobjects, or an emptyEnumerationif the context has no initialization parameters.- Returns:
- an EnumerationofStringobjects containing the names of the context's initialization parameters
- See Also:
- ServletConfig.getInitParameter(java.lang.String)
 
 - 
setInitParameterboolean setInitParameter(java.lang.String name, java.lang.String value)Set the given initialisation parameter to the given value.- Parameters:
- name- Name of initialisation parameter
- value- Value for initialisation parameter
- Returns:
- trueif the call succeeds or- falseif the call fails because an initialisation parameter with the same name has already been set
- Throws:
- java.lang.IllegalStateException- If initialisation of this ServletContext has already completed
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- java.lang.NullPointerException- If the provided parameter name is- null
- Since:
- Servlet 3.0
 
 - 
getAttributejava.lang.Object getAttribute(java.lang.String name) Returns the servlet container attribute with the given name, ornullif 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.Objector some subclass. Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matchingjava.*,javax.*, andsun.*.- Parameters:
- name- a- Stringspecifying the name of the attribute
- Returns:
- an Objectcontaining the value of the attribute, ornullif no attribute exists matching the given name
- Throws:
- java.lang.NullPointerException- If the provided attribute name is- null
- See Also:
- getAttributeNames()
 
 - 
getAttributeNamesjava.util.Enumeration<java.lang.String> getAttributeNames() Returns anEnumerationcontaining 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 Enumerationof attribute names
- See Also:
- getAttribute(java.lang.String)
 
 - 
setAttributevoid setAttribute(java.lang.String name, java.lang.Object object)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 ServletContextthe 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.*.- Parameters:
- name- a- Stringspecifying the name of the attribute
- object- an- Objectrepresenting the attribute to be bound
- Throws:
- java.lang.NullPointerException- If the provided attribute name is- null
 
 - 
removeAttributevoid removeAttribute(java.lang.String name) 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 ServletContextthe container notifies them accordingly.- Parameters:
- name- a- Stringspecifying the name of the attribute to be removed
 
 - 
getServletContextNamejava.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.- Returns:
- The name of the web application or null if no name has been declared in the deployment descriptor.
- Since:
- Servlet 2.3
 
 - 
addServletServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.String className) Register a servlet implementation for use in this ServletContext.- Parameters:
- servletName- The name of the servlet to register
- className- The implementation class for the servlet
- Returns:
- The registration object that enables further configuration
- Throws:
- java.lang.IllegalStateException- If the context has already been initialised
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
addServletServletRegistration.Dynamic addServlet(java.lang.String servletName, Servlet servlet) Register a servlet instance for use in this ServletContext.- Parameters:
- servletName- The name of the servlet to register
- servlet- The Servlet instance to register
- Returns:
- The registration object that enables further configuration
- Throws:
- java.lang.IllegalStateException- If the context has already been initialised
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
addServletServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass) Add servlet to context.- Parameters:
- servletName- Name of servlet to add
- servletClass- Class of servlet to add
- Returns:
- nullif the servlet has already been fully defined, else a- ServletRegistration.Dynamicobject that can be used to further configure the servlet
- Throws:
- java.lang.IllegalStateException- If the context has already been initialised
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
createServlet<T extends Servlet> T createServlet(java.lang.Class<T> c) throws ServletException 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.
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
getServletRegistrationServletRegistration getServletRegistration(java.lang.String servletName) 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
          nullif no Servlet has been registered with the given name
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
getServletRegistrationsjava.util.Map<java.lang.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:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
addFilterFilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.String className) Add filter to context.- Parameters:
- filterName- Name of filter to add
- className- Name of filter class
- Returns:
- nullif the filter has already been fully defined, else a- FilterRegistration.Dynamicobject that can be used to further configure the filter
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- java.lang.IllegalStateException- If the context has already been initialised
- Since:
- Servlet 3.0
 
 - 
addFilterFilterRegistration.Dynamic addFilter(java.lang.String filterName, Filter filter) Add filter to context.- Parameters:
- filterName- Name of filter to add
- filter- Filter to add
- Returns:
- nullif the filter has already been fully defined, else a- FilterRegistration.Dynamicobject that can be used to further configure the filter
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- java.lang.IllegalStateException- If the context has already been initialised
- Since:
- Servlet 3.0
 
 - 
addFilterFilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass) Add filter to context.- Parameters:
- filterName- Name of filter to add
- filterClass- Class of filter to add
- Returns:
- nullif the filter has already been fully defined, else a- FilterRegistration.Dynamicobject that can be used to further configure the filter
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- java.lang.IllegalStateException- If the context has already been initialised
- Since:
- Servlet 3.0
 
 - 
createFilter<T extends Filter> T createFilter(java.lang.Class<T> c) throws ServletException 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 created
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
getFilterRegistrationFilterRegistration getFilterRegistration(java.lang.String filterName) TODO SERVLET3 - Add comments- Parameters:
- filterName- TODO
- Returns:
- TODO
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
getFilterRegistrationsjava.util.Map<java.lang.String,? extends FilterRegistration> getFilterRegistrations() - Returns:
- TODO
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0 TODO SERVLET3 - Add comments
 
 - 
getSessionCookieConfigSessionCookieConfig getSessionCookieConfig() - Returns:
- TODO
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0 TODO SERVLET3 - Add comments
 
 - 
setSessionTrackingModesvoid setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes) Configures the available session tracking modes for this web application.- Parameters:
- sessionTrackingModes- The session tracking modes to use for this web application
- Throws:
- java.lang.IllegalArgumentException- If sessionTrackingModes specifies- SessionTrackingMode.SSLin combination with any other- SessionTrackingMode
- java.lang.IllegalStateException- If the context has already been initialised
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
getDefaultSessionTrackingModesjava.util.Set<SessionTrackingMode> getDefaultSessionTrackingModes() Obtains the default session tracking modes for this web application. By defaultSessionTrackingMode.URLis always supported,SessionTrackingMode.COOKIEis supported unless thecookiesattribute has been set tofalsefor the context andSessionTrackingMode.SSLis supported if at least one of the connectors used by this context has the attributesecureset totrue.- Returns:
- The set of default session tracking modes for this web application
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
getEffectiveSessionTrackingModesjava.util.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
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
addListenervoid addListener(java.lang.String className) TODO SERVLET3 - Add comments- Parameters:
- className- TODO
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
addListener<T extends java.util.EventListener> void addListener(T t) TODO SERVLET3 - Add comments- Type Parameters:
- T- TODO
- Parameters:
- t- TODO
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
addListenervoid addListener(java.lang.Class<? extends java.util.EventListener> listenerClass) TODO SERVLET3 - Add comments- Parameters:
- listenerClass- TODO
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
createListener<T extends java.util.EventListener> T createListener(java.lang.Class<T> c) throws ServletExceptionTODO SERVLET3 - Add comments- Type Parameters:
- T- TODO
- Parameters:
- c- TODO
- Returns:
- TODO
- Throws:
- ServletException- TODO
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0
 
 - 
getJspConfigDescriptorJspConfigDescriptor getJspConfigDescriptor() - Returns:
- TODO
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- Since:
- Servlet 3.0 TODO SERVLET3 - Add comments
 
 - 
getClassLoaderjava.lang.ClassLoader getClassLoader() Get the web application class loader associated with this ServletContext.- Returns:
- The associated web application class loader
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- java.lang.SecurityException- if access to the class loader is prevented by a SecurityManager
- Since:
- Servlet 3.0
 
 - 
declareRolesvoid declareRoles(java.lang.String... roleNames) Add to the declared roles for this ServletContext.- Parameters:
- roleNames- The roles to add
- Throws:
- java.lang.UnsupportedOperationException- If called from a- ServletContextListener.contextInitialized(ServletContextEvent)method of a- ServletContextListenerthat was not defined in a web.xml file, a web-fragment.xml file nor annotated with- WebListener. For example, a- ServletContextListenerdefined in a TLD would not be able to use this method.
- java.lang.IllegalArgumentException- If the list of roleNames is null or empty
- java.lang.IllegalStateException- If the ServletContext has already been initialised
- Since:
- Servlet 3.0
 
 - 
getVirtualServerNamejava.lang.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
 
 
- 
 
-