| java.lang.Object
 com.meterware.servletunit.ServletUnitServletContext
| ServletUnitServletContext | | class ServletUnitServletContext implements ServletContext(Code) | | This class is a private implementation of the ServletContext class.
|
| Method Summary | |
| public Object | getAttribute(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. | | public Enumeration | getAttributeNames()
| | 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. | | public java.lang.String | getInitParameter(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". | | 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. | | public int | getMajorVersion()
Returns the major version of the Java Servlet API that this servlet container supports. | | public java.lang.String | getMimeType(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. | | public int | getMinorVersion()
Returns the minor version of the Servlet API that this servlet container supports. | | 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. | | public String | getRealPath(String path)
Returns a String containing the real path for a given virtual path. | | public javax.servlet.RequestDispatcher | getRequestDispatcher(String path)
Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path. | | public java.net.URL | getResource(String path)
Returns a URL to the resource that is mapped to a specified path. | | public java.io.InputStream | getResourceAsStream(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. | | public Set | getResourcePaths(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. | | public 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. | | public javax.servlet.Servlet | getServlet(java.lang.String A)
| | public 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. | | public java.util.Enumeration | getServletNames()
| | public java.util.Enumeration | getServlets()
| | public void | log(String message)
Writes the specified message to a servlet log file, usually an event log. | | public void | log(Exception e, String message)
| | public void | log(String message, Throwable t)
Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file. | | public void | removeAttribute(String name)
| | void | removeInitParameter(String name)
| | public void | setAttribute(String name, Object attribute)
| | void | setInitParameter(String name, Object initParameter)
|
| getAttribute | | public Object getAttribute(String name)(Code) | | 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.
|
| getContext | | public javax.servlet.ServletContext getContext(java.lang.String A)(Code) | | 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.
|
| getInitParameter | | public java.lang.String getInitParameter(String name)(Code) | | 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.
|
| getInitParameterNames | | public java.util.Enumeration getInitParameterNames()(Code) | | 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.
|
| getMajorVersion | | public int getMajorVersion()(Code) | | 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.
|
| getMimeType | | public java.lang.String getMimeType(String filePath)(Code) | | 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".
|
| getMinorVersion | | public int getMinorVersion()(Code) | | 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.
|
| getNamedDispatcher | | public javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String A)(Code) | | 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.
|
| getRealPath | | public String getRealPath(String path)(Code) | | 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).
|
| getRequestDispatcher | | public javax.servlet.RequestDispatcher getRequestDispatcher(String path)(Code) | | 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.
|
| getResource | | public java.net.URL getResource(String path)(Code) | | 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.
|
| getResourceAsStream | | public java.io.InputStream getResourceAsStream(String path)(Code) | | 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.
|
| getResourcePaths | | public Set getResourcePaths(String path)(Code) | | 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/"}.
Parameters:
path - partial path used to match the resources, which must start with a / a Set containing the directory listing, or null if there are no resourcesin the web application whose path begins with the supplied path.
since:
HttpUnit 1.3 |
| getServerInfo | | public String getServerInfo()(Code) | | 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).
|
| getServletContextName | | public String getServletContextName()(Code) | | 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.
The name of the web application or null if no name has been declared in the deployment descriptor
since:
HttpUnit 1.3 |
| log | | public void log(String message)(Code) | | 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.
|
| log | | public void log(String message, Throwable t)(Code) | | 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.
|
| removeAttribute | | public void removeAttribute(String name)(Code) | | |
| removeInitParameter | | void removeInitParameter(String name)(Code) | | |
|
|