servletunit

Class ServletContextSimulator

java.lang.Object

servletunit.ServletContextSimulator

public class ServletContextSimulator
extends java.lang.Object

This class simulates a ServletContext.

Constructor Summary

Constructors

Constructor and Description
ServletContextSimulator()

Method Summary

Methods

Modifier and Type	Method and Description
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() Returns an Enumeration containing the attribute names available within this servlet context.
ServletContext	getContext(java.lang.String uripath) Unsupported in this version.
java.io.File	getContextDirectory()
java.lang.String	getInitParameter(java.lang.String s) 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.
int	getMajorVersion() Returns the major version of the Java Servlet API that this Web server supports.
java.lang.String	getMimeType(java.lang.String file) Unsupported in this version.
int	getMinorVersion() Returns the minor version of the Servlet API that this Web server supports.
RequestDispatcher	getNamedDispatcher(java.lang.String s)
java.lang.String	getRealPath(java.lang.String path)
RequestDispatcher	getRequestDispatcher(java.lang.String urlpath) Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.
RequestDispatcherSimulator	getRequestDispatcherSimulator() Returns the mock RequestDispatcher object used in this test.
java.net.URL	getResource(java.lang.String path) TODO: add appropriate comments
java.io.File	getResourceAsFile(java.lang.String path) Attempts to load a resource from the underlying file system and return a file handle to it.
java.io.InputStream	getResourceAsStream(java.lang.String path) Returns the resource located at the named path as an InputStream object.
java.util.Set	getResourcePaths() Unsupported in this version.
java.util.Set	getResourcePaths(java.lang.String path) Unsupported in this version.
java.lang.String	getServerInfo() Returns the name and version of the servlet container on which the servlet is running.
Servlet	getServlet(java.lang.String name) Unsupported in this version.
java.lang.String	getServletContextName() Unsupported in this version.
java.util.Enumeration	getServletNames() Unsupported in this version.
java.util.Enumeration	getServlets() Unsupported in this version.
void	log(java.lang.Exception exception, java.lang.String msg) Deprecated. As of Java Servlet API 2.1, use
void	log(java.lang.String msg) Writes the specified message to a servlet log file, which is usually an event log.
void	log(java.lang.String message, java.lang.Throwable throwable) Writes the stack trace and an explanatory message for a given Throwable exception to the servlet log file.
void	removeAttribute(java.lang.String name) Removes the attribute with the given name from the servlet context.
void	setAttribute(java.lang.String name, java.lang.Object object) Binds an object to a given attribute name in this servlet context.
void	setContextDirectory(java.io.File contextDirectory) Sets the absolute context directory to be used in the getRealPath() method.
void	setInitParameter(java.lang.String key, java.lang.String value) Sets a named initialization parameter with the supplied String value.

Methods inherited from class java.lang.Object

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

Constructor Detail

ServletContextSimulator

public ServletContextSimulator()

Method Detail

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.

The attribute is returned as a java.lang.Object or some subclass. Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

Parameters:

name - a String specifying the name of the attribute

Returns:

an Object containing the value of the attribute, or null if no attribute exists matching the given name

See Also:

ServletContext#getAttributeNames

getAttributeNames

public java.util.Enumeration getAttributeNames()

Returns an Enumeration containing the attribute names available within this servlet context. Use the getAttribute(java.lang.String) method with an attribute name to get the value of an attribute.

Returns:

an Enumeration of attribute names

See Also:

getAttribute(java.lang.String)

getContext

public ServletContext getContext(java.lang.String uripath)

Unsupported in this version.

getInitParameter

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

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.

Parameters:

s - a String containing the name of the parameter whose value is requested

Returns:

a String containing at least the servlet container name and version number

See Also:

javax.servlet.ServletConfig#getInitParameter

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.

Returns:

an Enumeration of String objects containing the names of the context's initialization parameters

See Also:

javax.servlet.ServletConfig#getInitParameter

setInitParameter

public void setInitParameter(java.lang.String key,
                    java.lang.String value)

Sets a named initialization parameter with the supplied String value.

Parameters:

key - a String specifying the name of the initialization parameter

value - a String value for this initialization parameter

getMajorVersion

public int getMajorVersion()

Returns the major version of the Java Servlet API that this Web server supports. All implementations that comply with Version 2.3 must have this method return the integer 2.

Returns:

2

getMimeType

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

Unsupported in this version.

getMinorVersion

public int getMinorVersion()

Returns the minor version of the Servlet API that this Web server supports. All implementations that comply with Version 2.3 must have this method return the integer 1.

Returns:

3

getNamedDispatcher

public RequestDispatcher getNamedDispatcher(java.lang.String s)

getRealPath

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

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String urlpath)

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.

Parameters:

urlpath - a String specifying the pathname to the resource

Returns:

a RequestDispatcher object that acts as a wrapper for the resource at the specified path

See Also:

RequestDispatcher, ServletContext#getContext

getRequestDispatcherSimulator

public RequestDispatcherSimulator getRequestDispatcherSimulator()

Returns the mock RequestDispatcher object used in this test. The RequestDispatcherSimulator contains forwarding information that can be used in test validation.

getResource

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

TODO: add appropriate comments

Throws:

java.net.MalformedURLException

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.

In this mock implementation, this method first looks for the supplied pathname in the underlying filesystem; if it does not exist there, the default Java classloader is used.

Parameters:

path - a String specifying the path to the resource

Returns:

the InputStream returned to the servlet, or null if no resource exists at the specified path

getResourceAsFile

public java.io.File getResourceAsFile(java.lang.String path)

Attempts to load a resource from the underlying file system and return a file handle to it. It first treats the path as an absolute path. If no file is found, it attempts to treat the path as relative to the context directory. If no file is found, it attempts to treat the path as relative to the current directory. If all these options fail, the returned file will return false() to calls to File.exists().

Parameters:

path - the relative or context-relative path to the file

Returns:

the refernce to the file (which may or may not exist)

getResourcePaths

public java.util.Set getResourcePaths()

Unsupported in this version.

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).

Returns:

a String containing at least the servlet container name and version number

getServlet

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

Unsupported in this version.

Throws:

ServletException

getServletContextName

public java.lang.String getServletContextName()

Unsupported in this version.

getServletNames

public java.util.Enumeration getServletNames()

Unsupported in this version.

getServlets

public java.util.Enumeration getServlets()

Unsupported in this version.

log

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

Deprecated. As of Java Servlet API 2.1, use

log

public void log(java.lang.String msg)

Writes the specified message to a servlet log file, which is usually an event log. The message provides explanatory information about an exception or error or an action the servlet engine takes. The name and type of the servlet log file is specific to the servlet engine.

Parameters:

msg - a String specifying the explanatory message to be written to the log file

log

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

Writes the stack trace and an explanatory message for a given Throwable exception to the servlet log file. The name and type of the servlet log file is specific to the servlet engine, but it is usually an event log.

Parameters:

message - a String that describes the error or exception

throwable - the Throwable error or exception

removeAttribute

public void removeAttribute(java.lang.String name)

Removes the attribute with the given name from the servlet context. After removal, subsequent calls to getAttribute(java.lang.String) to retrieve the attribute's value will return null.

If listeners are configured on the ServletContext the container notifies them accordingly.

Parameters:

name - a String specifying the name of the attribute to be removed

setAttribute

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

Binds an object to a given attribute name in this servlet context. If the name specified is already used for an attribute, this method will replace the attribute with the new to the new attribute.

If listeners are configured on the ServletContext the container notifies them accordingly.

If a null value is passed, the effect is the same as calling removeAttribute().

Attribute names should follow the same convention as package names. The Java Servlet API specification reserves names matching java.*, javax.*, and sun.*.

Parameters:

name - a String specifying the name of the attribute

object - an Object representing the attribute to be bound

getResourcePaths

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

Unsupported in this version.

setContextDirectory

public void setContextDirectory(java.io.File contextDirectory)

Sets the absolute context directory to be used in the getRealPath() method.

Parameters:

contextDirectory - the absolute path of the root context directory for this application.

getContextDirectory

public java.io.File getContextDirectory()