org.apache.jasper.servlet

Class JspCServletContext

java.lang.Object

org.apache.jasper.servlet.JspCServletContext

public class JspCServletContext
extends java.lang.Object

Simple ServletContext implementation without HTTP-specific methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Hashtable<java.lang.String,java.lang.Object>	myAttributes Servlet context attributes.
protected java.io.PrintWriter	myLogWriter The log writer we will write log messages to.
protected java.net.URL	myResourceBaseURL The base URL (document root) for this context.

Constructor Summary

Constructors

Constructor and Description
JspCServletContext(java.io.PrintWriter aLogWriter, java.net.URL aResourceBaseURL) Create a new instance of this ServletContext implementation.

Method Summary

Modifier and Type	Method and Description
FilterRegistration.Dynamic	addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)
FilterRegistration.Dynamic	addFilter(java.lang.String filterName, Filter filter)
FilterRegistration.Dynamic	addFilter(java.lang.String filterName, java.lang.String className)
void	addFilter(java.lang.String filterName, java.lang.String description, java.lang.String className, java.util.Map<java.lang.String,java.lang.String> initParameters) Adds the filter with the given name, description, and class name to this servlet context.
void	addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
void	addListener(java.lang.String className)
<T extends java.util.EventListener> void	addListener(T t)
ServletRegistration.Dynamic	addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)
ServletRegistration.Dynamic	addServlet(java.lang.String servletName, Servlet servlet)
ServletRegistration.Dynamic	addServlet(java.lang.String servletName, java.lang.String className)
void	addServlet(java.lang.String servletName, java.lang.String description, java.lang.String className, java.util.Map<java.lang.String,java.lang.String> initParameters, int loadOnStartup)
void	addServletMapping(java.lang.String servletName, java.lang.String[] urlPatterns) Adds servlet mappings from the given url patterns to the servlet with the given servlet name to this servlet context.
<T extends Filter> T	createFilter(java.lang.Class<T> c)
<T extends java.util.EventListener> T	createListener(java.lang.Class<T> clazz)
<T extends Servlet> T	createServlet(java.lang.Class<T> c)
void	declareRoles(java.lang.String... roleNames)
java.lang.Object	getAttribute(java.lang.String name) Return the specified context attribute, if any.
java.util.Enumeration<java.lang.String>	getAttributeNames() Return an enumeration of context attribute names.
java.lang.ClassLoader	getClassLoader()
ServletContext	getContext(java.lang.String uripath) Return the servlet context for the specified path.
java.lang.String	getContextPath() Returns the context path of the web application.
java.util.Set<SessionTrackingMode>	getDefaultSessionTrackingModes()
int	getEffectiveMajorVersion()
int	getEffectiveMinorVersion()
java.util.Set<SessionTrackingMode>	getEffectiveSessionTrackingModes()
FilterRegistration	getFilterRegistration(java.lang.String filterName)
java.util.Map<java.lang.String,FilterRegistration>	getFilterRegistrations()
java.lang.String	getInitParameter(java.lang.String name) Return the specified context initialization parameter.
java.util.Enumeration<java.lang.String>	getInitParameterNames() Return an enumeration of the names of context initialization parameters.
JspConfigDescriptor	getJspConfigDescriptor()
int	getMajorVersion() Return the Servlet API major version number.
java.lang.String	getMimeType(java.lang.String file) Return the MIME type for the specified filename.
int	getMinorVersion() Return the Servlet API minor version number.
RequestDispatcher	getNamedDispatcher(java.lang.String name) Return a request dispatcher for the specified servlet name.
java.lang.String	getRealPath(java.lang.String path) Return the real path for the specified context-relative virtual path.
RequestDispatcher	getRequestDispatcher(java.lang.String path) Return a request dispatcher for the specified context-relative path.
java.net.URL	getResource(java.lang.String path) Return a URL object of a resource that is mapped to the specified context-relative path.
java.io.InputStream	getResourceAsStream(java.lang.String path) Return an InputStream allowing access to the resource at the specified context-relative path.
java.util.Set<java.lang.String>	getResourcePaths(java.lang.String path) Return the set of resource paths for the "directory" at the specified context path.
java.lang.String	getServerInfo() Return descriptive information about this server.
Servlet	getServlet(java.lang.String name) Deprecated. This method has been deprecated with no replacement
java.lang.String	getServletContextName() Return the name of this servlet context.
java.util.Enumeration<java.lang.String>	getServletNames() Deprecated. This method has been deprecated with no replacement
ServletRegistration	getServletRegistration(java.lang.String servletName)
java.util.Map<java.lang.String,ServletRegistration>	getServletRegistrations()
java.util.Enumeration<Servlet>	getServlets() Deprecated. This method has been deprecated with no replacement
SessionCookieConfig	getSessionCookieConfig()
void	log(java.lang.Exception exception, java.lang.String message) Deprecated. Use log(String,Throwable) instead
void	log(java.lang.String message) Log the specified message.
void	log(java.lang.String message, java.lang.Throwable exception) Log the specified message and exception.
void	removeAttribute(java.lang.String name) Remove the specified context attribute.
void	setAttribute(java.lang.String name, java.lang.Object value) Set or replace the specified context attribute.
boolean	setInitParameter(java.lang.String name, java.lang.String value)
void	setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

myAttributes

protected java.util.Hashtable<java.lang.String,java.lang.Object> myAttributes

Servlet context attributes.

myLogWriter

protected java.io.PrintWriter myLogWriter

The log writer we will write log messages to.

myResourceBaseURL

protected java.net.URL myResourceBaseURL

The base URL (document root) for this context.

Constructor Detail

JspCServletContext

public JspCServletContext(java.io.PrintWriter aLogWriter,
                          java.net.URL aResourceBaseURL)

Create a new instance of this ServletContext implementation.

Parameters:

aLogWriter - PrintWriter which is used for log() calls

aResourceBaseURL - Resource base URL

Method Detail

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

Return the specified context attribute, if any.

Parameters:

name - Name of the requested attribute

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

Return an enumeration of context attribute names.

getContextPath

public java.lang.String getContextPath()

Returns the context path of the web application.

getContext

public ServletContext getContext(java.lang.String uripath)

Return the servlet context for the specified path.

Parameters:

uripath - Server-relative path starting with '/'

getInitParameter

public java.lang.String getInitParameter(java.lang.String name)

Return the specified context initialization parameter.

Parameters:

name - Name of the requested parameter

getInitParameterNames

public java.util.Enumeration<java.lang.String> getInitParameterNames()

Return an enumeration of the names of context initialization parameters.

getMajorVersion

public int getMajorVersion()

Return the Servlet API major version number.

getMimeType

public java.lang.String getMimeType(java.lang.String file)

Return the MIME type for the specified filename.

Parameters:

file - Filename whose MIME type is requested

getMinorVersion

public int getMinorVersion()

Return the Servlet API minor version number.

getEffectiveMajorVersion

public int getEffectiveMajorVersion()

getEffectiveMinorVersion

public int getEffectiveMinorVersion()

getNamedDispatcher

public RequestDispatcher getNamedDispatcher(java.lang.String name)

Return a request dispatcher for the specified servlet name.

Parameters:

name - Name of the requested servlet

getRealPath

public java.lang.String getRealPath(java.lang.String path)

Return the real path for the specified context-relative virtual path.

Parameters:

path - The context-relative virtual path to resolve

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String path)

Return a request dispatcher for the specified context-relative path.

Parameters:

path - Context-relative path for which to acquire a dispatcher

getResource

public java.net.URL getResource(java.lang.String path)
                         throws java.net.MalformedURLException

Return a URL object of a resource that is mapped to the specified context-relative path.

Parameters:

path - Context-relative path of the desired resource

Throws:

java.net.MalformedURLException - if the resource path is not properly formed

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String path)

Return an InputStream allowing access to the resource at the specified context-relative path.

Parameters:

path - Context-relative path of the desired resource

getResourcePaths

public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)

Return the set of resource paths for the "directory" at the specified context path.

Parameters:

path - Context-relative base path

getServerInfo

public java.lang.String getServerInfo()

Return descriptive information about this server.

getServlet

public Servlet getServlet(java.lang.String name)
                   throws ServletException

Deprecated. This method has been deprecated with no replacement

Return a null reference for the specified servlet name.

Parameters:

name - Name of the requested servlet

Throws:

ServletException

getServletContextName

public java.lang.String getServletContextName()

Return the name of this servlet context.

getServletNames

public java.util.Enumeration<java.lang.String> getServletNames()

Deprecated. This method has been deprecated with no replacement

Return an empty enumeration of servlet names.

getServlets

public java.util.Enumeration<Servlet> getServlets()

Deprecated. This method has been deprecated with no replacement

Return an empty enumeration of servlets.

log

public void log(java.lang.String message)

Log the specified message.

Parameters:

message - The message to be logged

log

public void log(java.lang.Exception exception,
                java.lang.String message)

Deprecated. Use log(String,Throwable) instead

Log the specified message and exception.

Parameters:

exception - The exception to be logged

message - The message to be logged

log

public void log(java.lang.String message,
                java.lang.Throwable exception)

Log the specified message and exception.

Parameters:

message - The message to be logged

exception - The exception to be logged

removeAttribute

public void removeAttribute(java.lang.String name)

Remove the specified context attribute.

Parameters:

name - Name of the attribute to remove

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Set or replace the specified context attribute.

Parameters:

name - Name of the context attribute to set

value - Corresponding attribute value

addServlet

public void addServlet(java.lang.String servletName,
                       java.lang.String description,
                       java.lang.String className,
                       java.util.Map<java.lang.String,java.lang.String> initParameters,
                       int loadOnStartup)

addServletMapping

public void addServletMapping(java.lang.String servletName,
                              java.lang.String[] urlPatterns)

Adds servlet mappings from the given url patterns to the servlet with the given servlet name to this servlet context.

addFilter

public void addFilter(java.lang.String filterName,
                      java.lang.String description,
                      java.lang.String className,
                      java.util.Map<java.lang.String,java.lang.String> initParameters)

Adds the filter with the given name, description, and class name to this servlet context.

setInitParameter

public boolean setInitParameter(java.lang.String name,
                                java.lang.String value)

addServlet

public ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                              java.lang.String className)

addServlet

public ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                              Servlet servlet)

addServlet

public ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                              java.lang.Class<? extends Servlet> servletClass)

createServlet

public <T extends Servlet> T createServlet(java.lang.Class<T> c)
                                    throws ServletException

Throws:

ServletException

getServletRegistration

public ServletRegistration getServletRegistration(java.lang.String servletName)

getServletRegistrations

public java.util.Map<java.lang.String,ServletRegistration> getServletRegistrations()

addFilter

public FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                            java.lang.String className)

addFilter

public FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                            Filter filter)

addFilter

public FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                            java.lang.Class<? extends Filter> filterClass)

createFilter

public <T extends Filter> T createFilter(java.lang.Class<T> c)

getFilterRegistration

public FilterRegistration getFilterRegistration(java.lang.String filterName)

getFilterRegistrations

public java.util.Map<java.lang.String,FilterRegistration> getFilterRegistrations()

getSessionCookieConfig

public SessionCookieConfig getSessionCookieConfig()

setSessionTrackingModes

public void setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)

getDefaultSessionTrackingModes

public java.util.Set<SessionTrackingMode> getDefaultSessionTrackingModes()

getEffectiveSessionTrackingModes

public java.util.Set<SessionTrackingMode> getEffectiveSessionTrackingModes()

addListener

public void addListener(java.lang.String className)

addListener

public <T extends java.util.EventListener> void addListener(T t)

addListener

public void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)

createListener

public <T extends java.util.EventListener> T createListener(java.lang.Class<T> clazz)
                                                     throws ServletException

Throws:

ServletException

getJspConfigDescriptor

public JspConfigDescriptor getJspConfigDescriptor()

getClassLoader

public java.lang.ClassLoader getClassLoader()

declareRoles

public void declareRoles(java.lang.String... roleNames)