Class MockServletContext
- java.lang.Object
-
- com.jalios.servlet.http.MockServletContext
-
- All Implemented Interfaces:
javax.servlet.ServletContext
public class MockServletContext extends java.lang.Object implements javax.servlet.ServletContextMock implementation of theServletContextinterface.
-
-
Field Summary
Fields Modifier and Type Field Description static java.lang.StringTEMP_DIR_CONTEXT_ATTRIBUTE
-
Constructor Summary
Constructors Constructor Description MockServletContext()Create a newMockServletContext, using no base path (i.e.MockServletContext(java.lang.String resourceBasePath)Create a newMockServletContextusing the supplied resource base path.
-
Method Summary
All Methods Instance Methods Concrete Methods Deprecated Methods Modifier and Type Method Description javax.servlet.FilterRegistration.DynamicaddFilter(java.lang.String filterName, java.lang.Class<? extends javax.servlet.Filter> filterClass)javax.servlet.FilterRegistration.DynamicaddFilter(java.lang.String filterName, java.lang.String className)javax.servlet.FilterRegistration.DynamicaddFilter(java.lang.String filterName, javax.servlet.Filter filter)voidaddInitParameter(java.lang.String name, java.lang.String value)javax.servlet.ServletRegistration.DynamicaddJspFile(java.lang.String arg0, java.lang.String arg1)voidaddListener(java.lang.Class<? extends java.util.EventListener> listenerClass)voidaddListener(java.lang.String className)<T extends java.util.EventListener>
voidaddListener(T t)javax.servlet.ServletRegistration.DynamicaddServlet(java.lang.String servletName, java.lang.Class<? extends javax.servlet.Servlet> servletClass)javax.servlet.ServletRegistration.DynamicaddServlet(java.lang.String servletName, java.lang.String className)javax.servlet.ServletRegistration.DynamicaddServlet(java.lang.String servletName, javax.servlet.Servlet servlet)<T extends javax.servlet.Filter>
TcreateFilter(java.lang.Class<T> c)<T extends java.util.EventListener>
TcreateListener(java.lang.Class<T> c)<T extends javax.servlet.Servlet>
TcreateServlet(java.lang.Class<T> c)voiddeclareRoles(java.lang.String... roleNames)java.lang.ObjectgetAttribute(java.lang.String name)java.util.Enumeration<java.lang.String>getAttributeNames()java.lang.ClassLoadergetClassLoader()javax.servlet.ServletContextgetContext(java.lang.String contextPath)java.lang.StringgetContextPath()java.util.Set<java.lang.String>getDeclaredRoles()java.lang.StringgetDefaultServletName()Get the name of the defaultServlet.java.util.Set<javax.servlet.SessionTrackingMode>getDefaultSessionTrackingModes()intgetEffectiveMajorVersion()intgetEffectiveMinorVersion()java.util.Set<javax.servlet.SessionTrackingMode>getEffectiveSessionTrackingModes()javax.servlet.FilterRegistrationgetFilterRegistration(java.lang.String filterName)This method always returnsnull.java.util.Map<java.lang.String,? extends javax.servlet.FilterRegistration>getFilterRegistrations()This method always returns an empty map.java.lang.StringgetInitParameter(java.lang.String name)java.util.Enumeration<java.lang.String>getInitParameterNames()javax.servlet.descriptor.JspConfigDescriptorgetJspConfigDescriptor()intgetMajorVersion()java.lang.StringgetMimeType(java.lang.String filePath)This method uses the defaultFileTypeMapfrom the Java Activation Framework to resolve MIME types.intgetMinorVersion()javax.servlet.RequestDispatchergetNamedDispatcher(java.lang.String path)java.lang.StringgetRealPath(java.lang.String path)java.lang.StringgetRequestCharacterEncoding()javax.servlet.RequestDispatchergetRequestDispatcher(java.lang.String path)java.net.URLgetResource(java.lang.String path)java.io.InputStreamgetResourceAsStream(java.lang.String path)protected java.lang.StringgetResourceLocation(java.lang.String path)Build a full resource location for the given path, prepending the resource base path of thisMockServletContext.java.util.Set<java.lang.String>getResourcePaths(java.lang.String path)java.lang.StringgetResponseCharacterEncoding()java.lang.StringgetServerInfo()javax.servlet.ServletgetServlet(java.lang.String name)Deprecated.java.lang.StringgetServletContextName()java.util.Enumeration<java.lang.String>getServletNames()Deprecated.javax.servlet.ServletRegistrationgetServletRegistration(java.lang.String servletName)This method always returnsnull.java.util.Map<java.lang.String,? extends javax.servlet.ServletRegistration>getServletRegistrations()This method always returns an empty map.java.util.Enumeration<javax.servlet.Servlet>getServlets()Deprecated.javax.servlet.SessionCookieConfiggetSessionCookieConfig()intgetSessionTimeout()java.lang.StringgetVirtualServerName()voidlog(java.lang.Exception ex, java.lang.String message)Deprecated.voidlog(java.lang.String message)voidlog(java.lang.String message, java.lang.Throwable ex)voidregisterContext(java.lang.String contextPath, javax.servlet.ServletContext context)voidregisterNamedDispatcher(java.lang.String name, javax.servlet.RequestDispatcher requestDispatcher)Register aRequestDispatcher(typically aMockRequestDispatcher) that acts as a wrapper for the named Servlet.voidremoveAttribute(java.lang.String name)voidsetAttribute(java.lang.String name, java.lang.Object value)voidsetContextPath(java.lang.String contextPath)voidsetDefaultServletName(java.lang.String defaultServletName)Set the name of the defaultServlet.voidsetEffectiveMajorVersion(int effectiveMajorVersion)voidsetEffectiveMinorVersion(int effectiveMinorVersion)booleansetInitParameter(java.lang.String name, java.lang.String value)voidsetMajorVersion(int majorVersion)voidsetMinorVersion(int minorVersion)voidsetRequestCharacterEncoding(java.lang.String arg0)voidsetResponseCharacterEncoding(java.lang.String arg0)voidsetServletContextName(java.lang.String servletContextName)voidsetSessionTimeout(int arg0)voidsetSessionTrackingModes(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes)voidunregisterNamedDispatcher(java.lang.String name)Unregister theRequestDispatcherwith the given name.
-
-
-
Field Detail
-
TEMP_DIR_CONTEXT_ATTRIBUTE
public static final java.lang.String TEMP_DIR_CONTEXT_ATTRIBUTE
- See Also:
- Constant Field Values
-
-
Constructor Detail
-
MockServletContext
public MockServletContext()
Create a newMockServletContext, using no base path (i.e. the classpath root as WAR root).
-
MockServletContext
public MockServletContext(java.lang.String resourceBasePath)
Create a newMockServletContextusing the supplied resource base path.Registers a
MockRequestDispatcherfor the Servlet named 'default'.- Parameters:
resourceBasePath- the root directory of the WAR (should not end with a slash)- 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 thisMockServletContext.- 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:
getContextPathin interfacejavax.servlet.ServletContext
-
registerContext
public void registerContext(java.lang.String contextPath, javax.servlet.ServletContext context)
-
getContext
public javax.servlet.ServletContext getContext(java.lang.String contextPath)
- Specified by:
getContextin interfacejavax.servlet.ServletContext
-
setMajorVersion
public void setMajorVersion(int majorVersion)
-
getMajorVersion
public int getMajorVersion()
- Specified by:
getMajorVersionin interfacejavax.servlet.ServletContext
-
setMinorVersion
public void setMinorVersion(int minorVersion)
-
getMinorVersion
public int getMinorVersion()
- Specified by:
getMinorVersionin interfacejavax.servlet.ServletContext
-
setEffectiveMajorVersion
public void setEffectiveMajorVersion(int effectiveMajorVersion)
-
getEffectiveMajorVersion
public int getEffectiveMajorVersion()
- Specified by:
getEffectiveMajorVersionin interfacejavax.servlet.ServletContext
-
setEffectiveMinorVersion
public void setEffectiveMinorVersion(int effectiveMinorVersion)
-
getEffectiveMinorVersion
public int getEffectiveMinorVersion()
- Specified by:
getEffectiveMinorVersionin interfacejavax.servlet.ServletContext
-
getMimeType
public java.lang.String getMimeType(java.lang.String filePath)
This method uses the defaultFileTypeMapfrom 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 returnsnull). Thus, in order to honor theServletContext.getMimeType(String)contract, this method returnsnullif the MIME type is"application/octet-stream".MockServletContextdoes not provide a direct mechanism for setting a custom MIME type; however, if the defaultFileTypeMapis an instance ofjavax.activation.MimetypesFileTypeMap, a custom MIME type namedtext/enigmacan be registered for a custom.puzzlefile extension in the following manner:MimetypesFileTypeMap mimetypesFileTypeMap = (MimetypesFileTypeMap) FileTypeMap.getDefaultFileTypeMap(); mimetypesFileTypeMap.addMimeTypes("text/enigma puzzle");- Specified by:
getMimeTypein interfacejavax.servlet.ServletContext
-
getResourcePaths
public java.util.Set<java.lang.String> getResourcePaths(java.lang.String path)
- Specified by:
getResourcePathsin interfacejavax.servlet.ServletContext
-
getResource
public java.net.URL getResource(java.lang.String path) throws java.net.MalformedURLException- Specified by:
getResourcein interfacejavax.servlet.ServletContext- Throws:
java.net.MalformedURLException
-
getResourceAsStream
public java.io.InputStream getResourceAsStream(java.lang.String path)
- Specified by:
getResourceAsStreamin interfacejavax.servlet.ServletContext
-
getRequestDispatcher
public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)
- Specified by:
getRequestDispatcherin interfacejavax.servlet.ServletContext
-
getNamedDispatcher
public javax.servlet.RequestDispatcher getNamedDispatcher(java.lang.String path)
- Specified by:
getNamedDispatcherin interfacejavax.servlet.ServletContext
-
registerNamedDispatcher
public void registerNamedDispatcher(java.lang.String name, javax.servlet.RequestDispatcher requestDispatcher)Register aRequestDispatcher(typically aMockRequestDispatcher) that acts as a wrapper for the named Servlet.- Parameters:
name- the name of the wrapped ServletrequestDispatcher- 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 theRequestDispatcherwith 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 defaultServlet.Defaults to 'default'.
- See Also:
setDefaultServletName(java.lang.String)
-
setDefaultServletName
public void setDefaultServletName(java.lang.String defaultServletName)
Set the name of the defaultServlet.Also
unregistersthe current defaultRequestDispatcherandreplacesit with aMockRequestDispatcherfor the provideddefaultServletName.- Parameters:
defaultServletName- the name of the defaultServlet; nevernullor empty- See Also:
getDefaultServletName()
-
getServlet
@Deprecated public javax.servlet.Servlet getServlet(java.lang.String name)
Deprecated.- Specified by:
getServletin interfacejavax.servlet.ServletContext
-
getServlets
@Deprecated public java.util.Enumeration<javax.servlet.Servlet> getServlets()
Deprecated.- Specified by:
getServletsin interfacejavax.servlet.ServletContext
-
getServletNames
@Deprecated public java.util.Enumeration<java.lang.String> getServletNames()
Deprecated.- Specified by:
getServletNamesin interfacejavax.servlet.ServletContext
-
log
public void log(java.lang.String message)
- Specified by:
login interfacejavax.servlet.ServletContext
-
log
@Deprecated public void log(java.lang.Exception ex, java.lang.String message)Deprecated.- Specified by:
login interfacejavax.servlet.ServletContext
-
log
public void log(java.lang.String message, java.lang.Throwable ex)- Specified by:
login interfacejavax.servlet.ServletContext
-
getRealPath
public java.lang.String getRealPath(java.lang.String path)
- Specified by:
getRealPathin interfacejavax.servlet.ServletContext
-
getServerInfo
public java.lang.String getServerInfo()
- Specified by:
getServerInfoin interfacejavax.servlet.ServletContext
-
getInitParameter
public java.lang.String getInitParameter(java.lang.String name)
- Specified by:
getInitParameterin interfacejavax.servlet.ServletContext
-
getInitParameterNames
public java.util.Enumeration<java.lang.String> getInitParameterNames()
- Specified by:
getInitParameterNamesin interfacejavax.servlet.ServletContext
-
setInitParameter
public boolean setInitParameter(java.lang.String name, java.lang.String value)- Specified by:
setInitParameterin interfacejavax.servlet.ServletContext
-
addInitParameter
public void addInitParameter(java.lang.String name, java.lang.String value)
-
getAttribute
public java.lang.Object getAttribute(java.lang.String name)
- Specified by:
getAttributein interfacejavax.servlet.ServletContext
-
getAttributeNames
public java.util.Enumeration<java.lang.String> getAttributeNames()
- Specified by:
getAttributeNamesin interfacejavax.servlet.ServletContext
-
setAttribute
public void setAttribute(java.lang.String name, java.lang.Object value)- Specified by:
setAttributein interfacejavax.servlet.ServletContext
-
removeAttribute
public void removeAttribute(java.lang.String name)
- Specified by:
removeAttributein interfacejavax.servlet.ServletContext
-
setServletContextName
public void setServletContextName(java.lang.String servletContextName)
-
getServletContextName
public java.lang.String getServletContextName()
- Specified by:
getServletContextNamein interfacejavax.servlet.ServletContext
-
getClassLoader
public java.lang.ClassLoader getClassLoader()
- Specified by:
getClassLoaderin interfacejavax.servlet.ServletContext
-
declareRoles
public void declareRoles(java.lang.String... roleNames)
- Specified by:
declareRolesin interfacejavax.servlet.ServletContext
-
getDeclaredRoles
public java.util.Set<java.lang.String> getDeclaredRoles()
-
setSessionTrackingModes
public void setSessionTrackingModes(java.util.Set<javax.servlet.SessionTrackingMode> sessionTrackingModes) throws java.lang.IllegalStateException, java.lang.IllegalArgumentException- Specified by:
setSessionTrackingModesin interfacejavax.servlet.ServletContext- Throws:
java.lang.IllegalStateExceptionjava.lang.IllegalArgumentException
-
getDefaultSessionTrackingModes
public java.util.Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
- Specified by:
getDefaultSessionTrackingModesin interfacejavax.servlet.ServletContext
-
getEffectiveSessionTrackingModes
public java.util.Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
- Specified by:
getEffectiveSessionTrackingModesin interfacejavax.servlet.ServletContext
-
getSessionCookieConfig
public javax.servlet.SessionCookieConfig getSessionCookieConfig()
- Specified by:
getSessionCookieConfigin interfacejavax.servlet.ServletContext
-
getJspConfigDescriptor
public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
- Specified by:
getJspConfigDescriptorin interfacejavax.servlet.ServletContext
-
addServlet
public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.String className)- Specified by:
addServletin interfacejavax.servlet.ServletContext
-
addServlet
public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName, javax.servlet.Servlet servlet)- Specified by:
addServletin interfacejavax.servlet.ServletContext
-
addServlet
public javax.servlet.ServletRegistration.Dynamic addServlet(java.lang.String servletName, java.lang.Class<? extends javax.servlet.Servlet> servletClass)- Specified by:
addServletin interfacejavax.servlet.ServletContext
-
createServlet
public <T extends javax.servlet.Servlet> T createServlet(java.lang.Class<T> c) throws javax.servlet.ServletException- Specified by:
createServletin interfacejavax.servlet.ServletContext- Throws:
javax.servlet.ServletException
-
getServletRegistration
public javax.servlet.ServletRegistration getServletRegistration(java.lang.String servletName)
This method always returnsnull.- Specified by:
getServletRegistrationin interfacejavax.servlet.ServletContext- See Also:
ServletContext.getServletRegistration(java.lang.String)
-
getServletRegistrations
public java.util.Map<java.lang.String,? extends javax.servlet.ServletRegistration> getServletRegistrations()
This method always returns an empty map.- Specified by:
getServletRegistrationsin interfacejavax.servlet.ServletContext- See Also:
ServletContext.getServletRegistrations()
-
addFilter
public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.String className)- Specified by:
addFilterin interfacejavax.servlet.ServletContext
-
addFilter
public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName, javax.servlet.Filter filter)- Specified by:
addFilterin interfacejavax.servlet.ServletContext
-
addFilter
public javax.servlet.FilterRegistration.Dynamic addFilter(java.lang.String filterName, java.lang.Class<? extends javax.servlet.Filter> filterClass)- Specified by:
addFilterin interfacejavax.servlet.ServletContext
-
createFilter
public <T extends javax.servlet.Filter> T createFilter(java.lang.Class<T> c) throws javax.servlet.ServletException- Specified by:
createFilterin interfacejavax.servlet.ServletContext- Throws:
javax.servlet.ServletException
-
getFilterRegistration
public javax.servlet.FilterRegistration getFilterRegistration(java.lang.String filterName)
This method always returnsnull.- Specified by:
getFilterRegistrationin interfacejavax.servlet.ServletContext- See Also:
ServletContext.getFilterRegistration(java.lang.String)
-
getFilterRegistrations
public java.util.Map<java.lang.String,? extends javax.servlet.FilterRegistration> getFilterRegistrations()
This method always returns an empty map.- Specified by:
getFilterRegistrationsin interfacejavax.servlet.ServletContext- See Also:
ServletContext.getFilterRegistrations()
-
addListener
public void addListener(java.lang.Class<? extends java.util.EventListener> listenerClass)
- Specified by:
addListenerin interfacejavax.servlet.ServletContext
-
addListener
public void addListener(java.lang.String className)
- Specified by:
addListenerin interfacejavax.servlet.ServletContext
-
addListener
public <T extends java.util.EventListener> void addListener(T t)
- Specified by:
addListenerin interfacejavax.servlet.ServletContext
-
createListener
public <T extends java.util.EventListener> T createListener(java.lang.Class<T> c) throws javax.servlet.ServletException- Specified by:
createListenerin interfacejavax.servlet.ServletContext- Throws:
javax.servlet.ServletException
-
getVirtualServerName
public java.lang.String getVirtualServerName()
- Specified by:
getVirtualServerNamein interfacejavax.servlet.ServletContext
-
addJspFile
public javax.servlet.ServletRegistration.Dynamic addJspFile(java.lang.String arg0, java.lang.String arg1)
-
getRequestCharacterEncoding
public java.lang.String getRequestCharacterEncoding()
-
getResponseCharacterEncoding
public java.lang.String getResponseCharacterEncoding()
-
getSessionTimeout
public int getSessionTimeout()
-
setRequestCharacterEncoding
public void setRequestCharacterEncoding(java.lang.String arg0)
-
setResponseCharacterEncoding
public void setResponseCharacterEncoding(java.lang.String arg0)
-
setSessionTimeout
public void setSessionTimeout(int arg0)
-
-