|
spring-test | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectorg.springframework.mock.web.MockServletContext
public class MockServletContext
Mock implementation of the ServletContext interface.
Compatible with Servlet 2.5 and partially with Servlet 3.0. Can be configured to
expose a specific version through setMajorVersion(int)/setMinorVersion(int);
default is 2.5. Note that Servlet 3.0 support is limited: servlet, filter and listener
registration methods are not supported; neither is cookie or JSP configuration.
We generally do not recommend to unit-test your ServletContainerInitializers and
WebApplicationInitializers which is where those registration methods would be used.
Used for testing the Spring web framework; only rarely necessary for testing application controllers. As long as application components don't explicitly access the ServletContext, ClassPathXmlApplicationContext or FileSystemXmlApplicationContext can be used to load the context files for testing, even for DispatcherServlet context definitions.
For setting up a full WebApplicationContext in a test environment, you can use XmlWebApplicationContext (or GenericWebApplicationContext), passing in an appropriate MockServletContext instance. You might want to configure your MockServletContext with a FileSystemResourceLoader in that case, to make your resource paths interpreted as relative file system locations.
A common setup is to point your JVM working directory to the root of your web application directory, in combination with filesystem-based resource loading. This allows to load the context files as used in the web application, with relative paths getting interpreted correctly. Such a setup will work with both FileSystemXmlApplicationContext (which will load straight from the file system) and XmlWebApplicationContext with an underlying MockServletContext (as long as the MockServletContext has been configured with a FileSystemResourceLoader).
MockServletContext(org.springframework.core.io.ResourceLoader),
org.springframework.web.context.support.XmlWebApplicationContext,
org.springframework.web.context.support.GenericWebApplicationContext,
ClassPathXmlApplicationContext,
FileSystemXmlApplicationContext| Constructor Summary | |
|---|---|
MockServletContext()
Create a new MockServletContext, using no base path and a DefaultResourceLoader (i.e. |
|
MockServletContext(org.springframework.core.io.ResourceLoader resourceLoader)
Create a new MockServletContext, using the specified ResourceLoader and no base path. |
|
MockServletContext(java.lang.String resourceBasePath)
Create a new MockServletContext, using a DefaultResourceLoader. |
|
MockServletContext(java.lang.String resourceBasePath,
org.springframework.core.io.ResourceLoader resourceLoader)
Create a new MockServletContext. |
|
| Method Summary | |
|---|---|
void |
addInitParameter(java.lang.String name,
java.lang.String value)
|
void |
declareRoles(java.lang.String... roleNames)
|
java.lang.Object |
getAttribute(java.lang.String name)
|
java.util.Enumeration<java.lang.String> |
getAttributeNames()
|
java.lang.ClassLoader |
getClassLoader()
|
javax.servlet.ServletContext |
getContext(java.lang.String contextPath)
|
java.lang.String |
getContextPath()
|
java.util.Set<java.lang.String> |
getDeclaredRoles()
|
int |
getEffectiveMajorVersion()
|
int |
getEffectiveMinorVersion()
|
java.lang.String |
getInitParameter(java.lang.String name)
|
java.util.Enumeration<java.lang.String> |
getInitParameterNames()
|
int |
getMajorVersion()
|
java.lang.String |
getMimeType(java.lang.String filePath)
|
int |
getMinorVersion()
|
javax.servlet.RequestDispatcher |
getNamedDispatcher(java.lang.String path)
|
java.lang.String |
getRealPath(java.lang.String path)
|
javax.servlet.RequestDispatcher |
getRequestDispatcher(java.lang.String path)
|
java.net.URL |
getResource(java.lang.String path)
|
java.io.InputStream |
getResourceAsStream(java.lang.String path)
|
protected java.lang.String |
getResourceLocation(java.lang.String path)
Build a full resource location for the given path, prepending the resource base path of this MockServletContext. |
java.util.Set<java.lang.String> |
getResourcePaths(java.lang.String path)
|
java.lang.String |
getServerInfo()
|
javax.servlet.Servlet |
getServlet(java.lang.String name)
|
java.lang.String |
getServletContextName()
|
java.util.Enumeration<java.lang.String> |
getServletNames()
|
java.util.Enumeration<javax.servlet.Servlet> |
getServlets()
|
void |
log(java.lang.Exception ex,
java.lang.String message)
|
void |
log(java.lang.String message)
|
void |
log(java.lang.String message,
java.lang.Throwable ex)
|
void |
registerContext(java.lang.String contextPath,
javax.servlet.ServletContext context)
|
void |
removeAttribute(java.lang.String name)
|
void |
setAttribute(java.lang.String name,
java.lang.Object value)
|
void |
setContextPath(java.lang.String contextPath)
|
void |
setEffectiveMajorVersion(int effectiveMajorVersion)
|
void |
setEffectiveMinorVersion(int effectiveMinorVersion)
|
boolean |
setInitParameter(java.lang.String name,
java.lang.String value)
|
void |
setMajorVersion(int majorVersion)
|
void |
setMinorVersion(int minorVersion)
|
void |
setServletContextName(java.lang.String servletContextName)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Constructor Detail |
|---|
public MockServletContext()
DefaultResourceLoaderpublic MockServletContext(java.lang.String resourceBasePath)
resourceBasePath - the WAR root directory (should not end with a slash)DefaultResourceLoaderpublic MockServletContext(org.springframework.core.io.ResourceLoader resourceLoader)
resourceLoader - the ResourceLoader to use (or null for the default)
public MockServletContext(java.lang.String resourceBasePath,
org.springframework.core.io.ResourceLoader resourceLoader)
resourceBasePath - the WAR root directory (should not end with a slash)resourceLoader - the ResourceLoader to use (or null for the default)| Method Detail |
|---|
protected java.lang.String getResourceLocation(java.lang.String path)
path - the path as specified
public void setContextPath(java.lang.String contextPath)
public java.lang.String getContextPath()
getContextPath in interface javax.servlet.ServletContext
public void registerContext(java.lang.String contextPath,
javax.servlet.ServletContext context)
public javax.servlet.ServletContext getContext(java.lang.String contextPath)
getContext in interface javax.servlet.ServletContextpublic void setMajorVersion(int majorVersion)
public int getMajorVersion()
getMajorVersion in interface javax.servlet.ServletContextpublic void setMinorVersion(int minorVersion)
public int getMinorVersion()
getMinorVersion in interface javax.servlet.ServletContextpublic void setEffectiveMajorVersion(int effectiveMajorVersion)
public int getEffectiveMajorVersion()
public void setEffectiveMinorVersion(int effectiveMinorVersion)
public int getEffectiveMinorVersion()
public java.lang.String getMimeType(java.lang.String filePath)
getMimeType in interface javax.servlet.ServletContextpublic java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
getResourcePaths in interface javax.servlet.ServletContext
public java.net.URL getResource(java.lang.String path)
throws java.net.MalformedURLException
getResource in interface javax.servlet.ServletContextjava.net.MalformedURLExceptionpublic java.io.InputStream getResourceAsStream(java.lang.String path)
getResourceAsStream in interface javax.servlet.ServletContextpublic javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
getRequestDispatcher in interface javax.servlet.ServletContextpublic javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String path)
getNamedDispatcher in interface javax.servlet.ServletContextpublic javax.servlet.Servlet getServlet(java.lang.String name)
getServlet in interface javax.servlet.ServletContextpublic java.util.Enumeration<javax.servlet.Servlet> getServlets()
getServlets in interface javax.servlet.ServletContextpublic java.util.Enumeration<java.lang.String> getServletNames()
getServletNames in interface javax.servlet.ServletContextpublic void log(java.lang.String message)
log in interface javax.servlet.ServletContext
public void log(java.lang.Exception ex,
java.lang.String message)
log in interface javax.servlet.ServletContext
public void log(java.lang.String message,
java.lang.Throwable ex)
log in interface javax.servlet.ServletContextpublic java.lang.String getRealPath(java.lang.String path)
getRealPath in interface javax.servlet.ServletContextpublic java.lang.String getServerInfo()
getServerInfo in interface javax.servlet.ServletContextpublic java.lang.String getInitParameter(java.lang.String name)
getInitParameter in interface javax.servlet.ServletContextpublic java.util.Enumeration<java.lang.String> getInitParameterNames()
getInitParameterNames in interface javax.servlet.ServletContext
public boolean setInitParameter(java.lang.String name,
java.lang.String value)
public void addInitParameter(java.lang.String name,
java.lang.String value)
public java.lang.Object getAttribute(java.lang.String name)
getAttribute in interface javax.servlet.ServletContextpublic java.util.Enumeration<java.lang.String> getAttributeNames()
getAttributeNames in interface javax.servlet.ServletContext
public void setAttribute(java.lang.String name,
java.lang.Object value)
setAttribute in interface javax.servlet.ServletContextpublic void removeAttribute(java.lang.String name)
removeAttribute in interface javax.servlet.ServletContextpublic void setServletContextName(java.lang.String servletContextName)
public java.lang.String getServletContextName()
getServletContextName in interface javax.servlet.ServletContextpublic java.lang.ClassLoader getClassLoader()
public void declareRoles(java.lang.String... roleNames)
public java.util.Set<java.lang.String> getDeclaredRoles()
|
spring-test | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||