Class MockSlingHttpServletRequest

  • All Implemented Interfaces:
    javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, org.apache.sling.api.adapter.Adaptable, org.apache.sling.api.SlingHttpServletRequest

    @ConsumerType
    public class MockSlingHttpServletRequest
    extends org.apache.sling.api.adapter.SlingAdaptable
    implements org.apache.sling.api.SlingHttpServletRequest
    Mock SlingHttpServletRequest implementation.
    • Field Detail

      • EMPTY_RESOURCE_BUNDLE

        protected static final ResourceBundle EMPTY_RESOURCE_BUNDLE
    • Constructor Detail

      • MockSlingHttpServletRequest

        public MockSlingHttpServletRequest​(org.apache.sling.api.resource.ResourceResolver resourceResolver)
        Parameters:
        resourceResolver - Resource resolver
    • Method Detail

      • getResourceResolver

        public org.apache.sling.api.resource.ResourceResolver getResourceResolver()
        Specified by:
        getResourceResolver in interface org.apache.sling.api.SlingHttpServletRequest
      • getSession

        public javax.servlet.http.HttpSession getSession()
        Specified by:
        getSession in interface javax.servlet.http.HttpServletRequest
      • getSession

        public javax.servlet.http.HttpSession getSession​(boolean create)
        Specified by:
        getSession in interface javax.servlet.http.HttpServletRequest
      • getRequestPathInfo

        public org.apache.sling.api.request.RequestPathInfo getRequestPathInfo()
        Specified by:
        getRequestPathInfo in interface org.apache.sling.api.SlingHttpServletRequest
      • getAttribute

        public Object getAttribute​(String name)
        Specified by:
        getAttribute in interface javax.servlet.ServletRequest
      • getAttributeNames

        public Enumeration<String> getAttributeNames()
        Specified by:
        getAttributeNames in interface javax.servlet.ServletRequest
      • removeAttribute

        public void removeAttribute​(String name)
        Specified by:
        removeAttribute in interface javax.servlet.ServletRequest
      • setAttribute

        public void setAttribute​(String name,
                                 Object object)
        Specified by:
        setAttribute in interface javax.servlet.ServletRequest
      • getResource

        public org.apache.sling.api.resource.Resource getResource()
        Specified by:
        getResource in interface org.apache.sling.api.SlingHttpServletRequest
      • setResource

        public void setResource​(org.apache.sling.api.resource.Resource resource)
      • getParameter

        public String getParameter​(String name)
        Specified by:
        getParameter in interface javax.servlet.ServletRequest
      • getParameterMap

        public Map<String,​String[]> getParameterMap()
        Specified by:
        getParameterMap in interface javax.servlet.ServletRequest
      • getParameterNames

        public Enumeration<String> getParameterNames()
        Specified by:
        getParameterNames in interface javax.servlet.ServletRequest
      • getParameterValues

        public String[] getParameterValues​(String name)
        Specified by:
        getParameterValues in interface javax.servlet.ServletRequest
      • setParameterMap

        public void setParameterMap​(Map<String,​Object> parameterMap)
        Parameters:
        parameterMap - Map of parameters
      • getLocale

        public Locale getLocale()
        Specified by:
        getLocale in interface javax.servlet.ServletRequest
      • setLocale

        public void setLocale​(Locale loc)
        Parameters:
        loc - Request locale
      • getContextPath

        public String getContextPath()
        Specified by:
        getContextPath in interface javax.servlet.http.HttpServletRequest
      • setContextPath

        public void setContextPath​(String contextPath)
        Parameters:
        contextPath - Webapp context path
      • setQueryString

        public void setQueryString​(String queryString)
        Parameters:
        queryString - Query string (with proper URL encoding)
      • getQueryString

        public String getQueryString()
        Specified by:
        getQueryString in interface javax.servlet.http.HttpServletRequest
      • getScheme

        public String getScheme()
        Specified by:
        getScheme in interface javax.servlet.ServletRequest
      • setScheme

        public void setScheme​(String scheme)
      • getServerName

        public String getServerName()
        Specified by:
        getServerName in interface javax.servlet.ServletRequest
      • setServerName

        public void setServerName​(String serverName)
      • getServerPort

        public int getServerPort()
        Specified by:
        getServerPort in interface javax.servlet.ServletRequest
      • setServerPort

        public void setServerPort​(int serverPort)
      • isSecure

        public boolean isSecure()
        Specified by:
        isSecure in interface javax.servlet.ServletRequest
      • getMethod

        public String getMethod()
        Specified by:
        getMethod in interface javax.servlet.http.HttpServletRequest
      • setMethod

        public void setMethod​(String method)
      • getDateHeader

        public long getDateHeader​(String name)
        Specified by:
        getDateHeader in interface javax.servlet.http.HttpServletRequest
      • getHeader

        public String getHeader​(String name)
        Specified by:
        getHeader in interface javax.servlet.http.HttpServletRequest
      • getHeaderNames

        public Enumeration<String> getHeaderNames()
        Specified by:
        getHeaderNames in interface javax.servlet.http.HttpServletRequest
      • getHeaders

        public Enumeration<String> getHeaders​(String name)
        Specified by:
        getHeaders in interface javax.servlet.http.HttpServletRequest
      • getIntHeader

        public int getIntHeader​(String name)
        Specified by:
        getIntHeader in interface javax.servlet.http.HttpServletRequest
      • addHeader

        public void addHeader​(String name,
                              String value)
        Add header, keep existing ones with same name.
        Parameters:
        name - Header name
        value - Header value
      • addIntHeader

        public void addIntHeader​(String name,
                                 int value)
        Add header, keep existing ones with same name.
        Parameters:
        name - Header name
        value - Header value
      • addDateHeader

        public void addDateHeader​(String name,
                                  long date)
        Add header, keep existing ones with same name.
        Parameters:
        name - Header name
        date - Header value
      • setHeader

        public void setHeader​(String name,
                              String value)
        Set header, overwrite existing ones with same name.
        Parameters:
        name - Header name
        value - Header value
      • setIntHeader

        public void setIntHeader​(String name,
                                 int value)
        Set header, overwrite existing ones with same name.
        Parameters:
        name - Header name
        value - Header value
      • setDateHeader

        public void setDateHeader​(String name,
                                  long date)
        Set header, overwrite existing ones with same name.
        Parameters:
        name - Header name
        date - Header value
      • getCookie

        public javax.servlet.http.Cookie getCookie​(String name)
        Specified by:
        getCookie in interface org.apache.sling.api.SlingHttpServletRequest
      • getCookies

        public javax.servlet.http.Cookie[] getCookies()
        Specified by:
        getCookies in interface javax.servlet.http.HttpServletRequest
      • addCookie

        public void addCookie​(javax.servlet.http.Cookie cookie)
        Set cookie
        Parameters:
        cookie - Cookie
      • getResourceBundle

        public ResourceBundle getResourceBundle​(Locale locale)
        Specified by:
        getResourceBundle in interface org.apache.sling.api.SlingHttpServletRequest
      • getResourceBundle

        public ResourceBundle getResourceBundle​(String baseName,
                                                Locale locale)
        Specified by:
        getResourceBundle in interface org.apache.sling.api.SlingHttpServletRequest
      • getRequestParameter

        public org.apache.sling.api.request.RequestParameter getRequestParameter​(String name)
        Specified by:
        getRequestParameter in interface org.apache.sling.api.SlingHttpServletRequest
      • getRequestParameterMap

        public org.apache.sling.api.request.RequestParameterMap getRequestParameterMap()
        Specified by:
        getRequestParameterMap in interface org.apache.sling.api.SlingHttpServletRequest
      • getRequestParameters

        public org.apache.sling.api.request.RequestParameter[] getRequestParameters​(String name)
        Specified by:
        getRequestParameters in interface org.apache.sling.api.SlingHttpServletRequest
      • getRequestParameterList

        public List<org.apache.sling.api.request.RequestParameter> getRequestParameterList()
      • addRequestParameter

        public void addRequestParameter​(String name,
                                        String value)
        Add a request parameter that consists of a simple name/value pair. This emulates a simple form field.
        Parameters:
        name - field name
        value - field value
      • addRequestParameter

        public void addRequestParameter​(String name,
                                        byte[] content,
                                        String contentType)
        Add a request parameter that emulates a file upload field.
        Parameters:
        name - field name
        content - file content
        contentType - mime type of content in the field
      • addRequestParameter

        public void addRequestParameter​(String name,
                                        byte[] content,
                                        String contentType,
                                        String filename)
        Add a request parameter that emulates a file upload field with a filename associated with it.
        Parameters:
        name - field name
        content - file content
        contentType - mime type of content in the field
        filename - filename associated with content
      • getCharacterEncoding

        public String getCharacterEncoding()
        Specified by:
        getCharacterEncoding in interface javax.servlet.ServletRequest
      • setCharacterEncoding

        public void setCharacterEncoding​(String charset)
        Specified by:
        setCharacterEncoding in interface javax.servlet.ServletRequest
      • getContentType

        public String getContentType()
        Specified by:
        getContentType in interface javax.servlet.ServletRequest
      • setContentType

        public void setContentType​(String type)
      • getInputStream

        public javax.servlet.ServletInputStream getInputStream()
        Specified by:
        getInputStream in interface javax.servlet.ServletRequest
      • getContentLength

        public int getContentLength()
        Specified by:
        getContentLength in interface javax.servlet.ServletRequest
      • setContent

        public void setContent​(byte[] content)
      • getRequestDispatcher

        public javax.servlet.RequestDispatcher getRequestDispatcher​(String path)
        Specified by:
        getRequestDispatcher in interface javax.servlet.ServletRequest
      • getRequestDispatcher

        public javax.servlet.RequestDispatcher getRequestDispatcher​(String path,
                                                                    org.apache.sling.api.request.RequestDispatcherOptions options)
        Specified by:
        getRequestDispatcher in interface org.apache.sling.api.SlingHttpServletRequest
      • getRequestDispatcher

        public javax.servlet.RequestDispatcher getRequestDispatcher​(org.apache.sling.api.resource.Resource resource)
        Specified by:
        getRequestDispatcher in interface org.apache.sling.api.SlingHttpServletRequest
      • getRequestDispatcher

        public javax.servlet.RequestDispatcher getRequestDispatcher​(org.apache.sling.api.resource.Resource resource,
                                                                    org.apache.sling.api.request.RequestDispatcherOptions options)
        Specified by:
        getRequestDispatcher in interface org.apache.sling.api.SlingHttpServletRequest
      • getRemoteUser

        public String getRemoteUser()
        Specified by:
        getRemoteUser in interface javax.servlet.http.HttpServletRequest
      • setRemoteUser

        public void setRemoteUser​(String remoteUser)
      • getRemoteAddr

        public String getRemoteAddr()
        Specified by:
        getRemoteAddr in interface javax.servlet.ServletRequest
      • setRemoteAddr

        public void setRemoteAddr​(String remoteAddr)
      • getRemoteHost

        public String getRemoteHost()
        Specified by:
        getRemoteHost in interface javax.servlet.ServletRequest
      • setRemoteHost

        public void setRemoteHost​(String remoteHost)
      • getRemotePort

        public int getRemotePort()
        Specified by:
        getRemotePort in interface javax.servlet.ServletRequest
      • setRemotePort

        public void setRemotePort​(int remotePort)
      • getServletPath

        public String getServletPath()
        Specified by:
        getServletPath in interface javax.servlet.http.HttpServletRequest
      • setServletPath

        public void setServletPath​(String servletPath)
      • getPathInfo

        public String getPathInfo()
        Specified by:
        getPathInfo in interface javax.servlet.http.HttpServletRequest
      • setPathInfo

        public void setPathInfo​(String pathInfo)
      • getRequestURI

        public String getRequestURI()
        Specified by:
        getRequestURI in interface javax.servlet.http.HttpServletRequest
      • getRequestURL

        public StringBuffer getRequestURL()
        Specified by:
        getRequestURL in interface javax.servlet.http.HttpServletRequest
      • getAuthType

        public String getAuthType()
        Specified by:
        getAuthType in interface javax.servlet.http.HttpServletRequest
      • setAuthType

        public void setAuthType​(String authType)
      • adaptTo

        public <AdapterType> AdapterType adaptTo​(Class<AdapterType> type)
        Specified by:
        adaptTo in interface org.apache.sling.api.adapter.Adaptable
        Overrides:
        adaptTo in class org.apache.sling.api.adapter.SlingAdaptable
      • getResponseContentType

        public String getResponseContentType()
        Specified by:
        getResponseContentType in interface org.apache.sling.api.SlingHttpServletRequest
      • setResponseContentType

        public void setResponseContentType​(String responseContentType)
      • getResponseContentTypes

        public Enumeration<String> getResponseContentTypes()
        Specified by:
        getResponseContentTypes in interface org.apache.sling.api.SlingHttpServletRequest
      • getReader

        public BufferedReader getReader()
        Specified by:
        getReader in interface javax.servlet.ServletRequest
      • getRequestProgressTracker

        public org.apache.sling.api.request.RequestProgressTracker getRequestProgressTracker()
        Specified by:
        getRequestProgressTracker in interface org.apache.sling.api.SlingHttpServletRequest
      • addPart

        public void addPart​(javax.servlet.http.Part part)
      • getParts

        public Collection<javax.servlet.http.Part> getParts()
        Specified by:
        getParts in interface javax.servlet.http.HttpServletRequest
      • getPart

        public javax.servlet.http.Part getPart​(String name)
        Specified by:
        getPart in interface javax.servlet.http.HttpServletRequest
      • getUserPrincipal

        public Principal getUserPrincipal()
        Specified by:
        getUserPrincipal in interface javax.servlet.http.HttpServletRequest
      • getPathTranslated

        public String getPathTranslated()
        Specified by:
        getPathTranslated in interface javax.servlet.http.HttpServletRequest
      • getRequestedSessionId

        public String getRequestedSessionId()
        Specified by:
        getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromCookie

        public boolean isRequestedSessionIdFromCookie()
        Specified by:
        isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromURL

        public boolean isRequestedSessionIdFromURL()
        Specified by:
        isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdFromUrl

        public boolean isRequestedSessionIdFromUrl()
        Specified by:
        isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
      • isRequestedSessionIdValid

        public boolean isRequestedSessionIdValid()
        Specified by:
        isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
      • isUserInRole

        public boolean isUserInRole​(String role)
        Specified by:
        isUserInRole in interface javax.servlet.http.HttpServletRequest
      • getLocalAddr

        public String getLocalAddr()
        Specified by:
        getLocalAddr in interface javax.servlet.ServletRequest
      • getLocalName

        public String getLocalName()
        Specified by:
        getLocalName in interface javax.servlet.ServletRequest
      • getLocalPort

        public int getLocalPort()
        Specified by:
        getLocalPort in interface javax.servlet.ServletRequest
      • getLocales

        public Enumeration<Locale> getLocales()
        Specified by:
        getLocales in interface javax.servlet.ServletRequest
      • getProtocol

        public String getProtocol()
        Specified by:
        getProtocol in interface javax.servlet.ServletRequest
      • getRealPath

        public String getRealPath​(String path)
        Specified by:
        getRealPath in interface javax.servlet.ServletRequest
      • authenticate

        public boolean authenticate​(javax.servlet.http.HttpServletResponse response)
        Specified by:
        authenticate in interface javax.servlet.http.HttpServletRequest
      • login

        public void login​(String pUsername,
                          String password)
        Specified by:
        login in interface javax.servlet.http.HttpServletRequest
      • logout

        public void logout()
                    throws javax.servlet.ServletException
        Specified by:
        logout in interface javax.servlet.http.HttpServletRequest
        Throws:
        javax.servlet.ServletException
      • getServletContext

        public javax.servlet.ServletContext getServletContext()
        Specified by:
        getServletContext in interface javax.servlet.ServletRequest
      • startAsync

        public javax.servlet.AsyncContext startAsync()
        Specified by:
        startAsync in interface javax.servlet.ServletRequest
      • startAsync

        public javax.servlet.AsyncContext startAsync​(javax.servlet.ServletRequest servletRequest,
                                                     javax.servlet.ServletResponse servletResponse)
        Specified by:
        startAsync in interface javax.servlet.ServletRequest
      • isAsyncStarted

        public boolean isAsyncStarted()
        Specified by:
        isAsyncStarted in interface javax.servlet.ServletRequest
      • isAsyncSupported

        public boolean isAsyncSupported()
        Specified by:
        isAsyncSupported in interface javax.servlet.ServletRequest
      • getAsyncContext

        public javax.servlet.AsyncContext getAsyncContext()
        Specified by:
        getAsyncContext in interface javax.servlet.ServletRequest
      • getDispatcherType

        public javax.servlet.DispatcherType getDispatcherType()
        Specified by:
        getDispatcherType in interface javax.servlet.ServletRequest
      • changeSessionId

        public String changeSessionId()
        Specified by:
        changeSessionId in interface javax.servlet.http.HttpServletRequest
      • upgrade

        public <T extends javax.servlet.http.HttpUpgradeHandler> T upgrade​(Class<T> handlerClass)
                                                                    throws IOException,
                                                                           javax.servlet.ServletException
        Specified by:
        upgrade in interface javax.servlet.http.HttpServletRequest
        Throws:
        IOException
        javax.servlet.ServletException
      • getContentLengthLong

        public long getContentLengthLong()
        Specified by:
        getContentLengthLong in interface javax.servlet.ServletRequest