Package com.jalios.servlet.http

Class MockServletContext

  • All Implemented Interfaces:
    javax.servlet.ServletContext
    public class MockServletContext
extends java.lang.Object
implements javax.servlet.ServletContext
    Mock implementation of the ServletContext interface.

    • 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 new MockServletContext, using no base path (i.e. the classpath root as WAR root).

    • 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 javax.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:
        getContext in interface javax.servlet.ServletContext

      • setMajorVersion

        public void setMajorVersion​(int majorVersion)

      • getMajorVersion

        public int getMajorVersion()
        Specified by:
        getMajorVersion in interface javax.servlet.ServletContext

      • setMinorVersion

        public void setMinorVersion​(int minorVersion)

      • getMinorVersion

        public int getMinorVersion()
        Specified by:
        getMinorVersion in interface javax.servlet.ServletContext

      • setEffectiveMajorVersion

        public void setEffectiveMajorVersion​(int effectiveMajorVersion)

      • getEffectiveMajorVersion

        public int getEffectiveMajorVersion()
        Specified by:
        getEffectiveMajorVersion in interface javax.servlet.ServletContext

      • setEffectiveMinorVersion

        public void setEffectiveMinorVersion​(int effectiveMinorVersion)

      • getEffectiveMinorVersion

        public int getEffectiveMinorVersion()
        Specified by:
        getEffectiveMinorVersion in interface javax.servlet.ServletContext

      • 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");
        Specified by:
        getMimeType in interface javax.servlet.ServletContext

      • getResourcePaths

        public java.util.Set<java.lang.String> getResourcePaths​(java.lang.String path)
        Specified by:
        getResourcePaths in interface javax.servlet.ServletContext

      • getResource

        public java.net.URL getResource​(java.lang.String path)
                         throws java.net.MalformedURLException
        Specified by:
        getResource in interface javax.servlet.ServletContext
        Throws:
        java.net.MalformedURLException

      • getResourceAsStream

        public java.io.InputStream getResourceAsStream​(java.lang.String path)
        Specified by:
        getResourceAsStream in interface javax.servlet.ServletContext

      • getRequestDispatcher

        public javax.servlet.RequestDispatcher getRequestDispatcher​(java.lang.String path)
        Specified by:
        getRequestDispatcher in interface javax.servlet.ServletContext

      • getNamedDispatcher

        public javax.servlet.RequestDispatcher getNamedDispatcher​(java.lang.String path)
        Specified by:
        getNamedDispatcher in interface javax.servlet.ServletContext

      • 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 javax.servlet.Servlet getServlet​(java.lang.String name)
        Deprecated.
        Specified by:
        getServlet in interface javax.servlet.ServletContext

      • getServlets

        @Deprecated
public java.util.Enumeration<javax.servlet.Servlet> getServlets()
        Deprecated.
        Specified by:
        getServlets in interface javax.servlet.ServletContext

      • getServletNames

        @Deprecated
public java.util.Enumeration<java.lang.String> getServletNames()
        Deprecated.
        Specified by:
        getServletNames in interface javax.servlet.ServletContext

      • log

        public void log​(java.lang.String message)
        Specified by:
        log in interface javax.servlet.ServletContext

      • log

        @Deprecated
public void log​(java.lang.Exception ex,
                java.lang.String message)
        Deprecated.
        Specified by:
        log in interface javax.servlet.ServletContext

      • log

        public void log​(java.lang.String message,
                java.lang.Throwable ex)
        Specified by:
        log in interface javax.servlet.ServletContext

      • getRealPath

        public java.lang.String getRealPath​(java.lang.String path)
        Specified by:
        getRealPath in interface javax.servlet.ServletContext

      • getServerInfo

        public java.lang.String getServerInfo()
        Specified by:
        getServerInfo in interface javax.servlet.ServletContext

      • getInitParameter

        public java.lang.String getInitParameter​(java.lang.String name)
        Specified by:
        getInitParameter in interface javax.servlet.ServletContext

      • getInitParameterNames

        public java.util.Enumeration<java.lang.String> getInitParameterNames()
        Specified by:
        getInitParameterNames in interface javax.servlet.ServletContext

      • setInitParameter

        public boolean setInitParameter​(java.lang.String name,
                                java.lang.String value)
        Specified by:
        setInitParameter in interface javax.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:
        getAttribute in interface javax.servlet.ServletContext

      • getAttributeNames

        public java.util.Enumeration<java.lang.String> getAttributeNames()
        Specified by:
        getAttributeNames in interface javax.servlet.ServletContext

      • setAttribute

        public void setAttribute​(java.lang.String name,
                         java.lang.Object value)
        Specified by:
        setAttribute in interface javax.servlet.ServletContext

      • removeAttribute

        public void removeAttribute​(java.lang.String name)
        Specified by:
        removeAttribute in interface javax.servlet.ServletContext

      • setServletContextName

        public void setServletContextName​(java.lang.String servletContextName)

      • getServletContextName

        public java.lang.String getServletContextName()
        Specified by:
        getServletContextName in interface javax.servlet.ServletContext

      • getClassLoader

        public java.lang.ClassLoader getClassLoader()
        Specified by:
        getClassLoader in interface javax.servlet.ServletContext

      • declareRoles

        public void declareRoles​(java.lang.String... roleNames)
        Specified by:
        declareRoles in interface javax.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:
        setSessionTrackingModes in interface javax.servlet.ServletContext
        Throws:
        java.lang.IllegalStateException
        java.lang.IllegalArgumentException

      • getDefaultSessionTrackingModes

        public java.util.Set<javax.servlet.SessionTrackingMode> getDefaultSessionTrackingModes()
        Specified by:
        getDefaultSessionTrackingModes in interface javax.servlet.ServletContext

      • getEffectiveSessionTrackingModes

        public java.util.Set<javax.servlet.SessionTrackingMode> getEffectiveSessionTrackingModes()
        Specified by:
        getEffectiveSessionTrackingModes in interface javax.servlet.ServletContext

      • getSessionCookieConfig

        public javax.servlet.SessionCookieConfig getSessionCookieConfig()
        Specified by:
        getSessionCookieConfig in interface javax.servlet.ServletContext

      • getJspConfigDescriptor

        public javax.servlet.descriptor.JspConfigDescriptor getJspConfigDescriptor()
        Specified by:
        getJspConfigDescriptor in interface javax.servlet.ServletContext

      • addServlet

        public javax.servlet.ServletRegistration.Dynamic addServlet​(java.lang.String servletName,
                                                            java.lang.String className)
        Specified by:
        addServlet in interface javax.servlet.ServletContext

      • addServlet

        public javax.servlet.ServletRegistration.Dynamic addServlet​(java.lang.String servletName,
                                                            javax.servlet.Servlet servlet)
        Specified by:
        addServlet in interface javax.servlet.ServletContext

      • addServlet

        public javax.servlet.ServletRegistration.Dynamic addServlet​(java.lang.String servletName,
                                                            java.lang.Class<? extends javax.servlet.Servlet> servletClass)
        Specified by:
        addServlet in interface javax.servlet.ServletContext

      • createServlet

        public <T extends javax.servlet.Servlet> T createServlet​(java.lang.Class<T> c)
                                                  throws javax.servlet.ServletException
        Specified by:
        createServlet in interface javax.servlet.ServletContext
        Throws:
        javax.servlet.ServletException

      • getServletRegistration

        public javax.servlet.ServletRegistration getServletRegistration​(java.lang.String servletName)
        This method always returns null.
        Specified by:
        getServletRegistration in interface javax.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:
        getServletRegistrations in interface javax.servlet.ServletContext
        See Also:
        ServletContext.getServletRegistrations()

      • addFilter

        public javax.servlet.FilterRegistration.Dynamic addFilter​(java.lang.String filterName,
                                                          java.lang.String className)
        Specified by:
        addFilter in interface javax.servlet.ServletContext

      • addFilter

        public javax.servlet.FilterRegistration.Dynamic addFilter​(java.lang.String filterName,
                                                          javax.servlet.Filter filter)
        Specified by:
        addFilter in interface javax.servlet.ServletContext

      • addFilter

        public javax.servlet.FilterRegistration.Dynamic addFilter​(java.lang.String filterName,
                                                          java.lang.Class<? extends javax.servlet.Filter> filterClass)
        Specified by:
        addFilter in interface javax.servlet.ServletContext

      • createFilter

        public <T extends javax.servlet.Filter> T createFilter​(java.lang.Class<T> c)
                                                throws javax.servlet.ServletException
        Specified by:
        createFilter in interface javax.servlet.ServletContext
        Throws:
        javax.servlet.ServletException

      • getFilterRegistration

        public javax.servlet.FilterRegistration getFilterRegistration​(java.lang.String filterName)
        This method always returns null.
        Specified by:
        getFilterRegistration in interface javax.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:
        getFilterRegistrations in interface javax.servlet.ServletContext
        See Also:
        ServletContext.getFilterRegistrations()

      • addListener

        public void addListener​(java.lang.Class<? extends java.util.EventListener> listenerClass)
        Specified by:
        addListener in interface javax.servlet.ServletContext

      • addListener

        public void addListener​(java.lang.String className)
        Specified by:
        addListener in interface javax.servlet.ServletContext

      • addListener

        public <T extends java.util.EventListener> void addListener​(T t)
        Specified by:
        addListener in interface javax.servlet.ServletContext

      • createListener

        public <T extends java.util.EventListener> T createListener​(java.lang.Class<T> c)
                                                     throws javax.servlet.ServletException
        Specified by:
        createListener in interface javax.servlet.ServletContext
        Throws:
        javax.servlet.ServletException

      • getVirtualServerName

        public java.lang.String getVirtualServerName()
        Specified by:
        getVirtualServerName in interface javax.servlet.ServletContext

      • addJspFile

        public javax.servlet.ServletRegistration.Dynamic addJspFile​(java.lang.String arg0,
                                                            java.lang.String arg1)
        Specified by:
        addJspFile in interface javax.servlet.ServletContext

      • getRequestCharacterEncoding

        public java.lang.String getRequestCharacterEncoding()
        Specified by:
        getRequestCharacterEncoding in interface javax.servlet.ServletContext

      • getResponseCharacterEncoding

        public java.lang.String getResponseCharacterEncoding()
        Specified by:
        getResponseCharacterEncoding in interface javax.servlet.ServletContext

      • getSessionTimeout

        public int getSessionTimeout()
        Specified by:
        getSessionTimeout in interface javax.servlet.ServletContext

      • setRequestCharacterEncoding

        public void setRequestCharacterEncoding​(java.lang.String arg0)
        Specified by:
        setRequestCharacterEncoding in interface javax.servlet.ServletContext

      • setResponseCharacterEncoding

        public void setResponseCharacterEncoding​(java.lang.String arg0)
        Specified by:
        setResponseCharacterEncoding in interface javax.servlet.ServletContext

      • setSessionTimeout

        public void setSessionTimeout​(int arg0)
        Specified by:
        setSessionTimeout in interface javax.servlet.ServletContext