org.springframework.mock.web

Class MockServletContext

java.lang.Object

org.springframework.mock.web.MockServletContext

All Implemented Interfaces:

ServletContext

public class MockServletContext
extends java.lang.Object
implements ServletContext

Mock implementation of the 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 inherited from interface javax.servlet.ServletContext

ORDERED_LIBS, TEMPDIR

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)
void	addMimeType(java.lang.String fileExtension, MediaType mimeType) Adds a mime type mapping for use by getMimeType(String).
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)
int	getMinorVersion()
RequestDispatcher	getNamedDispatcher(java.lang.String path)
java.lang.String	getRealPath(java.lang.String path)
java.lang.String	getRequestCharacterEncoding()
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	getResponseCharacterEncoding()
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	setRequestCharacterEncoding(java.lang.String requestCharacterEncoding)
void	setResponseCharacterEncoding(java.lang.String responseCharacterEncoding)
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

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(@Nullable
                          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,
                          @Nullable
                          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, javax.servlet.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()

Specified by:

getContextPath in interface ServletContext

registerContext

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

getContext

public ServletContext getContext(java.lang.String contextPath)

Specified by:

getContext in interface ServletContext

setMajorVersion

public void setMajorVersion(int majorVersion)

getMajorVersion

public int getMajorVersion()

Specified by:

getMajorVersion in interface ServletContext

setMinorVersion

public void setMinorVersion(int minorVersion)

getMinorVersion

public int getMinorVersion()

Specified by:

getMinorVersion in interface ServletContext

setEffectiveMajorVersion

public void setEffectiveMajorVersion(int effectiveMajorVersion)

getEffectiveMajorVersion

public int getEffectiveMajorVersion()

Specified by:

getEffectiveMajorVersion in interface ServletContext

setEffectiveMinorVersion

public void setEffectiveMinorVersion(int effectiveMinorVersion)

getEffectiveMinorVersion

public int getEffectiveMinorVersion()

Specified by:

getEffectiveMinorVersion in interface ServletContext

getMimeType

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

Specified by:

getMimeType in interface ServletContext

addMimeType

public void addMimeType(java.lang.String fileExtension,
                        MediaType mimeType)

Adds a mime type mapping for use by getMimeType(String).

Parameters:

fileExtension - a file extension, such as txt, gif

mimeType - the mime type

getResourcePaths

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

Specified by:

getResourcePaths in interface ServletContext

getResource

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

Specified by:

getResource in interface ServletContext

Throws:

java.net.MalformedURLException

getResourceAsStream

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

Specified by:

getResourceAsStream in interface ServletContext

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(java.lang.String path)

Specified by:

getRequestDispatcher in interface ServletContext

getNamedDispatcher

public RequestDispatcher getNamedDispatcher(java.lang.String path)

Specified by:

getNamedDispatcher in interface ServletContext

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, javax.servlet.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
 @Nullable
public Servlet getServlet(java.lang.String name)

Deprecated.

Specified by:

getServlet in interface ServletContext

getServlets

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

Deprecated.

Specified by:

getServlets in interface ServletContext

getServletNames

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

Deprecated.

Specified by:

getServletNames in interface ServletContext

log

public void log(java.lang.String message)

Specified by:

log in interface ServletContext

log

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

Deprecated.

Specified by:

log in interface ServletContext

log

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

Specified by:

log in interface ServletContext

getRealPath

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

Specified by:

getRealPath in interface ServletContext

getServerInfo

public java.lang.String getServerInfo()

Specified by:

getServerInfo in interface ServletContext

getInitParameter

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

Specified by:

getInitParameter in interface ServletContext

getInitParameterNames

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

Specified by:

getInitParameterNames in interface ServletContext

setInitParameter

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

Specified by:

setInitParameter in interface ServletContext

addInitParameter

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

getAttribute

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

Specified by:

getAttribute in interface ServletContext

getAttributeNames

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

Specified by:

getAttributeNames in interface ServletContext

setAttribute

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

Specified by:

setAttribute in interface ServletContext

removeAttribute

public void removeAttribute(java.lang.String name)

Specified by:

removeAttribute in interface ServletContext

setServletContextName

public void setServletContextName(java.lang.String servletContextName)

getServletContextName

public java.lang.String getServletContextName()

Specified by:

getServletContextName in interface ServletContext

getClassLoader

@Nullable
public java.lang.ClassLoader getClassLoader()

Specified by:

getClassLoader in interface ServletContext

declareRoles

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

Specified by:

declareRoles in interface ServletContext

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

Specified by:

setSessionTrackingModes in interface ServletContext

Throws:

java.lang.IllegalStateException

java.lang.IllegalArgumentException

getDefaultSessionTrackingModes

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

Specified by:

getDefaultSessionTrackingModes in interface ServletContext

getEffectiveSessionTrackingModes

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

Specified by:

getEffectiveSessionTrackingModes in interface ServletContext

getSessionCookieConfig

public SessionCookieConfig getSessionCookieConfig()

Specified by:

getSessionCookieConfig in interface ServletContext

setSessionTimeout

public void setSessionTimeout(int sessionTimeout)

getSessionTimeout

public int getSessionTimeout()

setRequestCharacterEncoding

public void setRequestCharacterEncoding(@Nullable
                                        java.lang.String requestCharacterEncoding)

getRequestCharacterEncoding

@Nullable
public java.lang.String getRequestCharacterEncoding()

setResponseCharacterEncoding

public void setResponseCharacterEncoding(@Nullable
                                         java.lang.String responseCharacterEncoding)

getResponseCharacterEncoding

@Nullable
public java.lang.String getResponseCharacterEncoding()

getJspConfigDescriptor

public JspConfigDescriptor getJspConfigDescriptor()

Specified by:

getJspConfigDescriptor in interface ServletContext

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)

Specified by:

addServlet in interface ServletContext

addServlet

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

Specified by:

addServlet in interface ServletContext

addServlet

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

Specified by:

addServlet in interface ServletContext

createServlet

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

Specified by:

createServlet in interface ServletContext

Throws:

ServletException

getServletRegistration

@Nullable
public ServletRegistration getServletRegistration(java.lang.String servletName)

This method always returns null.

Specified by:

getServletRegistration in interface ServletContext

See Also:

ServletContext.getServletRegistration(java.lang.String)

getServletRegistrations

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

This method always returns an empty map.

Specified by:

getServletRegistrations in interface ServletContext

See Also:

ServletContext.getServletRegistrations()

addFilter

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

Specified by:

addFilter in interface ServletContext

addFilter

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

Specified by:

addFilter in interface ServletContext

addFilter

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

Specified by:

addFilter in interface ServletContext

createFilter

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

Specified by:

createFilter in interface ServletContext

Throws:

ServletException

getFilterRegistration

@Nullable
public FilterRegistration getFilterRegistration(java.lang.String filterName)

This method always returns null.

Specified by:

getFilterRegistration in interface ServletContext

See Also:

ServletContext.getFilterRegistration(java.lang.String)

getFilterRegistrations

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

This method always returns an empty map.

Specified by:

getFilterRegistrations in interface ServletContext

See Also:

ServletContext.getFilterRegistrations()

addListener

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

Specified by:

addListener in interface ServletContext

addListener

public void addListener(java.lang.String className)

Specified by:

addListener in interface ServletContext

addListener

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

Specified by:

addListener in interface ServletContext

createListener

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

Specified by:

createListener in interface ServletContext

Throws:

ServletException

getVirtualServerName

public java.lang.String getVirtualServerName()

Specified by:

getVirtualServerName in interface ServletContext