ApplicationContextFacade (Payara Project 5.182 API)

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

All Implemented Interfaces:

javax.servlet.ServletContext
```
public final class ApplicationContextFacade
extends Object
implements javax.servlet.ServletContext
```
Facade object which masks the internal ApplicationContext object from the web application.

Version:

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

Author:

Remy Maucherat, Jean-Francois Arcand

Field Summary
- Fields inherited from interface javax.servlet.ServletContext
  ORDERED_LIBS, TEMPDIR

Constructor Summary

Constructors
Constructor and Description

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

Constructors
Constructor and Description
`ApplicationContextFacade(ApplicationContext context)` Construct a new instance of this class, associated with the specified Context instance.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method 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.
`javax.servlet.ServletRegistration.Dynamic`	`addJspFile(String servletName, String jspFile)`
`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)`
`Enumeration<String>`	`getAttributeNames()`
`ClassLoader`	`getClassLoader()`
`javax.servlet.ServletContext`	`getContext(String uripath)`
`String`	`getContextPath()`
`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`.
`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)`
`Enumeration<String>`	`getInitParameterNames()`
`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()`
`String`	`getMimeType(String file)`
`int`	`getMinorVersion()`
`javax.servlet.RequestDispatcher`	`getNamedDispatcher(String name)`
`String`	`getRealPath(String path)`
`String`	`getRequestCharacterEncoding()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`URL`	`getResource(String path)`
`InputStream`	`getResourceAsStream(String path)`
`Set<String>`	`getResourcePaths(String path)`
`String`	`getResponseCharacterEncoding()`
`String`	`getServerInfo()`
`javax.servlet.Servlet`	`getServlet(String name)` Deprecated. As of Java Servlet API 2.1, with no direct replacement.
`String`	`getServletContextName()`
`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.
`int`	`getSessionTimeout()`
`String`	`getVirtualServerName()`
`void`	`log(Exception exception, String msg)` Deprecated. As of Java Servlet API 2.1, use `log(String, Throwable)` instead
`void`	`log(String msg)`
`void`	`log(String message, Throwable throwable)`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object object)`
`boolean`	`setInitParameter(String name, String value)`
`void`	`setRequestCharacterEncoding(String encoding)`
`void`	`setResponseCharacterEncoding(String encoding)`
`void`	`setSessionTimeout(int sessionTimeout)`
`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
  - ApplicationContextFacade
```
public ApplicationContextFacade(ApplicationContext context)
```
    Construct a new instance of this class, associated with the specified Context instance.
    
    Parameters:
    
    context - The associated Context instance
- Method Detail
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.ServletContext
  - getContext
```
public javax.servlet.ServletContext getContext(String uripath)
```
    Specified by:
    
    getContext in interface javax.servlet.ServletContext
  - getMajorVersion
```
public int getMajorVersion()
```
    Specified by:
    
    getMajorVersion in interface javax.servlet.ServletContext
  - getMinorVersion
```
public int getMinorVersion()
```
    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.
    
    Specified by:
    
    getEffectiveMajorVersion in interface javax.servlet.ServletContext
  - getEffectiveMinorVersion
```
public int getEffectiveMinorVersion()
```
    Gets the minor version of the Servlet specification that the application represented by this ServletContext is based on.
    
    Specified by:
    
    getEffectiveMinorVersion in interface javax.servlet.ServletContext
  - getMimeType
```
public String getMimeType(String file)
```
    Specified by:
    
    getMimeType in interface javax.servlet.ServletContext
  - getResourcePaths
```
public Set<String> getResourcePaths(String path)
```
    Specified by:
    
    getResourcePaths in interface javax.servlet.ServletContext
  - getResource
```
public URL getResource(String path)
                throws MalformedURLException
```
    Specified by:
    
    getResource in interface javax.servlet.ServletContext
    
    Throws:
    
    MalformedURLException
  - getResourceAsStream
```
public InputStream getResourceAsStream(String path)
```
    Specified by:
    
    getResourceAsStream in interface javax.servlet.ServletContext
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletContext
  - getNamedDispatcher
```
public javax.servlet.RequestDispatcher getNamedDispatcher(String name)
```
    Specified by:
    
    getNamedDispatcher in interface javax.servlet.ServletContext
  - getServlet
```
@Deprecated
public javax.servlet.Servlet getServlet(String name)
                                             throws javax.servlet.ServletException
```
    Deprecated. As of Java Servlet API 2.1, with no direct replacement.
    
    Specified by:
    
    getServlet in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - getServlets
```
@Deprecated
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
  - getServletNames
```
@Deprecated
public Enumeration<String> getServletNames()
```
    Deprecated. As of Java Servlet API 2.1, with no direct replacement.
    
    Specified by:
    
    getServletNames in interface javax.servlet.ServletContext
  - log
```
public void log(String msg)
```
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - log
```
@Deprecated
public void log(Exception exception,
                            String msg)
```
    Deprecated. As of Java Servlet API 2.1, use log(String, Throwable) instead
    
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - log
```
public void log(String message,
                Throwable throwable)
```
    Specified by:
    
    log in interface javax.servlet.ServletContext
  - getRealPath
```
public String getRealPath(String path)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletContext
  - getServerInfo
```
public String getServerInfo()
```
    Specified by:
    
    getServerInfo in interface javax.servlet.ServletContext
  - getInitParameter
```
public String getInitParameter(String name)
```
    Specified by:
    
    getInitParameter in interface javax.servlet.ServletContext
  - getInitParameterNames
```
public Enumeration<String> getInitParameterNames()
```
    Specified by:
    
    getInitParameterNames in interface javax.servlet.ServletContext
  - setInitParameter
```
public boolean setInitParameter(String name,
                                String value)
```
    Specified by:
    
    setInitParameter in interface javax.servlet.ServletContext
    
    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
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletContext
  - getAttributeNames
```
public Enumeration<String> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletContext
  - setAttribute
```
public void setAttribute(String name,
                         Object object)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletContext
  - removeAttribute
```
public void removeAttribute(String name)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletContext
  - getServletContextName
```
public String getServletContextName()
```
    Specified by:
    
    getServletContextName in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            String className)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            javax.servlet.Servlet servlet)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - addServlet
```
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName,
                                                            Class<? extends javax.servlet.Servlet> servletClass)
```
    Specified by:
    
    addServlet in interface javax.servlet.ServletContext
  - addJspFile
```
public javax.servlet.ServletRegistration.Dynamic addJspFile(String servletName,
                                                            String jspFile)
```
    Specified by:
    
    addJspFile in interface javax.servlet.ServletContext
  - 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.
    
    Specified by:
    
    createServlet in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - getServletRegistration
```
public javax.servlet.ServletRegistration getServletRegistration(String servletName)
```
    Gets the ServletRegistration corresponding to the servlet with the given servletName.
    
    Specified by:
    
    getServletRegistration in interface javax.servlet.ServletContext
  - getServletRegistrations
```
public Map<String,? extends javax.servlet.ServletRegistration> getServletRegistrations()
```
    Gets a Map of the ServletRegistration objects corresponding to all currently registered servlets.
    
    Specified by:
    
    getServletRegistrations in interface javax.servlet.ServletContext
  - 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.
    
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - 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)
```
    Adds the filter with the given name and class type to this servlet context.
    
    Specified by:
    
    addFilter in interface javax.servlet.ServletContext
  - 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.
    
    Specified by:
    
    createFilter in interface javax.servlet.ServletContext
    
    Throws:
    
    javax.servlet.ServletException
  - getFilterRegistration
```
public javax.servlet.FilterRegistration getFilterRegistration(String filterName)
```
    Gets the FilterRegistration corresponding to the filter with the given filterName.
    
    Specified by:
    
    getFilterRegistration in interface javax.servlet.ServletContext
  - getFilterRegistrations
```
public Map<String,? extends javax.servlet.FilterRegistration> getFilterRegistrations()
```
    Gets a Map of the FilterRegistration objects corresponding to all currently registered filters.
    
    Specified by:
    
    getFilterRegistrations in interface javax.servlet.ServletContext
  - 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.
    
    Specified by:
    
    getSessionCookieConfig in interface javax.servlet.ServletContext
  - setSessionTrackingModes
```
public void setSessionTrackingModes(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)
```
    Sets the session tracking modes that are to become effective for this ServletContext.
    
    Specified by:
    
    setSessionTrackingModes in interface javax.servlet.ServletContext
  - getDefaultSessionTrackingModes
```
public Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
```
    Gets the session tracking modes that are supported by default for this ServletContext.
    
    Specified by:
    
    getDefaultSessionTrackingModes in interface javax.servlet.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.
    
    Specified by:
    
    getEffectiveSessionTrackingModes in interface javax.servlet.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.
    
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - addListener
```
public <T extends EventListener> void addListener(T t)
```
    Adds the given listener to this ServletContext.
    
    Specified by:
    
    addListener in interface javax.servlet.ServletContext
  - addListener
```
public void addListener(Class<? extends EventListener> listenerClass)
```
    Adds a listener of the given class type to this ServletContext.
    
    Specified by:
    
    addListener in interface javax.servlet.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.
    
    Specified by:
    
    createListener in interface javax.servlet.ServletContext
    
    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.
    
    Specified by:
    
    getJspConfigDescriptor in interface javax.servlet.ServletContext
  - getClassLoader
```
public ClassLoader getClassLoader()
```
    Specified by:
    
    getClassLoader 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
  - getSessionTimeout
```
public int getSessionTimeout()
```
    Specified by:
    
    getSessionTimeout in interface javax.servlet.ServletContext
  - setSessionTimeout
```
public void setSessionTimeout(int sessionTimeout)
```
    Specified by:
    
    setSessionTimeout in interface javax.servlet.ServletContext
  - getRequestCharacterEncoding
```
public String getRequestCharacterEncoding()
```
    Specified by:
    
    getRequestCharacterEncoding in interface javax.servlet.ServletContext
  - setRequestCharacterEncoding
```
public void setRequestCharacterEncoding(String encoding)
```
    Specified by:
    
    setRequestCharacterEncoding in interface javax.servlet.ServletContext
  - getResponseCharacterEncoding
```
public String getResponseCharacterEncoding()
```
    Specified by:
    
    getResponseCharacterEncoding in interface javax.servlet.ServletContext
  - setResponseCharacterEncoding
```
public void setResponseCharacterEncoding(String encoding)
```
    Specified by:
    
    setResponseCharacterEncoding in interface javax.servlet.ServletContext

Class ApplicationContextFacade

Field Summary

Fields inherited from interface javax.servlet.ServletContext

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ApplicationContextFacade

Method Detail

getContextPath

getContext

getMajorVersion

getMinorVersion

getEffectiveMajorVersion

getEffectiveMinorVersion

getMimeType

getResourcePaths

getResource

getResourceAsStream

getRequestDispatcher

getNamedDispatcher

getServlet

getServlets

getServletNames

log

log

log

getRealPath

getServerInfo

getInitParameter

getInitParameterNames

setInitParameter

getAttribute

getAttributeNames

setAttribute

removeAttribute

getServletContextName

addServlet

addServlet

addServlet

addJspFile

createServlet

getServletRegistration

getServletRegistrations

addFilter

addFilter

addFilter

createFilter

getFilterRegistration

getFilterRegistrations

getSessionCookieConfig

setSessionTrackingModes

getDefaultSessionTrackingModes

getEffectiveSessionTrackingModes

addListener

addListener

addListener

createListener

getJspConfigDescriptor

getClassLoader

declareRoles

getVirtualServerName

getSessionTimeout

setSessionTimeout

getRequestCharacterEncoding

setRequestCharacterEncoding

getResponseCharacterEncoding

setResponseCharacterEncoding