Java Doc for ServletContextSimulator.java in » Testing » StrutsTestCase » servletunit » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation

1.	6.0 JDK Core
2.	6.0 JDK Modules
3.	6.0 JDK Modules com.sun
4.	6.0 JDK Modules com.sun.java
5.	6.0 JDK Modules sun
6.	6.0 JDK Platform
7.	Ajax
8.	Apache Harmony Java SE
9.	Aspect oriented
10.	Authentication Authorization
11.	Blogger System
12.	Build
13.	Byte Code
14.	Cache
15.	Chart
16.	Chat
17.	Code Analyzer
18.	Collaboration
19.	Content Management System
20.	Database Client
21.	Database DBMS
22.	Database JDBC Connection Pool
23.	Database ORM
24.	Development
25.	EJB Server geronimo
26.	EJB Server GlassFish
27.	EJB Server JBoss 4.2.1
28.	EJB Server resin 3.1.5
29.	ERP CRM Financial
30.	ESB
31.	Forum
32.	GIS
33.	Graphic Library
34.	Groupware
35.	HTML Parser
36.	IDE
37.	IDE Eclipse
38.	IDE Netbeans
39.	Installer
40.	Internationalization Localization
41.	Inversion of Control
42.	Issue Tracking
43.	J2EE
44.	JBoss
45.	JMS
46.	JMX
47.	Library
48.	Mail Clients
49.	Net
50.	Parser
51.	PDF
52.	Portal
53.	Profiler
54.	Project Management
55.	Report
56.	RSS RDF
57.	Rule Engine
58.	Science
59.	Scripting
60.	Search Engine
61.	Security
62.	Sevlet Container
63.	Source Control
64.	Swing Library
65.	Template Engine
66.	Test Coverage
67.	Testing
68.	UML
69.	Web Crawler
70.	Web Framework
71.	Web Mail
72.	Web Server
73.	Web Services
74.	Web Services apache cxf 2.0.1
75.	Web Services AXIS2
76.	Wiki Engine
77.	Workflow Engines
78.	XML
79.	XML UI

Java

Java Tutorial

Illustrator Tutorials

GIMP Tutorials

C# / C Sharp

C# / CSharp Tutorial

C# / CSharp Open Source

SQL Server / T-SQL Tutorial

Oracle PL / SQL

Oracle PL/SQL Tutorial

Flash / Flex / ActionScript

VBA / Excel / Access / Word

XML

XML Tutorial

Microsoft Office PowerPoint 2007 Tutorial

Microsoft Office Excel 2007 Tutorial

Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Testing » StrutsTestCase » servletunit

Source Cross Reference Class Diagram Java Document (Java Doc)

java.lang .Object

servletunit .ServletContextSimulator

ServletContextSimulator
public class ServletContextSimulator implements ServletContext(Code)
	This class simulates a ServletContext.

Constructor Summary
public	ServletContextSimulator()

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() Returns an `Enumeration` containing the attribute names available within this servlet context.
public ServletContext	getContext(String uripath) Unsupported in this version.
public File	getContextDirectory()
public String	getInitParameter(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".
public 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 Web server supports.
public String	getMimeType(String file) Unsupported in this version.
public int	getMinorVersion() Returns the minor version of the Servlet API that this Web server supports.
public RequestDispatcher	getNamedDispatcher(String s)
public String	getRealPath(String path)
public RequestDispatcher	getRequestDispatcher(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.
public RequestDispatcherSimulator	getRequestDispatcherSimulator() Returns the mock RequestDispatcher object used in this test.
public URL	getResource(String path)
public File	getResourceAsFile(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.
public 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() Unsupported in this version.
public Set	getResourcePaths(String path) Unsupported in this version.
public String	getServerInfo() Returns the name and version of the servlet container on which the servlet is running.
public Servlet	getServlet(String name) Unsupported in this version.
public String	getServletContextName() Unsupported in this version.
public Enumeration	getServletNames() Unsupported in this version.
public Enumeration	getServlets() Unsupported in this version.
public void	log(Exception exception, String msg)
public void	log(String msg) Writes the specified message to a servlet log file, which is usually an event log.
public void	log(String message, Throwable throwable) Writes the stack trace and an explanatory message for a given `Throwable` exception to the servlet log file.
public void	removeAttribute(String name) Removes the attribute with the given name from the servlet context.
public void	setAttribute(String name, Object object) Binds an object to a given attribute name in this servlet context.
public void	setContextDirectory(File contextDirectory) Sets the absolute context directory to be used in the getRealPath() method.
public void	setInitParameter(String key, String value) Sets a named initialization parameter with the supplied `String` value.

Constructor Detail

ServletContextSimulator
public ServletContextSimulator()(Code)

Method Detail

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`. 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 nameof the attribute an `Object` containing the valueof the attribute, or `null`if no attribute exists matching the givenname See Also: ServletContext.getAttributeNames

getAttributeNames
public Enumeration getAttributeNames()(Code)
	Returns an `Enumeration` containing the attribute names available within this servlet context. Use the ServletContextSimulator.getAttribute method with an attribute name to get the value of an attribute. an `Enumeration` of attributenames See Also: ServletContextSimulator.getAttribute

getContext
public ServletContext getContext(String uripath)(Code)
	Unsupported in this version.

getContextDirectory
public File getContextDirectory()(Code)

getInitParameter
public String getInitParameter(String s)(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. Parameters: s - a `String` containing the name of theparameter whose value is requested a `String` containing at least theservlet container name and version number See Also: javax.servlet.ServletConfig.getInitParameter

getInitParameterNames
public 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. an `Enumeration` of `String`objects containing the names of the context'sinitialization parameters See Also: javax.servlet.ServletConfig.getInitParameter

getMajorVersion
public int getMajorVersion()(Code)
	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. 2

getMimeType
public String getMimeType(String file)(Code)
	Unsupported in this version.

getMinorVersion
public int getMinorVersion()(Code)
	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. 3

getNamedDispatcher
public RequestDispatcher getNamedDispatcher(String s)(Code)

getRealPath
public String getRealPath(String path)(Code)

getRequestDispatcher
public RequestDispatcher getRequestDispatcher(String urlpath)(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`. Parameters: urlpath - a `String` specifying the pathnameto the resource a `RequestDispatcher` objectthat acts as a wrapper for the resourceat the specified path See Also: RequestDispatcher See Also: ServletContext.getContext

getRequestDispatcherSimulator
public RequestDispatcherSimulator getRequestDispatcherSimulator()(Code)
	Returns the mock RequestDispatcher object used in this test. The RequestDispatcherSimulator contains forwarding information that can be used in test validation.

getResource
public URL getResource(String path) throws MalformedURLException(Code)
	TODO: add appropriate comments

getResourceAsFile
public File getResourceAsFile(String path)(Code)
	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 the refernce to the file (which may or may not exist)

getResourceAsStream

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

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 pathto the resource the InputStream returned to theservlet, or null if no resourceexists at the specified path

getResourcePaths
public Set getResourcePaths()(Code)
	Unsupported in this version.

getResourcePaths
public Set getResourcePaths(String path)(Code)
	Unsupported in this version.

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). a String containing at least theservlet container name and version number

getServlet
public Servlet getServlet(String name) throws ServletException(Code)
	Unsupported in this version.

getServletContextName
public String getServletContextName()(Code)
	Unsupported in this version.

getServletNames
public Enumeration getServletNames()(Code)
	Unsupported in this version.

getServlets
public Enumeration getServlets()(Code)
	Unsupported in this version.

log
public void log(Exception exception, String msg)(Code)
	ServletContext.log(String message, Throwable throwable)instead. This method was originally defined to write anexception's stack trace and an explanatory error messageto the servlet log file.

log
public void log(String msg)(Code)
	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 explanatorymessage to be written to the log file

log
public void log(String message, Throwable throwable)(Code)
	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` thatdescribes the error or exception Parameters: throwable - the `Throwable` erroror exception

removeAttribute
public void removeAttribute(String name)(Code)
	Removes the attribute with the given name from the servlet context. After removal, subsequent calls to ServletContextSimulator.getAttribute 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 nameof the attribute to be removed

setAttribute

public void setAttribute(String name, Object object)(Code)

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 nameof the attribute
Parameters:
object - an Object representing theattribute to be bound

setContextDirectory
public void setContextDirectory(File contextDirectory)(Code)
	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.

setInitParameter
public void setInitParameter(String key, String value)(Code)
	Sets a named initialization parameter with the supplied `String` value. Parameters: key - a `String` specifying the nameof the initialization parameter Parameters: value - a `String` value for this initializationparameter

Methods inherited from java.lang.Object

native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
protected void finalize() throws Throwable(Code)(Java Doc)
final native public Class getClass()(Code)(Java Doc)
native public int hashCode()(Code)(Java Doc)
final native public void notify()(Code)(Java Doc)
final native public void notifyAll()(Code)(Java Doc)
public String toString()(Code)(Java Doc)
final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc)
final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc)
final public void wait() throws InterruptedException(Code)(Java Doc)

www.java2java.com | Contact Us

All other trademarks are property of their respective owners.