Package org.apache.catalina.core
Class ApplicationContextFacade
- java.lang.Object
-
- org.apache.catalina.core.ApplicationContextFacade
-
- All Implemented Interfaces:
jakarta.servlet.ServletContext
public final class ApplicationContextFacade extends Object implements jakarta.servlet.ServletContext
Facade object which masks the internalApplicationContext
object from the web application.- Version:
- $Revision: 1.7.6.1 $ $Date: 2008/04/17 18:37:06 $
- Author:
- Remy Maucherat, Jean-Francois Arcand
-
-
Constructor Summary
Constructors Constructor 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 Description jakarta.servlet.FilterRegistration.Dynamic
addFilter(String filterName, jakarta.servlet.Filter filter)
jakarta.servlet.FilterRegistration.Dynamic
addFilter(String filterName, Class<? extends jakarta.servlet.Filter> filterClass)
Adds the filter with the given name and class type to this servlet context.jakarta.servlet.FilterRegistration.Dynamic
addFilter(String filterName, String className)
Adds the filter with the given name and class name to this servlet context.jakarta.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>
voidaddListener(T t)
Adds the given listener to this ServletContext.jakarta.servlet.ServletRegistration.Dynamic
addServlet(String servletName, jakarta.servlet.Servlet servlet)
jakarta.servlet.ServletRegistration.Dynamic
addServlet(String servletName, Class<? extends jakarta.servlet.Servlet> servletClass)
jakarta.servlet.ServletRegistration.Dynamic
addServlet(String servletName, String className)
<T extends jakarta.servlet.Filter>
TcreateFilter(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>
TcreateListener(Class<T> clazz)
Instantiates the given EventListener class and performs any required resource injection into the new EventListener instance before returning it.<T extends jakarta.servlet.Servlet>
TcreateServlet(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()
jakarta.servlet.ServletContext
getContext(String uripath)
String
getContextPath()
Set<jakarta.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<jakarta.servlet.SessionTrackingMode>
getEffectiveSessionTrackingModes()
Gets the session tracking modes that are in effect for this ServletContext.jakarta.servlet.FilterRegistration
getFilterRegistration(String filterName)
Gets the FilterRegistration corresponding to the filter with the given filterName.Map<String,? extends jakarta.servlet.FilterRegistration>
getFilterRegistrations()
Gets a Map of the FilterRegistration objects corresponding to all currently registered filters.String
getInitParameter(String name)
Enumeration<String>
getInitParameterNames()
jakarta.servlet.descriptor.JspConfigDescriptor
getJspConfigDescriptor()
Gets the<jsp-config>
related configuration that was aggregated from theweb.xml
andweb-fragment.xml
descriptor files of the web application represented by this ServletContext.int
getMajorVersion()
String
getMimeType(String file)
int
getMinorVersion()
jakarta.servlet.RequestDispatcher
getNamedDispatcher(String name)
String
getRealPath(String path)
String
getRequestCharacterEncoding()
jakarta.servlet.RequestDispatcher
getRequestDispatcher(String path)
URL
getResource(String path)
InputStream
getResourceAsStream(String path)
Set<String>
getResourcePaths(String path)
String
getResponseCharacterEncoding()
String
getServerInfo()
jakarta.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.jakarta.servlet.ServletRegistration
getServletRegistration(String servletName)
Gets the ServletRegistration corresponding to the servlet with the given servletName.Map<String,? extends jakarta.servlet.ServletRegistration>
getServletRegistrations()
Gets a Map of the ServletRegistration objects corresponding to all currently registered servlets.Enumeration<jakarta.servlet.Servlet>
getServlets()
Deprecated.As of Java Servlet API 2.1, with no direct replacement.jakarta.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, uselog(String, Throwable)
insteadvoid
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<jakarta.servlet.SessionTrackingMode> sessionTrackingModes)
Sets the session tracking modes that are to become effective for this ServletContext.
-
-
-
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 interfacejakarta.servlet.ServletContext
-
getContext
public jakarta.servlet.ServletContext getContext(String uripath)
- Specified by:
getContext
in interfacejakarta.servlet.ServletContext
-
getMajorVersion
public int getMajorVersion()
- Specified by:
getMajorVersion
in interfacejakarta.servlet.ServletContext
-
getMinorVersion
public int getMinorVersion()
- Specified by:
getMinorVersion
in interfacejakarta.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 interfacejakarta.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 interfacejakarta.servlet.ServletContext
-
getMimeType
public String getMimeType(String file)
- Specified by:
getMimeType
in interfacejakarta.servlet.ServletContext
-
getResourcePaths
public Set<String> getResourcePaths(String path)
- Specified by:
getResourcePaths
in interfacejakarta.servlet.ServletContext
-
getResource
public URL getResource(String path) throws MalformedURLException
- Specified by:
getResource
in interfacejakarta.servlet.ServletContext
- Throws:
MalformedURLException
-
getResourceAsStream
public InputStream getResourceAsStream(String path)
- Specified by:
getResourceAsStream
in interfacejakarta.servlet.ServletContext
-
getRequestDispatcher
public jakarta.servlet.RequestDispatcher getRequestDispatcher(String path)
- Specified by:
getRequestDispatcher
in interfacejakarta.servlet.ServletContext
-
getNamedDispatcher
public jakarta.servlet.RequestDispatcher getNamedDispatcher(String name)
- Specified by:
getNamedDispatcher
in interfacejakarta.servlet.ServletContext
-
getServlet
@Deprecated public jakarta.servlet.Servlet getServlet(String name) throws jakarta.servlet.ServletException
Deprecated.As of Java Servlet API 2.1, with no direct replacement.- Specified by:
getServlet
in interfacejakarta.servlet.ServletContext
- Throws:
jakarta.servlet.ServletException
-
getServlets
@Deprecated public Enumeration<jakarta.servlet.Servlet> getServlets()
Deprecated.As of Java Servlet API 2.1, with no direct replacement.- Specified by:
getServlets
in interfacejakarta.servlet.ServletContext
-
getServletNames
@Deprecated public Enumeration<String> getServletNames()
Deprecated.As of Java Servlet API 2.1, with no direct replacement.- Specified by:
getServletNames
in interfacejakarta.servlet.ServletContext
-
log
public void log(String msg)
- Specified by:
log
in interfacejakarta.servlet.ServletContext
-
log
@Deprecated public void log(Exception exception, String msg)
Deprecated.As of Java Servlet API 2.1, uselog(String, Throwable)
instead- Specified by:
log
in interfacejakarta.servlet.ServletContext
-
log
public void log(String message, Throwable throwable)
- Specified by:
log
in interfacejakarta.servlet.ServletContext
-
getRealPath
public String getRealPath(String path)
- Specified by:
getRealPath
in interfacejakarta.servlet.ServletContext
-
getServerInfo
public String getServerInfo()
- Specified by:
getServerInfo
in interfacejakarta.servlet.ServletContext
-
getInitParameter
public String getInitParameter(String name)
- Specified by:
getInitParameter
in interfacejakarta.servlet.ServletContext
-
getInitParameterNames
public Enumeration<String> getInitParameterNames()
- Specified by:
getInitParameterNames
in interfacejakarta.servlet.ServletContext
-
setInitParameter
public boolean setInitParameter(String name, String value)
- Specified by:
setInitParameter
in interfacejakarta.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 interfacejakarta.servlet.ServletContext
-
getAttributeNames
public Enumeration<String> getAttributeNames()
- Specified by:
getAttributeNames
in interfacejakarta.servlet.ServletContext
-
setAttribute
public void setAttribute(String name, Object object)
- Specified by:
setAttribute
in interfacejakarta.servlet.ServletContext
-
removeAttribute
public void removeAttribute(String name)
- Specified by:
removeAttribute
in interfacejakarta.servlet.ServletContext
-
getServletContextName
public String getServletContextName()
- Specified by:
getServletContextName
in interfacejakarta.servlet.ServletContext
-
addServlet
public jakarta.servlet.ServletRegistration.Dynamic addServlet(String servletName, String className)
- Specified by:
addServlet
in interfacejakarta.servlet.ServletContext
-
addServlet
public jakarta.servlet.ServletRegistration.Dynamic addServlet(String servletName, jakarta.servlet.Servlet servlet)
- Specified by:
addServlet
in interfacejakarta.servlet.ServletContext
-
addServlet
public jakarta.servlet.ServletRegistration.Dynamic addServlet(String servletName, Class<? extends jakarta.servlet.Servlet> servletClass)
- Specified by:
addServlet
in interfacejakarta.servlet.ServletContext
-
addJspFile
public jakarta.servlet.ServletRegistration.Dynamic addJspFile(String servletName, String jspFile)
- Specified by:
addJspFile
in interfacejakarta.servlet.ServletContext
-
createServlet
public <T extends jakarta.servlet.Servlet> T createServlet(Class<T> clazz) throws jakarta.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 interfacejakarta.servlet.ServletContext
- Throws:
jakarta.servlet.ServletException
-
getServletRegistration
public jakarta.servlet.ServletRegistration getServletRegistration(String servletName)
Gets the ServletRegistration corresponding to the servlet with the given servletName.- Specified by:
getServletRegistration
in interfacejakarta.servlet.ServletContext
-
getServletRegistrations
public Map<String,? extends jakarta.servlet.ServletRegistration> getServletRegistrations()
Gets a Map of the ServletRegistration objects corresponding to all currently registered servlets.- Specified by:
getServletRegistrations
in interfacejakarta.servlet.ServletContext
-
addFilter
public jakarta.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 interfacejakarta.servlet.ServletContext
-
addFilter
public jakarta.servlet.FilterRegistration.Dynamic addFilter(String filterName, jakarta.servlet.Filter filter)
- Specified by:
addFilter
in interfacejakarta.servlet.ServletContext
-
addFilter
public jakarta.servlet.FilterRegistration.Dynamic addFilter(String filterName, Class<? extends jakarta.servlet.Filter> filterClass)
Adds the filter with the given name and class type to this servlet context.- Specified by:
addFilter
in interfacejakarta.servlet.ServletContext
-
createFilter
public <T extends jakarta.servlet.Filter> T createFilter(Class<T> clazz) throws jakarta.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 interfacejakarta.servlet.ServletContext
- Throws:
jakarta.servlet.ServletException
-
getFilterRegistration
public jakarta.servlet.FilterRegistration getFilterRegistration(String filterName)
Gets the FilterRegistration corresponding to the filter with the given filterName.- Specified by:
getFilterRegistration
in interfacejakarta.servlet.ServletContext
-
getFilterRegistrations
public Map<String,? extends jakarta.servlet.FilterRegistration> getFilterRegistrations()
Gets a Map of the FilterRegistration objects corresponding to all currently registered filters.- Specified by:
getFilterRegistrations
in interfacejakarta.servlet.ServletContext
-
getSessionCookieConfig
public jakarta.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 interfacejakarta.servlet.ServletContext
-
setSessionTrackingModes
public void setSessionTrackingModes(Set<jakarta.servlet.SessionTrackingMode> sessionTrackingModes)
Sets the session tracking modes that are to become effective for this ServletContext.- Specified by:
setSessionTrackingModes
in interfacejakarta.servlet.ServletContext
-
getDefaultSessionTrackingModes
public Set<jakarta.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
Gets the session tracking modes that are supported by default for this ServletContext.- Specified by:
getDefaultSessionTrackingModes
in interfacejakarta.servlet.ServletContext
- Returns:
- set of the session tracking modes supported by default for this ServletContext
-
getEffectiveSessionTrackingModes
public Set<jakarta.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
Gets the session tracking modes that are in effect for this ServletContext.- Specified by:
getEffectiveSessionTrackingModes
in interfacejakarta.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 interfacejakarta.servlet.ServletContext
-
addListener
public <T extends EventListener> void addListener(T t)
Adds the given listener to this ServletContext.- Specified by:
addListener
in interfacejakarta.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 interfacejakarta.servlet.ServletContext
-
createListener
public <T extends EventListener> T createListener(Class<T> clazz) throws jakarta.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 interfacejakarta.servlet.ServletContext
- Throws:
jakarta.servlet.ServletException
-
getJspConfigDescriptor
public jakarta.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
Gets the<jsp-config>
related configuration that was aggregated from theweb.xml
andweb-fragment.xml
descriptor files of the web application represented by this ServletContext.- Specified by:
getJspConfigDescriptor
in interfacejakarta.servlet.ServletContext
-
getClassLoader
public ClassLoader getClassLoader()
- Specified by:
getClassLoader
in interfacejakarta.servlet.ServletContext
-
declareRoles
public void declareRoles(String... roleNames)
- Specified by:
declareRoles
in interfacejakarta.servlet.ServletContext
-
getVirtualServerName
public String getVirtualServerName()
- Specified by:
getVirtualServerName
in interfacejakarta.servlet.ServletContext
-
getSessionTimeout
public int getSessionTimeout()
- Specified by:
getSessionTimeout
in interfacejakarta.servlet.ServletContext
-
setSessionTimeout
public void setSessionTimeout(int sessionTimeout)
- Specified by:
setSessionTimeout
in interfacejakarta.servlet.ServletContext
-
getRequestCharacterEncoding
public String getRequestCharacterEncoding()
- Specified by:
getRequestCharacterEncoding
in interfacejakarta.servlet.ServletContext
-
setRequestCharacterEncoding
public void setRequestCharacterEncoding(String encoding)
- Specified by:
setRequestCharacterEncoding
in interfacejakarta.servlet.ServletContext
-
getResponseCharacterEncoding
public String getResponseCharacterEncoding()
- Specified by:
getResponseCharacterEncoding
in interfacejakarta.servlet.ServletContext
-
setResponseCharacterEncoding
public void setResponseCharacterEncoding(String encoding)
- Specified by:
setResponseCharacterEncoding
in interfacejakarta.servlet.ServletContext
-
-