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 internalApplicationContextobject from the web application.- Author:
- Remy Maucherat
 
- 
- 
Field Summary- 
Fields inherited from interface javax.servlet.ServletContextORDERED_LIBS, TEMPDIR
 
- 
 - 
Constructor SummaryConstructors Constructor Description ApplicationContextFacade(ApplicationContext context)Construct a new instance of this class, associated with the specified Context instance.
 - 
Method SummaryAll Methods Instance Methods Concrete 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.ServletRegistration.DynamicaddJspFile(java.lang.String jspName, java.lang.String jspFile)Add a JSP to the 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 the 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.java.lang.StringgetRequestCharacterEncoding()Get the default character encoding for reading request bodies.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.StringgetResponseCharacterEncoding()Get the default character encoding for writing response bodies.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 direct 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.1, with no direct replacement.SessionCookieConfiggetSessionCookieConfig()intgetSessionTimeout()Get the default session timeout.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, Throwable)insteadvoidlog(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.voidsetRequestCharacterEncoding(java.lang.String encoding)Set the default character encoding to use for reading request bodies.voidsetResponseCharacterEncoding(java.lang.String encoding)Set the default character encoding to use for writing response bodies.voidsetSessionTimeout(int sessionTimeout)Set the default session timeout.voidsetSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)Configures the available session tracking modes for this web application.
 
- 
- 
- 
Constructor Detail- 
ApplicationContextFacadepublic ApplicationContextFacade(ApplicationContext context) Construct a new instance of this class, associated with the specified Context instance.- Parameters:
- context- The associated Context instance
 
 
- 
 - 
Method Detail- 
getContextpublic ServletContext getContext(java.lang.String uripath) Description copied from interface:javax.servlet.ServletContextReturns 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.- Specified by:
- getContextin interface- ServletContext
- 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
 
 - 
getMajorVersionpublic int getMajorVersion() Description copied from interface:javax.servlet.ServletContextReturns the major version of the Java Servlet API that this servlet container supports. All implementations that comply with Version 4.0 must have this method return the integer 4.- Specified by:
- getMajorVersionin interface- ServletContext
- Returns:
- 4
 
 - 
getMinorVersionpublic int getMinorVersion() Description copied from interface:javax.servlet.ServletContextReturns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 4.0 must have this method return the integer 0.- Specified by:
- getMinorVersionin interface- ServletContext
- Returns:
- 0
 
 - 
getMimeTypepublic java.lang.String getMimeType(java.lang.String file) Description copied from interface:javax.servlet.ServletContextReturns 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".- Specified by:
- getMimeTypein interface- ServletContext
- Parameters:
- file- a- Stringspecifying the name of a file
- Returns:
- a Stringspecifying the file's MIME type
 
 - 
getResourcePathspublic java.util.Set<java.lang.String> getResourcePaths(java.lang.String path) Description copied from interface:javax.servlet.ServletContextReturns 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:
- getResourcePathsin interface- ServletContext
- 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.
 
 - 
getResourcepublic java.net.URL getResource(java.lang.String path) throws java.net.MalformedURLExceptionDescription copied from interface:javax.servlet.ServletContextReturns 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.- Specified by:
- getResourcein interface- ServletContext
- 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
 
 - 
getResourceAsStreampublic java.io.InputStream getResourceAsStream(java.lang.String path) Description copied from interface:javax.servlet.ServletContextReturns 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.- Specified by:
- getResourceAsStreamin interface- ServletContext
- Parameters:
- path- a- Stringspecifying the path to the resource
- Returns:
- the InputStreamreturned to the servlet, ornullif no resource exists at the specified path
 
 - 
getRequestDispatcherpublic RequestDispatcher getRequestDispatcher(java.lang.String path) Description copied from interface:javax.servlet.ServletContextReturns 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.- Specified by:
- getRequestDispatcherin interface- ServletContext
- 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,- ServletContext.getContext(java.lang.String)
 
 - 
getNamedDispatcherpublic RequestDispatcher getNamedDispatcher(java.lang.String name) Description copied from interface:javax.servlet.ServletContextReturns 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.- Specified by:
- getNamedDispatcherin interface- ServletContext
- 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,- 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:javax.servlet.ServletContextDo 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.- Specified by:
- getServletin interface- ServletContext
- 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:javax.servlet.ServletContextDo 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.- Specified by:
- getServletsin interface- ServletContext
- 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:javax.servlet.ServletContextDo 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.- Specified by:
- getServletNamesin interface- ServletContext
- Returns:
- Always and empty Enumeration
 
 - 
logpublic void log(java.lang.String msg) Description copied from interface:javax.servlet.ServletContextWrites 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:
- login interface- ServletContext
- Parameters:
- msg- a- Stringspecifying 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:javax.servlet.ServletContextDo not use.- Specified by:
- login interface- ServletContext
- Parameters:
- exception- The exception to log
- msg- The message to log with the exception
 
 - 
logpublic void log(java.lang.String message, java.lang.Throwable throwable)Description copied from interface:javax.servlet.ServletContextWrites 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.- Specified by:
- login interface- ServletContext
- Parameters:
- message- a- Stringthat describes the error or exception
- throwable- the- Throwableerror or exception
 
 - 
getRealPathpublic java.lang.String getRealPath(java.lang.String path) Description copied from interface:javax.servlet.ServletContextReturns 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).- Specified by:
- getRealPathin interface- ServletContext
- Parameters:
- path- a- Stringspecifying a virtual path
- Returns:
- a Stringspecifying the real path, or null if the translation cannot be performed
 
 - 
getServerInfopublic java.lang.String getServerInfo() Description copied from interface:javax.servlet.ServletContextReturns 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:
- getServerInfoin interface- ServletContext
- Returns:
- a Stringcontaining at least the servlet container name and version number
 
 - 
getInitParameterpublic java.lang.String getInitParameter(java.lang.String name) Description copied from interface:javax.servlet.ServletContextReturns 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. - Specified by:
- getInitParameterin interface- ServletContext
- Parameters:
- name- a- Stringcontaining the name of the parameter whose value is requested
- Returns:
- a Stringcontaining the value of the initialization parameter
- See Also:
- ServletConfig.getInitParameter(java.lang.String)
 
 - 
getInitParameterNamespublic java.util.Enumeration<java.lang.String> getInitParameterNames() Description copied from interface:javax.servlet.ServletContextReturns the names of the context's initialization parameters as anEnumerationofStringobjects, or an emptyEnumerationif the context has no initialization parameters.- Specified by:
- getInitParameterNamesin interface- ServletContext
- Returns:
- an EnumerationofStringobjects containing the names of the context's initialization parameters
- See Also:
- ServletConfig.getInitParameter(java.lang.String)
 
 - 
getAttributepublic java.lang.Object getAttribute(java.lang.String name) Description copied from interface:javax.servlet.ServletContextReturns 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.*.- Specified by:
- getAttributein interface- ServletContext
- 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
- See Also:
- ServletContext.getAttributeNames()
 
 - 
getAttributeNamespublic java.util.Enumeration<java.lang.String> getAttributeNames() Description copied from interface:javax.servlet.ServletContextReturns anEnumerationcontaining 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:
- getAttributeNamesin interface- ServletContext
- Returns:
- an Enumerationof attribute names
- See Also:
- ServletContext.getAttribute(java.lang.String)
 
 - 
setAttributepublic void setAttribute(java.lang.String name, java.lang.Object object)Description copied from interface:javax.servlet.ServletContextBinds 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.*.- Specified by:
- setAttributein interface- ServletContext
- Parameters:
- name- a- Stringspecifying the name of the attribute
- object- an- Objectrepresenting the attribute to be bound
 
 - 
removeAttributepublic void removeAttribute(java.lang.String name) Description copied from interface:javax.servlet.ServletContextRemoves 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 ServletContextthe container notifies them accordingly.- Specified by:
- removeAttributein interface- ServletContext
- Parameters:
- name- a- Stringspecifying the name of the attribute to be removed
 
 - 
getServletContextNamepublic java.lang.String getServletContextName() Description copied from interface:javax.servlet.ServletContextReturns 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:
- getServletContextNamein interface- ServletContext
- Returns:
- The name of the web application or null if no name has been declared in the deployment descriptor.
 
 - 
getContextPathpublic java.lang.String getContextPath() Description copied from interface:javax.servlet.ServletContextReturn the main path associated with this context.- Specified by:
- getContextPathin interface- ServletContext
- Returns:
- The main context path
 
 - 
addFilterpublic FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.String className) Description copied from interface:javax.servlet.ServletContextAdd filter to context.- Specified by:
- addFilterin interface- ServletContext
- 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
 
 - 
addFilterpublic FilterRegistration.Dynamic addFilter(java.lang.String filterName, Filter filter) Description copied from interface:javax.servlet.ServletContextAdd filter to context.- Specified by:
- addFilterin interface- ServletContext
- 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
 
 - 
addFilterpublic FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass) Description copied from interface:javax.servlet.ServletContextAdd filter to context.- Specified by:
- addFilterin interface- ServletContext
- 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
 
 - 
createFilterpublic <T extends Filter> T createFilter(java.lang.Class<T> c) throws ServletException Description copied from interface:javax.servlet.ServletContextCreate a Filter instance using the given class. The instance is just created. No initialisation occurs.- Specified by:
- createFilterin interface- ServletContext
- 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
 
 - 
getFilterRegistrationpublic FilterRegistration getFilterRegistration(java.lang.String filterName) Description copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
- getFilterRegistrationin interface- ServletContext
- Parameters:
- filterName- TODO
- Returns:
- TODO
 
 - 
addServletpublic ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.String className) Description copied from interface:javax.servlet.ServletContextRegister a servlet implementation for use in this ServletContext.- Specified by:
- addServletin interface- 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
 
 - 
addServletpublic ServletRegistration.Dynamic addServlet(java.lang.String servletName, Servlet servlet) Description copied from interface:javax.servlet.ServletContextRegister a servlet instance for use in this ServletContext.- Specified by:
- addServletin interface- ServletContext
- Parameters:
- servletName- The name of the servlet to register
- servlet- The Servlet instance to register
- Returns:
- The registration object that enables further configuration
 
 - 
addServletpublic ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass) Description copied from interface:javax.servlet.ServletContextAdd servlet to the context.- Specified by:
- addServletin interface- ServletContext
- 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
 
 - 
addJspFilepublic ServletRegistration.Dynamic addJspFile(java.lang.String jspName, java.lang.String jspFile) Description copied from interface:javax.servlet.ServletContextAdd a JSP to the context.- Specified by:
- addJspFilein interface- ServletContext
- Parameters:
- jspName- The servlet name under which this JSP file should be registered
- jspFile- The path, relative to the web application root, for the JSP file to be used for this servlet
- Returns:
- a ServletRegistration.Dynamicobject that can be used to further configure the servlet
 
 - 
createServletpublic <T extends Servlet> T createServlet(java.lang.Class<T> c) throws ServletException Description copied from interface:javax.servlet.ServletContextCreate an Servlet instance using the given class. The instance is just created. No initialisation occurs.- Specified by:
- createServletin interface- ServletContext
- 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.
 
 - 
getServletRegistrationpublic ServletRegistration getServletRegistration(java.lang.String servletName) Description copied from interface:javax.servlet.ServletContextObtain the details of the named servlet.- Specified by:
- getServletRegistrationin interface- ServletContext
- 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
 
 - 
getDefaultSessionTrackingModespublic java.util.Set<SessionTrackingMode> getDefaultSessionTrackingModes() Description copied from interface:javax.servlet.ServletContextObtains 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.- Specified by:
- getDefaultSessionTrackingModesin interface- ServletContext
- Returns:
- The set of default session tracking modes for this web application
 
 - 
getEffectiveSessionTrackingModespublic java.util.Set<SessionTrackingMode> getEffectiveSessionTrackingModes() Description copied from interface:javax.servlet.ServletContextObtains the currently enabled session tracking modes for this web application.- Specified by:
- getEffectiveSessionTrackingModesin interface- ServletContext
- Returns:
- The value supplied via ServletContext.setSessionTrackingModes(Set)if one was previously set, else return the defaults
 
 - 
getSessionCookieConfigpublic SessionCookieConfig getSessionCookieConfig() - Specified by:
- getSessionCookieConfigin interface- ServletContext
- Returns:
- TODO
 
 - 
setSessionTrackingModespublic void setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes) Description copied from interface:javax.servlet.ServletContextConfigures the available session tracking modes for this web application.- Specified by:
- setSessionTrackingModesin interface- ServletContext
- Parameters:
- sessionTrackingModes- The session tracking modes to use for this web application
 
 - 
setInitParameterpublic boolean setInitParameter(java.lang.String name, java.lang.String value)Description copied from interface:javax.servlet.ServletContextSet the given initialisation parameter to the given value.- Specified by:
- setInitParameterin interface- ServletContext
- 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
 
 - 
addListenerpublic void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass) Description copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
- addListenerin interface- ServletContext
- Parameters:
- listenerClass- TODO
 
 - 
addListenerpublic void addListener(java.lang.String className) Description copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
- addListenerin interface- ServletContext
- Parameters:
- className- TODO
 
 - 
addListenerpublic <T extends java.util.EventListener> void addListener(T t) Description copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
- addListenerin interface- ServletContext
- Type Parameters:
- T- TODO
- Parameters:
- t- TODO
 
 - 
createListenerpublic <T extends java.util.EventListener> T createListener(java.lang.Class<T> c) throws ServletExceptionDescription copied from interface:javax.servlet.ServletContextTODO SERVLET3 - Add comments- Specified by:
- createListenerin interface- ServletContext
- Type Parameters:
- T- TODO
- Parameters:
- c- TODO
- Returns:
- TODO
- Throws:
- ServletException- TODO
 
 - 
declareRolespublic void declareRoles(java.lang.String... roleNames) Description copied from interface:javax.servlet.ServletContextAdd to the declared roles for this ServletContext.- Specified by:
- declareRolesin interface- ServletContext
- Parameters:
- roleNames- The roles to add
 
 - 
getClassLoaderpublic java.lang.ClassLoader getClassLoader() Description copied from interface:javax.servlet.ServletContextGet the web application class loader associated with this ServletContext.- Specified by:
- getClassLoaderin interface- ServletContext
- Returns:
- The associated web application class loader
 
 - 
getEffectiveMajorVersionpublic int getEffectiveMajorVersion() Description copied from interface:javax.servlet.ServletContextObtain the major version of the servlet specification for which this web application is implemented.- Specified by:
- getEffectiveMajorVersionin interface- ServletContext
- Returns:
- The major version declared in web.xml
 
 - 
getEffectiveMinorVersionpublic int getEffectiveMinorVersion() Description copied from interface:javax.servlet.ServletContextObtain the minor version of the servlet specification for which this web application is implemented.- Specified by:
- getEffectiveMinorVersionin interface- ServletContext
- Returns:
- The minor version declared in web.xml
 
 - 
getFilterRegistrationspublic java.util.Map<java.lang.String,? extends FilterRegistration> getFilterRegistrations() - Specified by:
- getFilterRegistrationsin interface- ServletContext
- Returns:
- TODO
 
 - 
getJspConfigDescriptorpublic JspConfigDescriptor getJspConfigDescriptor() - Specified by:
- getJspConfigDescriptorin interface- ServletContext
- Returns:
- TODO
 
 - 
getServletRegistrationspublic java.util.Map<java.lang.String,? extends ServletRegistration> getServletRegistrations() Description copied from interface:javax.servlet.ServletContextObtain a Map of servlet names to servlet registrations for all servlets registered with this context.- Specified by:
- getServletRegistrationsin interface- ServletContext
- Returns:
- A Map of servlet names to servlet registrations for all servlets registered with this context
 
 - 
getVirtualServerNamepublic java.lang.String getVirtualServerName() Description copied from interface:javax.servlet.ServletContextGet 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:
- getVirtualServerNamein interface- ServletContext
- Returns:
- The primary name of the virtual host on which this context is deployed
 
 - 
getSessionTimeoutpublic int getSessionTimeout() Description copied from interface:javax.servlet.ServletContextGet the default session timeout.- Specified by:
- getSessionTimeoutin interface- ServletContext
- Returns:
- The current default session timeout in minutes
 
 - 
setSessionTimeoutpublic void setSessionTimeout(int sessionTimeout) Description copied from interface:javax.servlet.ServletContextSet the default session timeout. This method may only be called before the ServletContext is initialised.- Specified by:
- setSessionTimeoutin interface- ServletContext
- Parameters:
- sessionTimeout- The new default session timeout in minutes.
 
 - 
getRequestCharacterEncodingpublic java.lang.String getRequestCharacterEncoding() Description copied from interface:javax.servlet.ServletContextGet the default character encoding for reading request bodies.- Specified by:
- getRequestCharacterEncodingin interface- ServletContext
- Returns:
- The character encoding name or nullif no default has been specified
 
 - 
setRequestCharacterEncodingpublic void setRequestCharacterEncoding(java.lang.String encoding) Description copied from interface:javax.servlet.ServletContextSet 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:
- setRequestCharacterEncodingin interface- ServletContext
- Parameters:
- encoding- The name of the character encoding to use
 
 - 
getResponseCharacterEncodingpublic java.lang.String getResponseCharacterEncoding() Description copied from interface:javax.servlet.ServletContextGet the default character encoding for writing response bodies.- Specified by:
- getResponseCharacterEncodingin interface- ServletContext
- Returns:
- The character encoding name or nullif no default has been specified
 
 - 
setResponseCharacterEncodingpublic void setResponseCharacterEncoding(java.lang.String encoding) Description copied from interface:javax.servlet.ServletContextSet 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:
- setResponseCharacterEncodingin interface- ServletContext
- Parameters:
- encoding- The name of the character encoding to use
 
 
- 
 
-