ApplicationContext (JBoss Web 8.0.0.Alpha1 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: 1263 $ $Date: 2009-11-11 04:29:33 +0100 (Wed, 11 Nov 2009) $

Author:

Craig R. McClanahan, Remy Maucherat

Field Summary

Fields
Modifier and Type Field and Description

protected Map attributes
The context attributes for this context.
- Fields inherited from interface javax.servlet.ServletContext
  ORDERED_LIBS, TEMPDIR

Fields
Modifier and Type	Field and Description
`protected Map`	`attributes` The context attributes for this context.

Constructor Summary

Constructors
Constructor and Description
`ApplicationContext(String basePath, 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)`
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String filterName, javax.servlet.Filter filter)`
`javax.servlet.FilterRegistration.Dynamic`	`addFilter(String filterName, String className)`
`void`	`addListener(Class<? extends EventListener> listenerClass)`
`void`	`addListener(String className)`
`<T extends EventListener> void`	`addListener(T listener)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String servletName, Class<? extends javax.servlet.Servlet> clazz)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String servletName, javax.servlet.Servlet servlet)`
`javax.servlet.ServletRegistration.Dynamic`	`addServlet(String servletName, String className)`
`protected void`	`checkListenerType(EventListener listener)`
`protected void`	`clearAttributes()` Clear all application-created attributes.
`<T extends javax.servlet.Filter> T`	`createFilter(Class<T> c)`
`<T extends EventListener> T`	`createListener(Class<T> clazz)`
`<T extends javax.servlet.Servlet> T`	`createServlet(Class<T> c)`
`void`	`declareRoles(String... roleNames)`
`Object`	`getAttribute(String name)` Return the value of the specified context attribute, if any; otherwise return `null`.
`Enumeration`	`getAttributeNames()` Return an enumeration of the names of the context attributes associated with this context.
`ClassLoader`	`getClassLoader()`
`protected StandardContext`	`getContext()`
`javax.servlet.ServletContext`	`getContext(String uri)` Return a `ServletContext` object that corresponds to a specified URI on the server.
`String`	`getContextPath()` Return the main path associated with this context.
`Set<javax.servlet.SessionTrackingMode>`	`getDefaultSessionTrackingModes()`
`int`	`getEffectiveMajorVersion()`
`int`	`getEffectiveMinorVersion()`
`Set<javax.servlet.SessionTrackingMode>`	`getEffectiveSessionTrackingModes()`
`protected javax.servlet.ServletContext`	`getFacade()` Return the facade associated with this ApplicationContext.
`javax.servlet.FilterRegistration`	`getFilterRegistration(String filterName)`
`Map<String,javax.servlet.FilterRegistration>`	`getFilterRegistrations()`
`String`	`getInitParameter(String name)` Return the value of the specified initialization parameter, or `null` if this parameter does not exist.
`Enumeration`	`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()`
`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.
`protected Map`	`getReadonlyAttributes()`
`String`	`getRealPath(String path)` Return the real path for a given virtual path, if possible; otherwise return `null`.
`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`	`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`	`getServletNames()` Deprecated. As of Java Servlet API 2.1, with no direct replacement.
`javax.servlet.ServletRegistration`	`getServletRegistration(String servletName)`
`Map<String,javax.servlet.ServletRegistration>`	`getServletRegistrations()`
`Enumeration`	`getServlets()` Deprecated. As of Java Servlet API 2.1, with no direct replacement.
`javax.servlet.SessionCookieConfig`	`getSessionCookieConfig()`
`String`	`getVirtualServerName()`
`boolean`	`isRestricted()`
`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`	`setRestricted(boolean restricted)`
`void`	`setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)`

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

- Field Detail
  - attributes
```
protected Map attributes
```
    The context attributes for this context.
- Constructor Detail
  - ApplicationContext
```
public ApplicationContext(String basePath,
                          StandardContext context)
```
    Construct a new instance of this class, associated with the specified Context instance.
    
    Parameters:
    
    context - The associated Context instance
- Method Detail
  - 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.
  - isRestricted
```
public boolean isRestricted()
```
  - setRestricted
```
public void setRestricted(boolean restricted)
```
  - 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 getAttributeNames()
```
    Return an enumeration of the names of the context attributes associated with this context.
    
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletContext
  - 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
  - getContextPath
```
public String getContextPath()
```
    Return the main path associated with this context.
    
    Specified by:
    
    getContextPath in interface javax.servlet.ServletContext
  - getInitParameter
```
public String getInitParameter(String name)
```
    Return the value of the specified initialization parameter, or null if this parameter does not exist.
    
    Specified by:
    
    getInitParameter in interface javax.servlet.ServletContext
    
    Parameters:
    
    name - Name of the initialization parameter to retrieve
  - getInitParameterNames
```
public Enumeration getInitParameterNames()
```
    Return the names of the context's initialization parameters, or an empty enumeration if the context has no initialization parameters.
    
    Specified by:
    
    getInitParameterNames in interface javax.servlet.ServletContext
  - 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
  - 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.
    
    Specified by:
    
    getNamedDispatcher in interface javax.servlet.ServletContext
    
    Parameters:
    
    name - Name of the servlet for which a dispatcher is requested
  - getRealPath
```
public String getRealPath(String path)
```
    Return the real path for a given virtual path, if possible; otherwise return null.
    
    Specified by:
    
    getRealPath in interface javax.servlet.ServletContext
    
    Parameters:
    
    path - The path to the desired resource
  - 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 "/" 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 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.
    
    Specified by:
    
    getResourcePaths in interface javax.servlet.ServletContext
    
    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.
    
    Specified by:
    
    getServletContextName in interface javax.servlet.ServletContext
  - getServletNames
```
public Enumeration getServletNames()
```
    Deprecated. As of Java Servlet API 2.1, with no direct replacement.
    
    Specified by:
    
    getServletNames in interface javax.servlet.ServletContext
  - getServlets
```
public Enumeration 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
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          String className)
                                                   throws IllegalArgumentException,
                                                          IllegalStateException
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
    
    Throws:
    
    IllegalArgumentException
    
    IllegalStateException
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          javax.servlet.Filter filter)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - addFilter
```
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName,
                                                          Class<? extends javax.servlet.Filter> filterClass)
```
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            String className)
                                                     throws IllegalArgumentException,
                                                            IllegalStateException
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
    
    Throws:
    
    IllegalArgumentException
    
    IllegalStateException
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            Class<? extends javax.servlet.Servlet> clazz)
                                                     throws IllegalArgumentException,
                                                            IllegalStateException
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
    
    Throws:
    
    IllegalArgumentException
    
    IllegalStateException
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            javax.servlet.Servlet servlet)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - getFilterRegistration
```
public javax.servlet.FilterRegistration getFilterRegistration(String filterName)
```
    Specified by:
    
    getFilterRegistration in interface javax.servlet.ServletContext
  - getServletRegistration
```
public javax.servlet.ServletRegistration getServletRegistration(String servletName)
```
    Specified by:
    
    getServletRegistration in interface javax.servlet.ServletContext
  - getFilterRegistrations
```
public Map<String,javax.servlet.FilterRegistration> getFilterRegistrations()
```
    Specified by:
    
    getFilterRegistrations in interface javax.servlet.ServletContext
  - getServletRegistrations
```
public Map<String,javax.servlet.ServletRegistration> getServletRegistrations()
```
    Specified by:
    
    getServletRegistrations in interface javax.servlet.ServletContext
  - getDefaultSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
```
    Specified by:
    
    getDefaultSessionTrackingModes in interface javax.servlet.ServletContext
  - getEffectiveSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
```
    Specified by:
    
    getEffectiveSessionTrackingModes in interface javax.servlet.ServletContext
  - getSessionCookieConfig
```
public javax.servlet.SessionCookieConfig getSessionCookieConfig()
```
    Specified by:
    
    getSessionCookieConfig in interface javax.servlet.ServletContext
  - createFilter
```
public <T extends javax.servlet.Filter> T createFilter(Class<T> c)
                                                throws javax.servlet.ServletException
```
    Specified by:
    
    createFilter in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - createServlet
```
public <T extends javax.servlet.Servlet> T createServlet(Class<T> c)
                                                  throws javax.servlet.ServletException
```
    Specified by:
    
    createServlet in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - setInitParameter
```
public boolean setInitParameter(String name,
                                String value)
```
    Specified by:
    
    setInitParameter in interface javax.servlet.ServletContext
  - setSessionTrackingModes
```
public void setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)
```
    Specified by:
    
    setSessionTrackingModes in interface javax.servlet.ServletContext
  - addListener
```
public void addListener(String className)
```
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - addListener
```
public <T extends EventListener> void addListener(T listener)
```
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - addListener
```
public void addListener(Class<? extends EventListener> listenerClass)
```
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - createListener
```
public <T extends EventListener> T createListener(Class<T> clazz)
                                           throws javax.servlet.ServletException
```
    Specified by:
    
    createListener in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Specified by:
    
    getClassLoader in interface javax.servlet.ServletContext
  - getJspConfigDescriptor
```
public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
```
    Specified by:
    
    getJspConfigDescriptor in interface javax.servlet.ServletContext
  - getEffectiveMajorVersion
```
public int getEffectiveMajorVersion()
```
    Specified by:
    
    getEffectiveMajorVersion in interface javax.servlet.ServletContext
  - getEffectiveMinorVersion
```
public int getEffectiveMinorVersion()
```
    Specified by:
    
    getEffectiveMinorVersion in interface javax.servlet.ServletContext
  - declareRoles
```
public void declareRoles(String... roleNames)
```
    Specified by:
    
    declareRoles in interface javax.servlet.ServletContext
  - getVirtualServerName
```
public String getVirtualServerName()
```
    Specified by:
    
    getVirtualServerName in interface javax.servlet.ServletContext
  - checkListenerType
```
protected void checkListenerType(EventListener listener)
```
  - getContext
```
protected StandardContext getContext()
```
  - getReadonlyAttributes
```
protected Map getReadonlyAttributes()
```
  - clearAttributes
```
protected void clearAttributes()
```
    Clear all application-created attributes.
  - getFacade
```
protected javax.servlet.ServletContext getFacade()
```
    Return the facade associated with this ApplicationContext.

Class ApplicationContext

Field Summary

Fields inherited from interface javax.servlet.ServletContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

attributes

Constructor Detail

ApplicationContext

Method Detail

getResources

isRestricted

setRestricted

getAttribute

getAttributeNames

getContext

getContextPath

getInitParameter

getInitParameterNames

getMajorVersion

getMinorVersion

getMimeType

getNamedDispatcher

getRealPath

getRequestDispatcher

getResource

getResourceAsStream

getResourcePaths

getServerInfo

getServlet

getServletContextName

getServletNames

getServlets

log

log

log

removeAttribute

setAttribute

addFilter

addFilter

addFilter

addServlet

addServlet

addServlet

getFilterRegistration

getServletRegistration

getFilterRegistrations

getServletRegistrations

getDefaultSessionTrackingModes

getEffectiveSessionTrackingModes

getSessionCookieConfig

createFilter

createServlet

setInitParameter

setSessionTrackingModes

addListener

addListener

addListener

createListener

getClassLoader

getJspConfigDescriptor

getEffectiveMajorVersion

getEffectiveMinorVersion

declareRoles

getVirtualServerName

checkListenerType

getContext

getReadonlyAttributes

clearAttributes

getFacade