Package io.microsphere.spring.test.web.servlet

Class TestServletContext

java.lang.Object
org.springframework.mock.web.MockServletContext
io.microsphere.spring.test.web.servlet.TestServletContext
All Implemented Interfaces:
jakarta.servlet.ServletContext
public class TestServletContext extends org.springframework.mock.web.MockServletContext
Test ServletContext based on MockServletContext
Since:
1.0.0
Author:
Mercy
See Also:
  • MockServletContext

  • Field Summary

    Fields inherited from interface jakarta.servlet.ServletContext

    ORDERED_LIBS, TEMPDIR

  • Constructor Summary

    Constructors
    Constructor
    Description
    TestServletContext()
    Create a new TestServletContext, using no base path and a DefaultResourceLoader (i.e. the classpath root as WAR root).
    TestServletContext(String resourceBasePath)
    Create a new TestServletContext, using a DefaultResourceLoader.
    TestServletContext(String resourceBasePath, org.springframework.core.io.ResourceLoader resourceLoader)
    Create a new TestServletContext using the supplied resource base path and resource loader.

  • Method Summary

    Modifier and Type
    Method
    Description
    jakarta.servlet.FilterRegistration.Dynamic
    addFilter(String filterName, jakarta.servlet.Filter filter)
     
    jakarta.servlet.FilterRegistration.Dynamic
    addFilter(String filterName, Class<? extends jakarta.servlet.Filter> filterClass)
     
    jakarta.servlet.FilterRegistration.Dynamic
    addFilter(String filterName, String className)
     
    protected jakarta.servlet.FilterRegistration.Dynamic
    addFilter(String filterName, String filterClassName, jakarta.servlet.Filter filter)
     
    void
    addListener(Class<? extends EventListener> listenerClass)
     
    void
    addListener(String className)
     
    <T extends EventListener>
    void
    addListener(T t)
     
    jakarta.servlet.ServletRegistration.Dynamic
    addServlet(String servletName, jakarta.servlet.Servlet servlet)
     
    jakarta.servlet.ServletRegistration.Dynamic
    addServlet(String servletName, Class<? extends jakarta.servlet.Servlet> servletClass)
     
    jakarta.servlet.ServletRegistration.Dynamic
    addServlet(String servletName, String className)
     
    protected jakarta.servlet.ServletRegistration.Dynamic
    addServlet(String servletName, String servletClassName, jakarta.servlet.Servlet servlet)
     
    <T extends jakarta.servlet.Filter>
    T
    createFilter(Class<T> c)
     
    protected <T> T
    createInstance(Class<T> c)
     
    protected <T> T
    createInstance(String className)
     
    <T extends EventListener>
    T
    createListener(Class<T> c)
     
    <T extends jakarta.servlet.Servlet>
    T
    createServlet(Class<T> c)
     
    jakarta.servlet.FilterRegistration
    getFilterRegistration(String filterName)
     
    Map<String,? extends jakarta.servlet.FilterRegistration>
    getFilterRegistrations()
     
    jakarta.servlet.ServletRegistration
    getServletRegistration(String servletName)
     
    Map<String,? extends jakarta.servlet.ServletRegistration>
    getServletRegistrations()
     
    protected <T> Class<T>
    loadClass(String className)
     

    Methods inherited from class org.springframework.mock.web.MockServletContext

    addFilterRegistration, addInitParameter, addJspFile, addMimeType, declareRoles, getAttribute, getAttributeNames, getClassLoader, getContext, getContextPath, getDeclaredRoles, getDefaultServletName, getDefaultSessionTrackingModes, getEffectiveMajorVersion, getEffectiveMinorVersion, getEffectiveSessionTrackingModes, getInitParameter, getInitParameterNames, getJspConfigDescriptor, getMajorVersion, getMimeType, getMinorVersion, getNamedDispatcher, getRealPath, getRequestCharacterEncoding, getRequestDispatcher, getResource, getResourceAsStream, getResourceLocation, getResourcePaths, getResponseCharacterEncoding, getServerInfo, getServletContextName, getSessionCookieConfig, getSessionTimeout, getVirtualServerName, log, log, registerContext, registerNamedDispatcher, removeAttribute, setAttribute, setContextPath, setDefaultServletName, setEffectiveMajorVersion, setEffectiveMinorVersion, setInitParameter, setMajorVersion, setMinorVersion, setRequestCharacterEncoding, setResponseCharacterEncoding, setServletContextName, setSessionTimeout, setSessionTrackingModes, unregisterNamedDispatcher

    Methods inherited from class java.lang.Object

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

    Methods inherited from interface jakarta.servlet.ServletContext

    setRequestCharacterEncoding, setResponseCharacterEncoding

  • Constructor Details

    • TestServletContext

      public TestServletContext()
      Create a new TestServletContext, using no base path and a DefaultResourceLoader (i.e. the classpath root as WAR root).
      See Also:
      • DefaultResourceLoader

    • TestServletContext

      public TestServletContext(String resourceBasePath)
      Create a new TestServletContext, using a DefaultResourceLoader.
      Parameters:
      resourceBasePath - the root directory of the WAR (should not end with a slash)
      See Also:
      • DefaultResourceLoader

    • TestServletContext

      public TestServletContext(String resourceBasePath, org.springframework.core.io.ResourceLoader resourceLoader)
      Create a new TestServletContext 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:
      • MockServletContext.registerNamedDispatcher(java.lang.String, jakarta.servlet.RequestDispatcher)

  • Method Details

    • addServlet

      public jakarta.servlet.ServletRegistration.Dynamic addServlet(String servletName, String className)
      Specified by:
      addServlet in interface jakarta.servlet.ServletContext
      Overrides:
      addServlet in class org.springframework.mock.web.MockServletContext

    • addServlet

      public jakarta.servlet.ServletRegistration.Dynamic addServlet(String servletName, jakarta.servlet.Servlet servlet)
      Specified by:
      addServlet in interface jakarta.servlet.ServletContext
      Overrides:
      addServlet in class org.springframework.mock.web.MockServletContext

    • addServlet

      public jakarta.servlet.ServletRegistration.Dynamic addServlet(String servletName, Class<? extends jakarta.servlet.Servlet> servletClass)
      Specified by:
      addServlet in interface jakarta.servlet.ServletContext
      Overrides:
      addServlet in class org.springframework.mock.web.MockServletContext

    • createServlet

      public <T extends jakarta.servlet.Servlet> T createServlet(Class<T> c) throws jakarta.servlet.ServletException
      Specified by:
      createServlet in interface jakarta.servlet.ServletContext
      Overrides:
      createServlet in class org.springframework.mock.web.MockServletContext
      Throws:
      jakarta.servlet.ServletException

    • getServletRegistration

      @Nullable public jakarta.servlet.ServletRegistration getServletRegistration(String servletName)
      Specified by:
      getServletRegistration in interface jakarta.servlet.ServletContext
      Overrides:
      getServletRegistration in class org.springframework.mock.web.MockServletContext

    • getServletRegistrations

      public Map<String,? extends jakarta.servlet.ServletRegistration> getServletRegistrations()
      Specified by:
      getServletRegistrations in interface jakarta.servlet.ServletContext
      Overrides:
      getServletRegistrations in class org.springframework.mock.web.MockServletContext

    • addFilter

      public jakarta.servlet.FilterRegistration.Dynamic addFilter(String filterName, String className)
      Specified by:
      addFilter in interface jakarta.servlet.ServletContext
      Overrides:
      addFilter in class org.springframework.mock.web.MockServletContext

    • addFilter

      public jakarta.servlet.FilterRegistration.Dynamic addFilter(String filterName, jakarta.servlet.Filter filter)
      Specified by:
      addFilter in interface jakarta.servlet.ServletContext
      Overrides:
      addFilter in class org.springframework.mock.web.MockServletContext

    • addFilter

      public jakarta.servlet.FilterRegistration.Dynamic addFilter(String filterName, Class<? extends jakarta.servlet.Filter> filterClass)
      Specified by:
      addFilter in interface jakarta.servlet.ServletContext
      Overrides:
      addFilter in class org.springframework.mock.web.MockServletContext

    • createFilter

      public <T extends jakarta.servlet.Filter> T createFilter(Class<T> c) throws jakarta.servlet.ServletException
      Specified by:
      createFilter in interface jakarta.servlet.ServletContext
      Overrides:
      createFilter in class org.springframework.mock.web.MockServletContext
      Throws:
      jakarta.servlet.ServletException

    • getFilterRegistration

      public jakarta.servlet.FilterRegistration getFilterRegistration(String filterName)
      Specified by:
      getFilterRegistration in interface jakarta.servlet.ServletContext
      Overrides:
      getFilterRegistration in class org.springframework.mock.web.MockServletContext

    • getFilterRegistrations

      public Map<String,? extends jakarta.servlet.FilterRegistration> getFilterRegistrations()
      Specified by:
      getFilterRegistrations in interface jakarta.servlet.ServletContext
      Overrides:
      getFilterRegistrations in class org.springframework.mock.web.MockServletContext

    • addListener

      public void addListener(Class<? extends EventListener> listenerClass)
      Specified by:
      addListener in interface jakarta.servlet.ServletContext
      Overrides:
      addListener in class org.springframework.mock.web.MockServletContext

    • addListener

      public void addListener(String className)
      Specified by:
      addListener in interface jakarta.servlet.ServletContext
      Overrides:
      addListener in class org.springframework.mock.web.MockServletContext

    • addListener

      public <T extends EventListener> void addListener(T t)
      Specified by:
      addListener in interface jakarta.servlet.ServletContext
      Overrides:
      addListener in class org.springframework.mock.web.MockServletContext

    • createListener

      public <T extends EventListener> T createListener(Class<T> c) throws jakarta.servlet.ServletException
      Specified by:
      createListener in interface jakarta.servlet.ServletContext
      Overrides:
      createListener in class org.springframework.mock.web.MockServletContext
      Throws:
      jakarta.servlet.ServletException

    • addServlet

      protected jakarta.servlet.ServletRegistration.Dynamic addServlet(String servletName, String servletClassName, @Nullable jakarta.servlet.Servlet servlet)

    • addFilter

      protected jakarta.servlet.FilterRegistration.Dynamic addFilter(String filterName, String filterClassName, @Nullable jakarta.servlet.Filter filter)

    • createInstance

      protected <T> T createInstance(String className)

    • createInstance

      protected <T> T createInstance(Class<T> c) throws jakarta.servlet.ServletException
      Throws:
      jakarta.servlet.ServletException

    • loadClass

      protected <T> Class<T> loadClass(String className)