Class ServletUnitServletContext
- All Implemented Interfaces:
javax.servlet.ServletContext
-
Field Summary
FieldsFields inherited from interface javax.servlet.ServletContext
ORDERED_LIBS, TEMPDIR
-
Method Summary
Modifier and TypeMethodDescriptionjavax.servlet.FilterRegistration.Dynamic
javax.servlet.FilterRegistration.Dynamic
javax.servlet.FilterRegistration.Dynamic
void
addListener
(Class<? extends EventListener> listenerClass) void
addListener
(String className) <T extends EventListener>
voidaddListener
(T t) javax.servlet.ServletRegistration.Dynamic
addServlet
(String servletName, Class<? extends javax.servlet.Servlet> servletClass) javax.servlet.ServletRegistration.Dynamic
addServlet
(String servletName, String className) javax.servlet.ServletRegistration.Dynamic
addServlet
(String servletName, javax.servlet.Servlet servlet) <T extends javax.servlet.Filter>
TcreateFilter
(Class<T> clazz) <T extends EventListener>
TcreateListener
(Class<T> clazz) <T extends javax.servlet.Servlet>
TcreateServlet
(Class<T> clazz) void
declareRoles
(String... roleNames) getAttribute
(String name) Returns the servlet container attribute with the given name, or null if there is no attribute by that name.javax.servlet.ServletContext
getContext
(String A) Returns a ServletContext object that corresponds to a specified URL on the server.Set<javax.servlet.SessionTrackingMode>
int
int
Set<javax.servlet.SessionTrackingMode>
javax.servlet.FilterRegistration
getFilterRegistration
(String filterName) getInitParameter
(String name) Returns a String containing the value of the named context-wide initialization parameter, or null if the parameter does not exist.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
int
Returns the major version of the Java Servlet API that this servlet container supports.getMimeType
(String filePath) Returns the MIME type of the specified file, or null if the MIME type is not known.int
Returns the minor version of the Servlet API that this servlet container supports.javax.servlet.RequestDispatcher
Returns a RequestDispatcher object that acts as a wrapper for the named servlet.getRealPath
(String path) Returns a String containing the real path for a given virtual path.javax.servlet.RequestDispatcher
getRequestDispatcher
(String path) Returns a RequestDispatcher object that acts as a wrapper for the resource located at the given path.getResource
(String path) Returns a URL to the resource that is mapped to a specified path.getResourceAsStream
(String path) Returns the resource located at the named path as an InputStream object.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.Returns the name and version of the servlet container on which the servlet is running.javax.servlet.Servlet
getServlet
(String A) Deprecated.as of Servlet API 2.1Returns 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.Deprecated.as of Servlet API 2.1javax.servlet.ServletRegistration
getServletRegistration
(String servletName) Deprecated.as of Servlet API 2.0javax.servlet.SessionCookieConfig
void
Deprecated.use log( String, Throwable )void
Writes the specified message to a servlet log file, usually an event log.void
Writes an explanatory message and a stack trace for a given Throwable exception to the servlet log file.void
removeAttribute
(String name) void
setAttribute
(String name, Object attribute) boolean
setInitParameter
(String name, String value) void
setLogStream
(PrintStream logStream) Allows the test to determine where the log messages should be written.void
setSessionTrackingModes
(Set<javax.servlet.SessionTrackingMode> sessionTrackingModes) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface javax.servlet.ServletContext
addJspFile, getRequestCharacterEncoding, getResponseCharacterEncoding, getSessionTimeout, setRequestCharacterEncoding, setResponseCharacterEncoding, setSessionTimeout
-
Field Details
-
DEFAULT_SERVER_INFO
- See Also:
-
-
Method Details
-
getContext
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
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
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
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
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
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
Deprecated.as of Servlet API 2.1- Specified by:
getServlet
in interfacejavax.servlet.ServletContext
-
getServlets
Deprecated.as of Servlet API 2.0- Specified by:
getServlets
in interfacejavax.servlet.ServletContext
-
getServletNames
Deprecated.as of Servlet API 2.1- Specified by:
getServletNames
in interfacejavax.servlet.ServletContext
-
log
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
Deprecated.use log( String, Throwable )- Specified by:
log
in interfacejavax.servlet.ServletContext
-
log
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
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
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
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
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
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
- Specified by:
getAttributeNames
in interfacejavax.servlet.ServletContext
-
setAttribute
- Specified by:
setAttribute
in interfacejavax.servlet.ServletContext
-
removeAttribute
- Specified by:
removeAttribute
in interfacejavax.servlet.ServletContext
-
getResourcePaths
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
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
- 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
- Specified by:
setInitParameter
in interfacejavax.servlet.ServletContext
-
addServlet
- Specified by:
addServlet
in interfacejavax.servlet.ServletContext
-
addServlet
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName, javax.servlet.Servlet servlet) - Specified by:
addServlet
in interfacejavax.servlet.ServletContext
-
addServlet
public javax.servlet.ServletRegistration.Dynamic addServlet(String servletName, Class<? extends javax.servlet.Servlet> servletClass) - Specified by:
addServlet
in interfacejavax.servlet.ServletContext
-
createServlet
public <T extends javax.servlet.Servlet> T createServlet(Class<T> clazz) throws javax.servlet.ServletException - Specified by:
createServlet
in interfacejavax.servlet.ServletContext
- Throws:
javax.servlet.ServletException
-
getServletRegistration
- Specified by:
getServletRegistration
in interfacejavax.servlet.ServletContext
-
getServletRegistrations
- Specified by:
getServletRegistrations
in interfacejavax.servlet.ServletContext
-
addFilter
- Specified by:
addFilter
in interfacejavax.servlet.ServletContext
-
addFilter
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName, javax.servlet.Filter filter) - Specified by:
addFilter
in interfacejavax.servlet.ServletContext
-
addFilter
public javax.servlet.FilterRegistration.Dynamic addFilter(String filterName, Class<? extends javax.servlet.Filter> filterClass) - Specified by:
addFilter
in interfacejavax.servlet.ServletContext
-
createFilter
public <T extends javax.servlet.Filter> T createFilter(Class<T> clazz) throws javax.servlet.ServletException - Specified by:
createFilter
in interfacejavax.servlet.ServletContext
- Throws:
javax.servlet.ServletException
-
getFilterRegistration
- Specified by:
getFilterRegistration
in interfacejavax.servlet.ServletContext
-
getFilterRegistrations
- Specified by:
getFilterRegistrations
in interfacejavax.servlet.ServletContext
-
getSessionCookieConfig
public javax.servlet.SessionCookieConfig getSessionCookieConfig()- Specified by:
getSessionCookieConfig
in interfacejavax.servlet.ServletContext
-
setSessionTrackingModes
- Specified by:
setSessionTrackingModes
in interfacejavax.servlet.ServletContext
-
getDefaultSessionTrackingModes
- Specified by:
getDefaultSessionTrackingModes
in interfacejavax.servlet.ServletContext
-
getEffectiveSessionTrackingModes
- Specified by:
getEffectiveSessionTrackingModes
in interfacejavax.servlet.ServletContext
-
addListener
- Specified by:
addListener
in interfacejavax.servlet.ServletContext
-
addListener
- Specified by:
addListener
in interfacejavax.servlet.ServletContext
-
addListener
- Specified by:
addListener
in interfacejavax.servlet.ServletContext
-
createListener
public <T extends EventListener> T createListener(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
- Specified by:
getClassLoader
in interfacejavax.servlet.ServletContext
-
declareRoles
- Specified by:
declareRoles
in interfacejavax.servlet.ServletContext
-
getVirtualServerName
- Specified by:
getVirtualServerName
in interfacejavax.servlet.ServletContext
-
setLogStream
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:
-