org.apache.jasper.servlet

Class JspCServletContext

java.lang.Object

org.apache.jasper.servlet.JspCServletContext

public class JspCServletContext
extends Object

Simple ServletContext implementation without HTTP-specific methods.

Author:

Peter Rossbach (pr@webapp.de)

Constructor Summary

Constructors

Constructor and Description
JspCServletContext(PrintWriter aLogWriter, URL aResourceBaseURL, ClassLoader classLoader, boolean validate, boolean blockExternal) Create a new instance of this ServletContext implementation.

Method Summary

Methods

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

Methods inherited from class java.lang.Object

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

Constructor Detail

JspCServletContext

public JspCServletContext(PrintWriter aLogWriter,
                  URL aResourceBaseURL,
                  ClassLoader classLoader,
                  boolean validate,
                  boolean blockExternal)
                   throws JasperException

Create a new instance of this ServletContext implementation.

Parameters:

aLogWriter - PrintWriter which is used for log() calls

aResourceBaseURL - Resource base URL

classLoader - Class loader for this ServletContext

validate - Should a validating parser be used to parse web.xml?

blockExternal - Should external entities be blocked when parsing web.xml?

Throws:

JasperException

Method Detail

getAttribute

public Object getAttribute(String name)

Return the specified context attribute, if any.

Parameters:

name - Name of the requested attribute

getAttributeNames

public Enumeration<String> getAttributeNames()

Return an enumeration of context attribute names.

getContext

public ServletContext getContext(String uripath)

Return the servlet context for the specified path.

Parameters:

uripath - Server-relative path starting with '/'

getContextPath

public String getContextPath()

Return the context path.

getInitParameter

public String getInitParameter(String name)

Return the specified context initialization parameter.

Parameters:

name - Name of the requested parameter

getInitParameterNames

public Enumeration<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 String getMimeType(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.

getNamedDispatcher

public RequestDispatcher getNamedDispatcher(String name)

Return a request dispatcher for the specified servlet name.

Parameters:

name - Name of the requested servlet

getRealPath

public String getRealPath(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(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 URL getResource(String path)
                throws 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:

MalformedURLException - if the resource path is not properly formed

getResourceAsStream

public InputStream getResourceAsStream(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 Set<String> getResourcePaths(String path)

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

Parameters:

path - Context-relative base path

getServerInfo

public String getServerInfo()

Return descriptive information about this server.

getServlet

@Deprecated
public Servlet getServlet(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 String getServletContextName()

Return the name of this servlet context.

getServletNames

@Deprecated
public Enumeration<String> getServletNames()

Deprecated. This method has been deprecated with no replacement

Return an empty enumeration of servlet names.

getServlets

@Deprecated
public Enumeration<Servlet> getServlets()

Deprecated. This method has been deprecated with no replacement

Return an empty enumeration of servlets.

log

public void log(String message)

Log the specified message.

Parameters:

message - The message to be logged

log

@Deprecated
public void log(Exception exception,
                  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(String message,
       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(String name)

Remove the specified context attribute.

Parameters:

name - Name of the attribute to remove

setAttribute

public void setAttribute(String name,
                Object value)

Set or replace the specified context attribute.

Parameters:

name - Name of the context attribute to set

value - Corresponding attribute value

addFilter

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

addServlet

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

getDefaultSessionTrackingModes

public Set<SessionTrackingMode> getDefaultSessionTrackingModes()

getEffectiveSessionTrackingModes

public Set<SessionTrackingMode> getEffectiveSessionTrackingModes()

getSessionCookieConfig

public SessionCookieConfig getSessionCookieConfig()

setSessionTrackingModes

public void setSessionTrackingModes(Set<SessionTrackingMode> sessionTrackingModes)

addFilter

public Dynamic addFilter(String filterName,
                Filter filter)

addFilter

public Dynamic addFilter(String filterName,
                Class<? extends Filter> filterClass)

addServlet

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

addServlet

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

createFilter

public <T extends Filter> T createFilter(Class<T> c)
                              throws ServletException

Throws:

ServletException

createServlet

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

Throws:

ServletException

getFilterRegistration

public FilterRegistration getFilterRegistration(String filterName)

getServletRegistration

public ServletRegistration getServletRegistration(String servletName)

setInitParameter

public boolean setInitParameter(String name,
                       String value)

addListener

public void addListener(Class<? extends EventListener> listenerClass)

addListener

public void addListener(String className)

addListener

public <T extends EventListener> void addListener(T t)

createListener

public <T extends EventListener> T createListener(Class<T> c)
                                       throws ServletException

Throws:

ServletException

declareRoles

public void declareRoles(String... roleNames)

getClassLoader

public ClassLoader getClassLoader()

getEffectiveMajorVersion

public int getEffectiveMajorVersion()

getEffectiveMinorVersion

public int getEffectiveMinorVersion()

getFilterRegistrations

public Map<String,? extends FilterRegistration> getFilterRegistrations()

getJspConfigDescriptor

public JspConfigDescriptor getJspConfigDescriptor()

getServletRegistrations

public Map<String,? extends ServletRegistration> getServletRegistrations()

getVirtualServerName

public String getVirtualServerName()