org.springframework.mock.web

Class MockServletContext

java.lang.Object

org.springframework.mock.web.MockServletContext

public class MockServletContext
extends java.lang.Object

Mock implementation of the javax.servlet.ServletContext interface.

As of Spring 5.0, this set of mocks is designed on a Servlet 4.0 baseline.

Compatible with Servlet 3.1 but can be configured to expose a specific version through setMajorVersion(int)/setMinorVersion(int); default is 3.1. Note that Servlet 3.1 support is limited: servlet, filter and listener registration methods are not supported; neither is JSP configuration. We generally do not recommend to unit test your ServletContainerInitializers and WebApplicationInitializers which is where those registration methods would be used.

For setting up a full WebApplicationContext in a test environment, you can use AnnotationConfigWebApplicationContext, XmlWebApplicationContext, or GenericWebApplicationContext, passing in a corresponding MockServletContext instance. Consider configuring your MockServletContext with a FileSystemResourceLoader in order to interpret resource paths as relative filesystem locations.

Since:

1.0.2

Author:

Rod Johnson, Juergen Hoeller, Sam Brannen

See Also:

MockServletContext(org.springframework.core.io.ResourceLoader), AnnotationConfigWebApplicationContext, XmlWebApplicationContext, GenericWebApplicationContext

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.Map<java.lang.String,java.lang.Object>	attributes
private static java.lang.String	COMMON_DEFAULT_SERVLET_NAME Default Servlet name used by Tomcat, Jetty, JBoss, and GlassFish: "default"
private java.lang.String	contextPath
private java.util.Map<java.lang.String,ServletContext>	contexts
private java.util.Set<java.lang.String>	declaredRoles
private static java.util.Set<SessionTrackingMode>	DEFAULT_SESSION_TRACKING_MODES
private java.lang.String	defaultServletName
private int	effectiveMajorVersion
private int	effectiveMinorVersion
private java.util.Map<java.lang.String,java.lang.String>	initParameters
private Log	logger
private int	majorVersion
private int	minorVersion
private java.util.Map<java.lang.String,RequestDispatcher>	namedRequestDispatchers
private java.lang.String	resourceBasePath
private ResourceLoader	resourceLoader
private java.lang.String	servletContextName
private SessionCookieConfig	sessionCookieConfig
private int	sessionTimeout
private java.util.Set<SessionTrackingMode>	sessionTrackingModes
private static java.lang.String	TEMP_DIR_SYSTEM_PROPERTY

Constructor Summary

Constructors

Constructor and Description
MockServletContext() Create a new MockServletContext, using no base path and a DefaultResourceLoader (i.e.
MockServletContext(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, ResourceLoader resourceLoader) Create a new MockServletContext using the supplied resource base path and resource loader.

Method Summary

Modifier and Type	Method and Description
FilterRegistration.Dynamic	addFilter(java.lang.String filterName, java.lang.Class<? extends Filter> filterClass)
FilterRegistration.Dynamic	addFilter(java.lang.String filterName, Filter filter)
FilterRegistration.Dynamic	addFilter(java.lang.String filterName, java.lang.String className)
void	addInitParameter(java.lang.String name, java.lang.String value)
ServletRegistration.Dynamic	addJspFile(java.lang.String servletName, java.lang.String jspFile)
void	addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
void	addListener(java.lang.String className)
<T extends java.util.EventListener> void	addListener(T t)
ServletRegistration.Dynamic	addServlet(java.lang.String servletName, java.lang.Class<? extends Servlet> servletClass)
ServletRegistration.Dynamic	addServlet(java.lang.String servletName, Servlet servlet)
ServletRegistration.Dynamic	addServlet(java.lang.String servletName, java.lang.String className)
<T extends Filter> T	createFilter(java.lang.Class<T> c)
<T extends java.util.EventListener> T	createListener(java.lang.Class<T> c)
<T extends Servlet> T	createServlet(java.lang.Class<T> c)
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()
ServletContext	getContext(java.lang.String contextPath)
java.lang.String	getContextPath()
java.util.Set<java.lang.String>	getDeclaredRoles()
java.lang.String	getDefaultServletName() Get the name of the default Servlet.
java.util.Set<SessionTrackingMode>	getDefaultSessionTrackingModes()
int	getEffectiveMajorVersion()
int	getEffectiveMinorVersion()
java.util.Set<SessionTrackingMode>	getEffectiveSessionTrackingModes()
FilterRegistration	getFilterRegistration(java.lang.String filterName) This method always returns null.
java.util.Map<java.lang.String,? extends FilterRegistration>	getFilterRegistrations() This method always returns an empty map.
java.lang.String	getInitParameter(java.lang.String name)
java.util.Enumeration<java.lang.String>	getInitParameterNames()
JspConfigDescriptor	getJspConfigDescriptor()
int	getMajorVersion()
java.lang.String	getMimeType(java.lang.String filePath) This method uses the default FileTypeMap from the Java Activation Framework to resolve MIME types.
int	getMinorVersion()
RequestDispatcher	getNamedDispatcher(java.lang.String path)
java.lang.String	getRealPath(java.lang.String path)
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()
Servlet	getServlet(java.lang.String name) Deprecated.
java.lang.String	getServletContextName()
java.util.Enumeration<java.lang.String>	getServletNames() Deprecated.
ServletRegistration	getServletRegistration(java.lang.String servletName) This method always returns null.
java.util.Map<java.lang.String,? extends ServletRegistration>	getServletRegistrations() This method always returns an empty map.
java.util.Enumeration<Servlet>	getServlets() Deprecated.
SessionCookieConfig	getSessionCookieConfig()
int	getSessionTimeout()
java.lang.String	getVirtualServerName()
void	log(java.lang.Exception ex, java.lang.String message) Deprecated.
void	log(java.lang.String message)
void	log(java.lang.String message, java.lang.Throwable ex)
void	registerContext(java.lang.String contextPath, ServletContext context)
void	registerNamedDispatcher(java.lang.String name, RequestDispatcher requestDispatcher) Register a RequestDispatcher (typically a MockRequestDispatcher) that acts as a wrapper for the named Servlet.
void	removeAttribute(java.lang.String name)
void	setAttribute(java.lang.String name, java.lang.Object value)
void	setContextPath(java.lang.String contextPath)
void	setDefaultServletName(java.lang.String defaultServletName) Set the name of the default Servlet.
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)
void	setSessionTimeout(int sessionTimeout)
void	setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)
void	unregisterNamedDispatcher(java.lang.String name) Unregister the RequestDispatcher with the given name.

Methods inherited from class java.lang.Object

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

Field Detail

COMMON_DEFAULT_SERVLET_NAME

private static final java.lang.String COMMON_DEFAULT_SERVLET_NAME

Default Servlet name used by Tomcat, Jetty, JBoss, and GlassFish: "default"

See Also:

Constant Field Values

TEMP_DIR_SYSTEM_PROPERTY

private static final java.lang.String TEMP_DIR_SYSTEM_PROPERTY

See Also:

Constant Field Values

DEFAULT_SESSION_TRACKING_MODES

private static final java.util.Set<SessionTrackingMode> DEFAULT_SESSION_TRACKING_MODES

logger

private final Log logger

resourceLoader

private final ResourceLoader resourceLoader

resourceBasePath

private final java.lang.String resourceBasePath

contextPath

private java.lang.String contextPath

contexts

private final java.util.Map<java.lang.String,ServletContext> contexts

majorVersion

private int majorVersion

minorVersion

private int minorVersion

effectiveMajorVersion

private int effectiveMajorVersion

effectiveMinorVersion

private int effectiveMinorVersion

namedRequestDispatchers

private final java.util.Map<java.lang.String,RequestDispatcher> namedRequestDispatchers

defaultServletName

private java.lang.String defaultServletName

initParameters

private final java.util.Map<java.lang.String,java.lang.String> initParameters

attributes

private final java.util.Map<java.lang.String,java.lang.Object> attributes

servletContextName

private java.lang.String servletContextName

declaredRoles

private final java.util.Set<java.lang.String> declaredRoles

sessionTrackingModes

private java.util.Set<SessionTrackingMode> sessionTrackingModes

sessionCookieConfig

private final SessionCookieConfig sessionCookieConfig

sessionTimeout

private int sessionTimeout

Constructor Detail

MockServletContext

public MockServletContext()

Create a new MockServletContext, using no base path and a DefaultResourceLoader (i.e. the classpath root as WAR root).

See Also:

DefaultResourceLoader

MockServletContext

public MockServletContext(java.lang.String resourceBasePath)

Create a new MockServletContext, using a DefaultResourceLoader.

Parameters:

resourceBasePath - the root directory of the WAR (should not end with a slash)

See Also:

DefaultResourceLoader

MockServletContext

public MockServletContext(ResourceLoader resourceLoader)

Create a new MockServletContext, using the specified ResourceLoader and no base path.

Parameters:

resourceLoader - the ResourceLoader to use (or null for the default)

MockServletContext

public MockServletContext(java.lang.String resourceBasePath,
                          ResourceLoader resourceLoader)

Create a new MockServletContext using the supplied resource base path and resource loader.

Registers a MockRequestDispatcher for the Servlet named 'default'.

Parameters:

resourceBasePath - the root directory of the WAR (should not end with a slash)

resourceLoader - the ResourceLoader to use (or null for the default)

See Also:

registerNamedDispatcher(java.lang.String, RequestDispatcher)

Method Detail

getResourceLocation

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.

Parameters:

path - the path as specified

Returns:

the full resource path

setContextPath

public void setContextPath(java.lang.String contextPath)

getContextPath

public java.lang.String getContextPath()

registerContext

public void registerContext(java.lang.String contextPath,
                            ServletContext context)

getContext

public ServletContext getContext(java.lang.String contextPath)

setMajorVersion

public void setMajorVersion(int majorVersion)

getMajorVersion

public int getMajorVersion()

setMinorVersion

public void setMinorVersion(int minorVersion)

getMinorVersion

public int getMinorVersion()

setEffectiveMajorVersion

public void setEffectiveMajorVersion(int effectiveMajorVersion)

getEffectiveMajorVersion

public int getEffectiveMajorVersion()

setEffectiveMinorVersion

public void setEffectiveMinorVersion(int effectiveMinorVersion)

getEffectiveMinorVersion

public int getEffectiveMinorVersion()

getMimeType

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

This method uses the default FileTypeMap from the Java Activation Framework to resolve MIME types.

The Java Activation Framework returns "application/octet-stream" if the MIME type is unknown (i.e., it never returns null). Thus, in order to honor the ServletContext#getMimeType(String) contract, this method returns null if the MIME type is "application/octet-stream".

MockServletContext does not provide a direct mechanism for setting a custom MIME type; however, if the default FileTypeMap is an instance of javax.activation.MimetypesFileTypeMap, a custom MIME type named text/enigma can be registered for a custom .puzzle file extension in the following manner:

 MimetypesFileTypeMap mimetypesFileTypeMap = (MimetypesFileTypeMap) FileTypeMap.getDefaultFileTypeMap();
 mimetypesFileTypeMap.addMimeTypes("text/enigma    puzzle");
 

getResourcePaths

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

getResource

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

Throws:

java.net.MalformedURLException

getResourceAsStream

public java.io.InputStream getResourceAsStream(java.lang.String path)

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String path)

getNamedDispatcher

public RequestDispatcher getNamedDispatcher(java.lang.String path)

registerNamedDispatcher

public void registerNamedDispatcher(java.lang.String name,
                                    RequestDispatcher requestDispatcher)

Register a RequestDispatcher (typically a MockRequestDispatcher) that acts as a wrapper for the named Servlet.

Parameters:

name - the name of the wrapped Servlet

requestDispatcher - the dispatcher that wraps the named Servlet

See Also:

getNamedDispatcher(java.lang.String), unregisterNamedDispatcher(java.lang.String)

unregisterNamedDispatcher

public void unregisterNamedDispatcher(java.lang.String name)

Unregister the RequestDispatcher with the given name.

Parameters:

name - the name of the dispatcher to unregister

See Also:

getNamedDispatcher(java.lang.String), registerNamedDispatcher(java.lang.String, RequestDispatcher)

getDefaultServletName

public java.lang.String getDefaultServletName()

Get the name of the default Servlet.

Defaults to 'default'.

See Also:

setDefaultServletName(java.lang.String)

setDefaultServletName

public void setDefaultServletName(java.lang.String defaultServletName)

Set the name of the default Servlet.

Also unregisters the current default RequestDispatcher and replaces it with a MockRequestDispatcher for the provided defaultServletName.

Parameters:

defaultServletName - the name of the default Servlet; never null or empty

See Also:

getDefaultServletName()

getServlet

@Deprecated
public Servlet getServlet(java.lang.String name)

Deprecated.

getServlets

@Deprecated
public java.util.Enumeration<Servlet> getServlets()

Deprecated.

getServletNames

@Deprecated
public java.util.Enumeration<java.lang.String> getServletNames()

Deprecated.

log

public void log(java.lang.String message)

log

@Deprecated
public void log(java.lang.Exception ex,
                            java.lang.String message)

Deprecated.

log

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

getRealPath

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

getServerInfo

public java.lang.String getServerInfo()

getInitParameter

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

getInitParameterNames

public java.util.Enumeration<java.lang.String> getInitParameterNames()

setInitParameter

public boolean setInitParameter(java.lang.String name,
                                java.lang.String value)

addInitParameter

public void addInitParameter(java.lang.String name,
                             java.lang.String value)

getAttribute

public java.lang.Object getAttribute(java.lang.String name)

getAttributeNames

public java.util.Enumeration<java.lang.String> getAttributeNames()

setAttribute

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

removeAttribute

public void removeAttribute(java.lang.String name)

setServletContextName

public void setServletContextName(java.lang.String servletContextName)

getServletContextName

public java.lang.String getServletContextName()

getClassLoader

public java.lang.ClassLoader getClassLoader()

declareRoles

public void declareRoles(java.lang.String... roleNames)

getDeclaredRoles

public java.util.Set<java.lang.String> getDeclaredRoles()

setSessionTrackingModes

public void setSessionTrackingModes(java.util.Set<SessionTrackingMode> sessionTrackingModes)
                             throws java.lang.IllegalStateException,
                                    java.lang.IllegalArgumentException

Throws:

java.lang.IllegalStateException

java.lang.IllegalArgumentException

getDefaultSessionTrackingModes

public java.util.Set<SessionTrackingMode> getDefaultSessionTrackingModes()

getEffectiveSessionTrackingModes

public java.util.Set<SessionTrackingMode> getEffectiveSessionTrackingModes()

getSessionCookieConfig

public SessionCookieConfig getSessionCookieConfig()

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

getSessionTimeout

public int getSessionTimeout()

getJspConfigDescriptor

public JspConfigDescriptor getJspConfigDescriptor()

addJspFile

public ServletRegistration.Dynamic addJspFile(java.lang.String servletName,
                                              java.lang.String jspFile)

addServlet

public ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                              java.lang.String className)

addServlet

public ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                              Servlet servlet)

addServlet

public ServletRegistration.Dynamic addServlet(java.lang.String servletName,
                                              java.lang.Class<? extends Servlet> servletClass)

createServlet

public <T extends Servlet> T createServlet(java.lang.Class<T> c)
                                    throws ServletException

Throws:

ServletException

getServletRegistration

public ServletRegistration getServletRegistration(java.lang.String servletName)

This method always returns null.

See Also:

javax.servlet.ServletContext#getServletRegistration(java.lang.String)

getServletRegistrations

public java.util.Map<java.lang.String,? extends ServletRegistration> getServletRegistrations()

This method always returns an empty map.

See Also:

javax.servlet.ServletContext#getServletRegistrations()

addFilter

public FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                            java.lang.String className)

addFilter

public FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                            Filter filter)

addFilter

public FilterRegistration.Dynamic addFilter(java.lang.String filterName,
                                            java.lang.Class<? extends Filter> filterClass)

createFilter

public <T extends Filter> T createFilter(java.lang.Class<T> c)
                                  throws ServletException

Throws:

ServletException

getFilterRegistration

public FilterRegistration getFilterRegistration(java.lang.String filterName)

This method always returns null.

See Also:

javax.servlet.ServletContext#getFilterRegistration(java.lang.String)

getFilterRegistrations

public java.util.Map<java.lang.String,? extends FilterRegistration> getFilterRegistrations()

This method always returns an empty map.

See Also:

javax.servlet.ServletContext#getFilterRegistrations()

addListener

public void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)

addListener

public void addListener(java.lang.String className)

addListener

public <T extends java.util.EventListener> void addListener(T t)

createListener

public <T extends java.util.EventListener> T createListener(java.lang.Class<T> c)
                                                     throws ServletException

Throws:

ServletException

getVirtualServerName

public java.lang.String getVirtualServerName()