Class ServletUnitServletContext
- java.lang.Object
-
- com.meterware.servletunit.ServletUnitServletContext
-
- All Implemented Interfaces:
javax.servlet.ServletContext
public class ServletUnitServletContext extends java.lang.Object implements javax.servlet.ServletContext
This class is a private implementation of the ServletContext class.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.String
DEFAULT_SERVER_INFO
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description javax.servlet.FilterRegistration.Dynamic
addFilter(java.lang.String filterName, java.lang.Class<? extends javax.servlet.Filter> filterClass)
javax.servlet.FilterRegistration.Dynamic
addFilter(java.lang.String filterName, java.lang.String className)
javax.servlet.FilterRegistration.Dynamic
addFilter(java.lang.String filterName, javax.servlet.Filter filter)
void
addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
void
addListener(java.lang.String className)
<T extends java.util.EventListener>
voidaddListener(T t)
javax.servlet.ServletRegistration.Dynamic
addServlet(java.lang.String servletName, java.lang.Class<? extends javax.servlet.Servlet> servletClass)
javax.servlet.ServletRegistration.Dynamic
addServlet(java.lang.String servletName, java.lang.String className)
javax.servlet.ServletRegistration.Dynamic
addServlet(java.lang.String servletName, javax.servlet.Servlet servlet)
<T extends javax.servlet.Filter>
TcreateFilter(java.lang.Class<T> clazz)
<T extends java.util.EventListener>
TcreateListener(java.lang.Class<T> clazz)
<T extends javax.servlet.Servlet>
TcreateServlet(java.lang.Class<T> clazz)
void
declareRoles(java.lang.String... roleNames)
java.lang.Object
getAttribute(java.lang.String name)
Returns the servlet container attribute with the given name, or null if there is no attribute by that name.java.util.Enumeration
getAttributeNames()
java.lang.ClassLoader
getClassLoader()
javax.servlet.ServletContext
getContext(java.lang.String A)
Returns a ServletContext object that corresponds to a specified URL on the server.java.lang.String
getContextPath()
java.util.Set<javax.servlet.SessionTrackingMode>
getDefaultSessionTrackingModes()
int
getEffectiveMajorVersion()
int
getEffectiveMinorVersion()
java.util.Set<javax.servlet.SessionTrackingMode>
getEffectiveSessionTrackingModes()
javax.servlet.FilterRegistration
getFilterRegistration(java.lang.String filterName)
java.util.Map<java.lang.String,? extends javax.servlet.FilterRegistration>
getFilterRegistrations()
java.lang.String
getInitParameter(java.lang.String name)
Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist.java.util.Enumeration
getInitParameterNames()
Returns the names of the context's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.javax.servlet.descriptor.JspConfigDescriptor
getJspConfigDescriptor()
int
getMajorVersion()
Returns the major version of the Java Servlet API that this servlet container supports.java.lang.String
getMimeType(java.lang.String filePath)
Returns the MIME type of the specified file, or null if the MIME type is not known.int
getMinorVersion()
Returns the minor version of the Servlet API that this servlet container supports.javax.servlet.RequestDispatcher
getNamedDispatcher(java.lang.String A)
Returns a RequestDispatcher object that acts as a wrapper for the named servlet.java.lang.String
getRealPath(java.lang.String path)
Returns a String containing the real path for a given virtual path.javax.servlet.RequestDispatcher
getRequestDispatcher(java.lang.String path)
Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.java.net.URL
getResource(java.lang.String path)
Returns a URL to the resource that is mapped to a specified path.java.io.InputStream
getResourceAsStream(java.lang.String path)
Returns the resource located at the named path as an InputStream object.java.util.Set
getResourcePaths(java.lang.String path)
Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument.java.lang.String
getServerInfo()
Returns the name and version of the servlet container on which the servlet is running.javax.servlet.Servlet
getServlet(java.lang.String A)
Deprecated.as of Servlet API 2.1java.lang.String
getServletContextName()
Returns the name of this web application correponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.java.util.Enumeration
getServletNames()
Deprecated.as of Servlet API 2.1javax.servlet.ServletRegistration
getServletRegistration(java.lang.String servletName)
java.util.Map<java.lang.String,? extends javax.servlet.ServletRegistration>
getServletRegistrations()
java.util.Enumeration
getServlets()
Deprecated.as of Servlet API 2.0javax.servlet.SessionCookieConfig
getSessionCookieConfig()
java.lang.String
getVirtualServerName()
void
log(java.lang.Exception e, java.lang.String message)
Deprecated.use log( String, Throwable )void
log(java.lang.String message)
Writes the specified message to a servlet log file, usually an event log.void
log(java.lang.String message, java.lang.Throwable t)
Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.void
removeAttribute(java.lang.String name)
void
setAttribute(java.lang.String name, java.lang.Object attribute)
boolean
setInitParameter(java.lang.String name, java.lang.String value)
void
setLogStream(java.io.PrintStream logStream)
Allows the test to determine where the log messages should be written.void
setSessionTrackingModes(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)
-
-
-
Field Detail
-
DEFAULT_SERVER_INFO
public static final java.lang.String DEFAULT_SERVER_INFO
- See Also:
- Constant Field Values
-
-
Method Detail
-
getContext
public javax.servlet.ServletContext getContext(java.lang.String A)
Returns a ServletContext object that corresponds to a specified URL 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 from the context. The given path must be absolute (beginning with "/") and is interpreted based on the server's document root.
In a security conscious environment, the servlet container may return null for a given URL.
- Specified by:
getContext
in interfacejavax.servlet.ServletContext
-
getMajorVersion
public int getMajorVersion()
Returns the major version of the Java Servlet API that this servlet container supports. All implementations that comply with Version 2.4 must have this method return the integer 2.- Specified by:
getMajorVersion
in interfacejavax.servlet.ServletContext
-
getMinorVersion
public int getMinorVersion()
Returns the minor version of the Servlet API that this servlet container supports. All implementations that comply with Version 2.4 must have this method return the integer 4.- Specified by:
getMinorVersion
in interfacejavax.servlet.ServletContext
-
getMimeType
public java.lang.String getMimeType(java.lang.String filePath)
Returns the MIME type of the specified file, or null if the MIME type is not known. The MIME type is determined by the configuration of the servlet container, and may be specified in a web application deployment descriptor. Common MIME types are "text/html" and "image/gif".- Specified by:
getMimeType
in interfacejavax.servlet.ServletContext
-
getResource
public java.net.URL getResource(java.lang.String path)
Returns a 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.This method allows the servlet container to make a resource available to servlets from any source. Resources can be located on a local or remote file system, in a database, or in a .war file.
The servlet container must implement the URL handlers and URLConnection objects that are necessary to access the resource.
This method returns null if no resource is mapped to the pathname. Some containers may allow writing to the URL returned by this method using the methods of the URL class. The resource content is returned directly, so be aware that requesting a .jsp page returns the JSP source code. Use a RequestDispatcher instead to include results of an execution. This method has a different purpose than java.lang.Class.getResource, which looks up resources based on a class loader. This method does not use class loaders.
- Specified by:
getResource
in interfacejavax.servlet.ServletContext
-
getResourceAsStream
public java.io.InputStream getResourceAsStream(java.lang.String path)
Returns the resource located at the named path as an InputStream object. The data in the InputStream can be of any type or length. The path must be specified according to the rules given in getResource. This method returns null if no resource exists at the specified path. Meta-information such as content length and content type that is available via getResource method is lost when using this method. The servlet container must implement the URL handlers and URLConnection objects necessary to access the resource. This method is different from java.lang.Class.getResourceAsStream, which uses a class loader. This method allows servlet containers to make a resource available to a servlet from any location, without using a class loader.- Specified by:
getResourceAsStream
in interfacejavax.servlet.ServletContext
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. A RequestDispatcher object can be used to forward a request to the resource or to include the resource in a response. The resource can be dynamic or static. The pathname must begin with a "/" and is interpreted as relative to the current context root. Use getContext to obtain a RequestDispatcher for resources in foreign contexts. This method returns null if the ServletContext cannot return a RequestDispatcher.- Specified by:
getRequestDispatcher
in interfacejavax.servlet.ServletContext
-
getNamedDispatcher
public javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String A)
Returns a RequestDispatcher object that acts as a wrapper for the named servlet. Servlets (and JSP pages also) may be given names via server administration or via a web application deployment descriptor. A servlet instance can determine its name using ServletConfig.getServletName(). This method returns null if the ServletContext cannot return a RequestDispatcher for any reason.- Specified by:
getNamedDispatcher
in interfacejavax.servlet.ServletContext
-
getServlet
public javax.servlet.Servlet getServlet(java.lang.String A)
Deprecated.as of Servlet API 2.1- Specified by:
getServlet
in interfacejavax.servlet.ServletContext
-
getServlets
public java.util.Enumeration getServlets()
Deprecated.as of Servlet API 2.0- Specified by:
getServlets
in interfacejavax.servlet.ServletContext
-
getServletNames
public java.util.Enumeration getServletNames()
Deprecated.as of Servlet API 2.1- Specified by:
getServletNames
in interfacejavax.servlet.ServletContext
-
log
public void log(java.lang.String message)
Writes the specified message to a servlet log file, usually an event log. The name and type of the servlet log file is specific to the servlet container.- Specified by:
log
in interfacejavax.servlet.ServletContext
-
log
public void log(java.lang.Exception e, java.lang.String message)
Deprecated.use log( String, Throwable )- Specified by:
log
in interfacejavax.servlet.ServletContext
-
log
public void log(java.lang.String message, java.lang.Throwable t)
Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file. The name and type of the servlet log file is specific to the servlet container, usually an event log.- Specified by:
log
in interfacejavax.servlet.ServletContext
-
getRealPath
public java.lang.String getRealPath(java.lang.String path)
Returns a String containing the real path for a given virtual path. For example, the virtual path "/index.html" has a real path of whatever file on the server's filesystem would be served by a request for "/index.html". The real path returned will be in a form appropriate to the computer and operating system on which the servlet container is running, including the proper path separators. This method returns null if the servlet container cannot translate the virtual path to a real path for any reason (such as when the content is being made available from a .war archive).- Specified by:
getRealPath
in interfacejavax.servlet.ServletContext
-
getServerInfo
public java.lang.String getServerInfo()
Returns the name and version of the servlet container on which the servlet is running. The form of the returned string is servername/versionnumber. For example, the JavaServer Web Development Kit may return the string JavaServer Web Dev Kit/1.0. The servlet container may return other optional information after the primary string in parentheses, for example, JavaServer Web Dev Kit/1.0 (JDK 1.1.6; Windows NT 4.0 x86).- Specified by:
getServerInfo
in interfacejavax.servlet.ServletContext
-
getInitParameter
public java.lang.String getInitParameter(java.lang.String name)
Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist. This method can make available configuration information useful to an entire "web application". For example, it can provide a webmaster's email address or the name of a system that holds critical data.- Specified by:
getInitParameter
in interfacejavax.servlet.ServletContext
-
getInitParameterNames
public java.util.Enumeration getInitParameterNames()
Returns the names of the context's initialization parameters as an Enumeration of String objects, or an empty Enumeration if the context has no initialization parameters.- Specified by:
getInitParameterNames
in interfacejavax.servlet.ServletContext
-
getAttribute
public java.lang.Object getAttribute(java.lang.String name)
Returns the servlet container attribute with the given name, or null if there is no attribute by that name. An attribute allows a servlet container to give the servlet additional information not already provided by this interface. See your server documentation for information about its attributes. A list of supported attributes can be retrieved using getAttributeNames.- Specified by:
getAttribute
in interfacejavax.servlet.ServletContext
-
getAttributeNames
public java.util.Enumeration getAttributeNames()
- Specified by:
getAttributeNames
in interfacejavax.servlet.ServletContext
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.Object attribute)
- Specified by:
setAttribute
in interfacejavax.servlet.ServletContext
-
removeAttribute
public void removeAttribute(java.lang.String name)
- Specified by:
removeAttribute
in interfacejavax.servlet.ServletContext
-
getResourcePaths
public java.util.Set getResourcePaths(java.lang.String path)
Returns a directory-like listing of all the paths to resources within the web application whose longest sub-path matches the supplied path argument. Paths indicating subdirectory paths end with a '/'. The returned paths are all relative to the root of the web application and have a leading '/'. For example, for a web application containing/welcome.html
/catalog/index.html
/catalog/products.html
/catalog/offers/books.html
/catalog/offers/music.html
/customer/login.jsp
/WEB-INF/web.xml
/WEB-INF/classes/com.acme.OrderServlet.class,
getResourcePaths("/") returns {"/welcome.html", "/catalog/", "/customer/", "/WEB-INF/"}
getResourcePaths("/catalog/") returns {"/catalog/index.html", "/catalog/products.html", "/catalog/offers/"}.- Specified by:
getResourcePaths
in interfacejavax.servlet.ServletContext
- Parameters:
path
- partial path used to match the resources, which must start with a /- Returns:
- a Set containing the directory listing, or null if there are no resources in the web application whose path begins with the supplied path.
- Since:
- HttpUnit 1.3
-
getServletContextName
public java.lang.String getServletContextName()
Returns the name of this web application correponding to this ServletContext as specified in the deployment descriptor for this web application by the display-name element.- Specified by:
getServletContextName
in interfacejavax.servlet.ServletContext
- Returns:
- The name of the web application or null if no name has been declared in the deployment descriptor
- Since:
- HttpUnit 1.3
-
getContextPath
public java.lang.String getContextPath()
- Specified by:
getContextPath
in interfacejavax.servlet.ServletContext
-
getEffectiveMajorVersion
public int getEffectiveMajorVersion()
- Specified by:
getEffectiveMajorVersion
in interfacejavax.servlet.ServletContext
-
getEffectiveMinorVersion
public int getEffectiveMinorVersion()
- Specified by:
getEffectiveMinorVersion
in interfacejavax.servlet.ServletContext
-
setInitParameter
public boolean setInitParameter(java.lang.String name, java.lang.String value)
- Specified by:
setInitParameter
in interfacejavax.servlet.ServletContext
-
addServlet
public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.String className)
- Specified by:
addServlet
in interfacejavax.servlet.ServletContext
-
addServlet
public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName, javax.servlet.Servlet servlet)
- Specified by:
addServlet
in interfacejavax.servlet.ServletContext
-
addServlet
public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.Class<? extends javax.servlet.Servlet> servletClass)
- Specified by:
addServlet
in interfacejavax.servlet.ServletContext
-
createServlet
public <T extends javax.servlet.Servlet> T createServlet(java.lang.Class<T> clazz) throws javax.servlet.ServletException
- Specified by:
createServlet
in interfacejavax.servlet.ServletContext
- Throws:
javax.servlet.ServletException
-
getServletRegistration
public javax.servlet.ServletRegistration getServletRegistration(java.lang.String servletName)
- Specified by:
getServletRegistration
in interfacejavax.servlet.ServletContext
-
getServletRegistrations
public java.util.Map<java.lang.String,? extends javax.servlet.ServletRegistration> getServletRegistrations()
- Specified by:
getServletRegistrations
in interfacejavax.servlet.ServletContext
-
addFilter
public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.String className)
- Specified by:
addFilter
in interfacejavax.servlet.ServletContext
-
addFilter
public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName, javax.servlet.Filter filter)
- Specified by:
addFilter
in interfacejavax.servlet.ServletContext
-
addFilter
public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.Class<? extends javax.servlet.Filter> filterClass)
- Specified by:
addFilter
in interfacejavax.servlet.ServletContext
-
createFilter
public <T extends javax.servlet.Filter> T createFilter(java.lang.Class<T> clazz) throws javax.servlet.ServletException
- Specified by:
createFilter
in interfacejavax.servlet.ServletContext
- Throws:
javax.servlet.ServletException
-
getFilterRegistration
public javax.servlet.FilterRegistration getFilterRegistration(java.lang.String filterName)
- Specified by:
getFilterRegistration
in interfacejavax.servlet.ServletContext
-
getFilterRegistrations
public java.util.Map<java.lang.String,? extends javax.servlet.FilterRegistration> getFilterRegistrations()
- Specified by:
getFilterRegistrations
in interfacejavax.servlet.ServletContext
-
getSessionCookieConfig
public javax.servlet.SessionCookieConfig getSessionCookieConfig()
- Specified by:
getSessionCookieConfig
in interfacejavax.servlet.ServletContext
-
setSessionTrackingModes
public void setSessionTrackingModes(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)
- Specified by:
setSessionTrackingModes
in interfacejavax.servlet.ServletContext
-
getDefaultSessionTrackingModes
public java.util.Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
- Specified by:
getDefaultSessionTrackingModes
in interfacejavax.servlet.ServletContext
-
getEffectiveSessionTrackingModes
public java.util.Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
- Specified by:
getEffectiveSessionTrackingModes
in interfacejavax.servlet.ServletContext
-
addListener
public void addListener(java.lang.String className)
- Specified by:
addListener
in interfacejavax.servlet.ServletContext
-
addListener
public <T extends java.util.EventListener> void addListener(T t)
- Specified by:
addListener
in interfacejavax.servlet.ServletContext
-
addListener
public void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
- Specified by:
addListener
in interfacejavax.servlet.ServletContext
-
createListener
public <T extends java.util.EventListener> T createListener(java.lang.Class<T> clazz) throws javax.servlet.ServletException
- Specified by:
createListener
in interfacejavax.servlet.ServletContext
- Throws:
javax.servlet.ServletException
-
getJspConfigDescriptor
public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
- Specified by:
getJspConfigDescriptor
in interfacejavax.servlet.ServletContext
-
getClassLoader
public java.lang.ClassLoader getClassLoader()
- Specified by:
getClassLoader
in interfacejavax.servlet.ServletContext
-
declareRoles
public void declareRoles(java.lang.String... roleNames)
- Specified by:
declareRoles
in interfacejavax.servlet.ServletContext
-
getVirtualServerName
public java.lang.String getVirtualServerName()
- Specified by:
getVirtualServerName
in interfacejavax.servlet.ServletContext
-
setLogStream
public void setLogStream(java.io.PrintStream logStream)
Allows the test to determine where the log messages should be written. Defaults toSystem.out
- Parameters:
logStream
- where to write the log messages- See Also:
log(String)
-
-