ApplicationContext (Payara Project 4.1.2.174 API)

java.lang.Object
- org.apache.catalina.core.ApplicationContext

All Implemented Interfaces:

javax.servlet.ServletContext
```
public class ApplicationContext
extends Object
implements javax.servlet.ServletContext
```
Standard implementation of ServletContext that represents a web application's execution environment. An instance of this class is associated with each instance of StandardContext.

Version:

$Revision: 1.15.2.1 $ $Date: 2008/04/17 18:37:06 $

Author:

Craig R. McClanahan, Remy Maucherat

Constructor Summary

Constructors
Constructor and Description

ApplicationContext(StandardContext context)
Construct a new instance of this class, associated with the specified Context instance.

Constructors
Constructor and Description
`ApplicationContext(StandardContext 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 and Description
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String filterName, Class<? extends javax.servlet.Filter> filterClass)` Adds the filter with the given name and class type to this servlet context.
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String filterName, javax.servlet.Filter filter)`
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String filterName, String className)` Adds the filter with the given name and class name to this servlet context.
`void`	`addListener(Class<? extends EventListener> listenerClass)` Adds a listener of the given class type to this ServletContext.
`void`	`addListener(String className)` Adds the listener with the given class name to this ServletContext.
`<T extends EventListener> void`	`addListener(T t)` Adds the given listener to this ServletContext.
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String servletName, Class<? extends javax.servlet.Servlet> servletClass)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String servletName, javax.servlet.Servlet servlet)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String servletName, String className)`
`<T extends javax.servlet.Filter> T`	`createFilter(Class<T> clazz)` Instantiates the given Filter class and performs any required resource injection into the new Filter instance before returning it.
`<T extends EventListener> T`	`createListener(Class<T> clazz)` Instantiates the given EventListener class and performs any required resource injection into the new EventListener instance before returning it.
`<T extends javax.servlet.Servlet> T`	`createServlet(Class<T> clazz)` Instantiates the given Servlet class and performs any required resource injection into the new Servlet instance before returning it.
`void`	`declareRoles(String... roleNames)`
`Object`	`getAttribute(String name)` Return the value of the specified context attribute, if any; otherwise return `null`.
`Enumeration<String>`	`getAttributeNames()` Return an enumeration of the names of the context attributes associated with this context.
`ClassLoader`	`getClassLoader()`
`javax.servlet.ServletContext`	`getContext(String uri)` Return a `ServletContext` object that corresponds to a specified URI on the server.
`String`	`getContextPath()` Returns the context path of the web application.
`Set<javax.servlet.SessionTrackingMode>`	`getDefaultSessionTrackingModes()` Gets the session tracking modes that are supported by default for this `ServletContext`.
`int`	`getEffectiveMajorVersion()` Gets the major version of the Servlet specification that the application represented by this ServletContext is based on.
`int`	`getEffectiveMinorVersion()` Gets the minor version of the Servlet specification that the application represented by this ServletContext is based on.
`Set<javax.servlet.SessionTrackingMode>`	`getEffectiveSessionTrackingModes()` Gets the session tracking modes that are in effect for this `ServletContext`.
`protected javax.servlet.ServletContext`	`getFacade()` Return the facade associated with this ApplicationContext.
`javax.servlet.FilterRegistration`	`getFilterRegistration(String filterName)` Gets the FilterRegistration corresponding to the filter with the given `filterName`.
`Map<String,? extends javax.servlet.FilterRegistration>`	`getFilterRegistrations()` Gets a Map of the FilterRegistration objects corresponding to all currently registered filters.
`String`	`getInitParameter(String name)` Return the value of the specified initialization parameter, or `null` if this parameter does not exist.
`Enumeration<String>`	`getInitParameterNames()` Return the names of the context's initialization parameters, or an empty enumeration if the context has no initialization parameters.
`javax.servlet.descriptor.JspConfigDescriptor`	`getJspConfigDescriptor()` Gets the `<jsp-config>` related configuration that was aggregated from the `web.xml` and `web-fragment.xml` descriptor files of the web application represented by this ServletContext.
`int`	`getMajorVersion()` Return the major version of the Java Servlet API that we implement.
`String`	`getMimeType(String file)` Return the MIME type of the specified file, or `null` if the MIME type cannot be determined.
`int`	`getMinorVersion()` Return the minor version of the Java Servlet API that we implement.
`javax.servlet.RequestDispatcher`	`getNamedDispatcher(String name)` Return a `RequestDispatcher` object that acts as a wrapper for the named servlet.
`String`	`getRealPath(String path)`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)` Return a `RequestDispatcher` instance that acts as a wrapper for the resource at the given path.
`URL`	`getResource(String path)` Return the URL to the resource that is mapped to a specified path.
`InputStream`	`getResourceAsStream(String path)` Return the requested resource as an `InputStream`.
`Set<String>`	`getResourcePaths(String path)` Return a Set containing the resource paths of resources member of the specified collection.
`DirContext`	`getResources()` Return the resources object that is mapped to a specified path.
`String`	`getServerInfo()` Return the name and version of the servlet container.
`javax.servlet.Servlet`	`getServlet(String name)` Deprecated. As of Java Servlet API 2.1, with no direct replacement.
`String`	`getServletContextName()` Return the display name of this web application.
`Enumeration<String>`	`getServletNames()` Deprecated. As of Java Servlet API 2.1, with no direct replacement.
`javax.servlet.ServletRegistration`	`getServletRegistration(String servletName)` Gets the ServletRegistration corresponding to the servlet with the given `servletName`.
`Map<String,? extends javax.servlet.ServletRegistration>`	`getServletRegistrations()` Gets a Map of the ServletRegistration objects corresponding to all currently registered servlets.
`Enumeration<javax.servlet.Servlet>`	`getServlets()` Deprecated. As of Java Servlet API 2.1, with no direct replacement.
`javax.servlet.SessionCookieConfig`	`getSessionCookieConfig()` Gets the `SessionCookieConfig` object through which various properties of the session tracking cookies created on behalf of this `ServletContext` may be configured.
`StandardContext`	`getStandardContext()`
`String`	`getVirtualServerName()`
`void`	`log(Exception exception, String message)` Deprecated. As of Java Servlet API 2.1, use `log(String, Throwable)` instead
`void`	`log(String message)` Writes the specified message to a servlet log file.
`void`	`log(String message, Throwable throwable)` Writes the specified message and exception to a servlet log file.
`void`	`removeAttribute(String name)` Remove the context attribute with the specified name, if any.
`void`	`setAttribute(String name, Object value)` Bind the specified value with the specified context attribute name, replacing any existing value for that name.
`boolean`	`setInitParameter(String name, String value)`
`void`	`setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)` Sets the session tracking modes that are to become effective for this `ServletContext`.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ApplicationContext
```
public ApplicationContext(StandardContext context)
```
    Construct a new instance of this class, associated with the specified Context instance.
    
    Parameters:
    
    context - The associated Context instance
- Method Detail
  - getStandardContext
```
public StandardContext getStandardContext()
```
  - getResources
```
public DirContext getResources()
```
    Return the resources object that is mapped to a specified path. The path must begin with a "/" and is interpreted as relative to the current context root.
  - getAttribute
```
public Object getAttribute(String name)
```
    Return the value of the specified context attribute, if any; otherwise return null.
    
    Specified by:
    
    getAttribute in interface javax.servlet.ServletContext
    
    Parameters:
    
    name - Name of the context attribute to return
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Return an enumeration of the names of the context attributes associated with this context.
    
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletContext
  - getContextPath
```
public String getContextPath()
```
    Returns the context path of the web application.
    The context path is the portion of the request URI that is used to select the context of the request. The context path always comes first in a request URI. The path starts with a "/" character but does not end with a "/" character. For servlets in the default (root) context, this method returns "".
    It is possible that a servlet container may match a context by more than one context path. In such cases the javax.servlet.http.HttpServletRequest#getContextPath() will return the actual context path used by the request and it may differ from the path returned by this method. The context path returned by this method should be considered as the prime or preferred context path of the application.
    
    See Also:
    
    javax.servlet.http.HttpServletRequest#getContextPath()
  - getContext
```
public javax.servlet.ServletContext getContext(String uri)
```
    Return a ServletContext object that corresponds to a specified URI 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 or resources from the context. The given path must be absolute (beginning with a "/"), and is interpreted based on our virtual host's document root.
    
    Specified by:
    
    getContext in interface javax.servlet.ServletContext
    
    Parameters:
    
    uri - Absolute URI of a resource on the server
  - getInitParameter
```
public String getInitParameter(String name)
```
    Return the value of the specified initialization parameter, or null if this parameter does not exist.
    
    Parameters:
    
    name - Name of the initialization parameter to retrieve
  - getInitParameterNames
```
public Enumeration<String> getInitParameterNames()
```
    Return the names of the context's initialization parameters, or an empty enumeration if the context has no initialization parameters.
  - setInitParameter
```
public boolean setInitParameter(String name,
                                String value)
```
    Returns:
    
    true if the context initialization parameter with the given name and value was set successfully on this ServletContext, and false if it was not set because this ServletContext already contains a context initialization parameter with a matching name
  - getMajorVersion
```
public int getMajorVersion()
```
    Return the major version of the Java Servlet API that we implement.
    
    Specified by:
    
    getMajorVersion in interface javax.servlet.ServletContext
  - getMinorVersion
```
public int getMinorVersion()
```
    Return the minor version of the Java Servlet API that we implement.
    
    Specified by:
    
    getMinorVersion in interface javax.servlet.ServletContext
  - getEffectiveMajorVersion
```
public int getEffectiveMajorVersion()
```
    Gets the major version of the Servlet specification that the application represented by this ServletContext is based on.
  - getEffectiveMinorVersion
```
public int getEffectiveMinorVersion()
```
    Gets the minor version of the Servlet specification that the application represented by this ServletContext is based on.
  - getMimeType
```
public String getMimeType(String file)
```
    Return the MIME type of the specified file, or null if the MIME type cannot be determined.
    
    Specified by:
    
    getMimeType in interface javax.servlet.ServletContext
    
    Parameters:
    
    file - Filename for which to identify a MIME type
  - getNamedDispatcher
```
public javax.servlet.RequestDispatcher getNamedDispatcher(String name)
```
    Return a RequestDispatcher object that acts as a wrapper for the named servlet.
    
    Parameters:
    
    name - Name of the servlet for which a dispatcher is requested
  - getRealPath
```
public String getRealPath(String path)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletContext
    
    Parameters:
    
    path - The virtual path to be translated
    
    Returns:
    
    the real path corresponding to the given virtual path, or null if the container was unable to perform the translation
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Return a RequestDispatcher instance that acts as a wrapper for the resource at the given path. The path must begin with a "/" or be empty, and is interpreted as relative to the current context root.
    
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletContext
    
    Parameters:
    
    path - The path to the desired resource.
  - getResource
```
public URL getResource(String path)
                throws MalformedURLException
```
    Return the 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.
    
    Specified by:
    
    getResource in interface javax.servlet.ServletContext
    
    Parameters:
    
    path - The path to the desired resource
    
    Throws:
    
    MalformedURLException - if the path is not given in the correct form
  - getResourceAsStream
```
public InputStream getResourceAsStream(String path)
```
    Return the requested resource as an InputStream. The path must be specified according to the rules described under getResource. If no such resource can be identified, return null.
    
    Specified by:
    
    getResourceAsStream in interface javax.servlet.ServletContext
    
    Parameters:
    
    path - The path to the desired resource.
  - getResourcePaths
```
public Set<String> getResourcePaths(String path)
```
    Return a Set containing the resource paths of resources member of the specified collection. Each path will be a String starting with a "/" character. The returned set is immutable.
    
    Parameters:
    
    path - Collection path
  - getServerInfo
```
public String getServerInfo()
```
    Return the name and version of the servlet container.
    
    Specified by:
    
    getServerInfo in interface javax.servlet.ServletContext
  - getServlet
```
public javax.servlet.Servlet getServlet(String name)
```
    Deprecated. As of Java Servlet API 2.1, with no direct replacement.
    
    Specified by:
    
    getServlet in interface javax.servlet.ServletContext
  - getServletContextName
```
public String getServletContextName()
```
    Return the display name of this web application.
  - getServletNames
```
public Enumeration<String> getServletNames()
```
    Deprecated. As of Java Servlet API 2.1, with no direct replacement.
    
    Specified by:
    
    getServletNames in interface javax.servlet.ServletContext
  - getServlets
```
public Enumeration<javax.servlet.Servlet> getServlets()
```
    Deprecated. As of Java Servlet API 2.1, with no direct replacement.
    
    Specified by:
    
    getServlets in interface javax.servlet.ServletContext
  - log
```
public void log(String message)
```
    Writes the specified message to a servlet log file.
    
    Specified by:
    
    log in interface javax.servlet.ServletContext
    
    Parameters:
    
    message - Message to be written
  - log
```
public void log(Exception exception,
                String message)
```
    Deprecated. As of Java Servlet API 2.1, use log(String, Throwable) instead
    
    Writes the specified exception and message to a servlet log file.
    
    Specified by:
    
    log in interface javax.servlet.ServletContext
    
    Parameters:
    
    exception - Exception to be reported
    
    message - Message to be written
  - log
```
public void log(String message,
                Throwable throwable)
```
    Writes the specified message and exception to a servlet log file.
    
    Specified by:
    
    log in interface javax.servlet.ServletContext
    
    Parameters:
    
    message - Message to be written
    
    throwable - Exception to be reported
  - removeAttribute
```
public void removeAttribute(String name)
```
    Remove the context attribute with the specified name, if any.
    
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletContext
    
    Parameters:
    
    name - Name of the context attribute to be removed
  - setAttribute
```
public void setAttribute(String name,
                         Object value)
```
    Bind the specified value with the specified context attribute name, replacing any existing value for that name.
    
    Specified by:
    
    setAttribute in interface javax.servlet.ServletContext
    
    Parameters:
    
    name - Attribute name to be bound
    
    value - New attribute value to be bound
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            String className)
```
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            javax.servlet.Servlet servlet)
```
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            Class<? extends javax.servlet.Servlet> servletClass)
```
  - createServlet
```
public <T extends javax.servlet.Servlet> T createServlet(Class<T> clazz)
                                                  throws javax.servlet.ServletException
```
    Instantiates the given Servlet class and performs any required resource injection into the new Servlet instance before returning it.
    
    Throws:
    
    javax.servlet.ServletException
  - getServletRegistration
```
public javax.servlet.ServletRegistration getServletRegistration(String servletName)
```
    Gets the ServletRegistration corresponding to the servlet with the given servletName.
  - getServletRegistrations
```
public Map<String,? extends javax.servlet.ServletRegistration> getServletRegistrations()
```
    Gets a Map of the ServletRegistration objects corresponding to all currently registered servlets.
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          String className)
```
    Adds the filter with the given name and class name to this servlet context.
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          javax.servlet.Filter filter)
```
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          Class<? extends javax.servlet.Filter> filterClass)
```
    Adds the filter with the given name and class type to this servlet context.
  - createFilter
```
public <T extends javax.servlet.Filter> T createFilter(Class<T> clazz)
                                                throws javax.servlet.ServletException
```
    Instantiates the given Filter class and performs any required resource injection into the new Filter instance before returning it.
    
    Throws:
    
    javax.servlet.ServletException
  - getFilterRegistration
```
public javax.servlet.FilterRegistration getFilterRegistration(String filterName)
```
    Gets the FilterRegistration corresponding to the filter with the given filterName.
  - getFilterRegistrations
```
public Map<String,? extends javax.servlet.FilterRegistration> getFilterRegistrations()
```
    Gets a Map of the FilterRegistration objects corresponding to all currently registered filters.
  - getSessionCookieConfig
```
public javax.servlet.SessionCookieConfig getSessionCookieConfig()
```
    Gets the SessionCookieConfig object through which various properties of the session tracking cookies created on behalf of this ServletContext may be configured.
  - setSessionTrackingModes
```
public void setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)
```
    Sets the session tracking modes that are to become effective for this ServletContext.
  - getDefaultSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
```
    Gets the session tracking modes that are supported by default for this ServletContext.
    
    Returns:
    
    set of the session tracking modes supported by default for this ServletContext
  - getEffectiveSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
```
    Gets the session tracking modes that are in effect for this ServletContext.
    
    Returns:
    
    set of the session tracking modes in effect for this ServletContext
  - addListener
```
public void addListener(String className)
```
    Adds the listener with the given class name to this ServletContext.
  - addListener
```
public <T extends EventListener> void addListener(T t)
```
    Adds the given listener to this ServletContext.
  - addListener
```
public void addListener(Class<? extends EventListener> listenerClass)
```
    Adds a listener of the given class type to this ServletContext.
  - createListener
```
public <T extends EventListener> T createListener(Class<T> clazz)
                                           throws javax.servlet.ServletException
```
    Instantiates the given EventListener class and performs any required resource injection into the new EventListener instance before returning it.
    
    Throws:
    
    javax.servlet.ServletException
  - getJspConfigDescriptor
```
public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
```
    Gets the <jsp-config> related configuration that was aggregated from the web.xml and web-fragment.xml descriptor files of the web application represented by this ServletContext.
  - getClassLoader
```
public ClassLoader getClassLoader()
```
  - declareRoles
```
public void declareRoles(String... roleNames)
```
  - getVirtualServerName
```
public String getVirtualServerName()
```
  - getFacade
```
protected javax.servlet.ServletContext getFacade()
```
    Return the facade associated with this ApplicationContext.

Class ApplicationContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApplicationContext

Method Detail

getStandardContext

getResources

getAttribute

getAttributeNames

getContextPath

getContext

getInitParameter

getInitParameterNames

setInitParameter

getMajorVersion

getMinorVersion

getEffectiveMajorVersion

getEffectiveMinorVersion

getMimeType

getNamedDispatcher

getRealPath

getRequestDispatcher

getResource

getResourceAsStream

getResourcePaths

getServerInfo

getServlet

getServletContextName

getServletNames

getServlets

log

log

log

removeAttribute

setAttribute

addServlet

addServlet

addServlet

createServlet

getServletRegistration

getServletRegistrations

addFilter

addFilter

addFilter

createFilter

getFilterRegistration

getFilterRegistrations

getSessionCookieConfig

setSessionTrackingModes

getDefaultSessionTrackingModes

getEffectiveSessionTrackingModes

addListener

addListener

addListener

createListener

getJspConfigDescriptor

getClassLoader

declareRoles

getVirtualServerName

getFacade