MockSlingHttpServletRequest (Apache Sling Testing Sling Mock 1.0.0 API)

java.lang.Object
- org.apache.sling.api.adapter.SlingAdaptable
- - org.apache.sling.testing.mock.sling.servlet.MockSlingHttpServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest, org.apache.sling.api.adapter.Adaptable, org.apache.sling.api.SlingHttpServletRequest
```
public class MockSlingHttpServletRequest
extends org.apache.sling.api.adapter.SlingAdaptable
implements org.apache.sling.api.SlingHttpServletRequest
```
Mock SlingHttpServletRequest implementation.

Field Summary
- Fields inherited from interface javax.servlet.http.HttpServletRequest
  BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

Constructors
Constructor and Description
`MockSlingHttpServletRequest()` Instantiate with default resource resolver
`MockSlingHttpServletRequest(org.apache.sling.api.resource.ResourceResolver resourceResolver)`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addCookie(javax.servlet.http.Cookie cookie)` Set cookie
`void`	`addDateHeader(String name, long date)` Add header, keep existing ones with same name.
`void`	`addHeader(String name, String value)` Add header, keep existing ones with same name.
`void`	`addIntHeader(String name, int value)` Add header, keep existing ones with same name.
`boolean`	`authenticate(javax.servlet.http.HttpServletResponse response)`
`javax.servlet.AsyncContext`	`getAsyncContext()`
`Object`	`getAttribute(String name)`
`Enumeration<String>`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie`	`getCookie(String name)`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`javax.servlet.DispatcherType`	`getDispatcherType()`
`String`	`getHeader(String name)`
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<String>`	`getHeaders(String name)`
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<Locale>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`javax.servlet.http.Part`	`getPart(String name)`
`Collection<javax.servlet.http.Part>`	`getParts()`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)`
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(org.apache.sling.api.resource.Resource dispatcherResource)`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(org.apache.sling.api.resource.Resource dispatcherResource, org.apache.sling.api.request.RequestDispatcherOptions options)`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String dispatcherPath, org.apache.sling.api.request.RequestDispatcherOptions options)`
`String`	`getRequestedSessionId()`
`org.apache.sling.api.request.RequestParameter`	`getRequestParameter(String name)`
`List<org.apache.sling.api.request.RequestParameter>`	`getRequestParameterList()`
`org.apache.sling.api.request.RequestParameterMap`	`getRequestParameterMap()`
`org.apache.sling.api.request.RequestParameter[]`	`getRequestParameters(String name)`
`org.apache.sling.api.request.RequestPathInfo`	`getRequestPathInfo()`
`org.apache.sling.api.request.RequestProgressTracker`	`getRequestProgressTracker()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`org.apache.sling.api.resource.Resource`	`getResource()`
`ResourceBundle`	`getResourceBundle(Locale pLocale)`
`ResourceBundle`	`getResourceBundle(String baseName, Locale locale)`
`org.apache.sling.api.resource.ResourceResolver`	`getResourceResolver()`
`String`	`getResponseContentType()`
`Enumeration<String>`	`getResponseContentTypes()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`javax.servlet.ServletContext`	`getServletContext()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`boolean`	`isAsyncStarted()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`login(String pUsername, String password)`
`void`	`logout()`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object object)`
`void`	`setCharacterEncoding(String env)`
`void`	`setContextPath(String contextPath)`
`void`	`setDateHeader(String name, long date)` Set header, overwrite existing ones with same name.
`void`	`setHeader(String name, String value)` Set header, overwrite existing ones with same name.
`void`	`setIntHeader(String name, int value)` Set header, overwrite existing ones with same name.
`void`	`setMethod(String method)`
`void`	`setParameterMap(Map<String,Object> parameterMap)`
`void`	`setQueryString(String queryString)`
`void`	`setResource(org.apache.sling.api.resource.Resource resource)`
`void`	`setScheme(String scheme)`
`void`	`setServerName(String serverName)`
`void`	`setServerPort(int serverPort)`
`javax.servlet.AsyncContext`	`startAsync()`
`javax.servlet.AsyncContext`	`startAsync(javax.servlet.ServletRequest servletRequest, javax.servlet.ServletResponse servletResponse)`

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable
adaptTo, setAdapterManager, unsetAdapterManager

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.sling.api.adapter.Adaptable
adaptTo

- Constructor Detail
  - MockSlingHttpServletRequest
```
public MockSlingHttpServletRequest()
```
    Instantiate with default resource resolver
  - 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
  - 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
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(org.apache.sling.api.resource.Resource dispatcherResource)
```
    Specified by:
    
    getRequestDispatcher in interface org.apache.sling.api.SlingHttpServletRequest
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String dispatcherPath,
                                                   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 dispatcherResource,
                                                   org.apache.sling.api.request.RequestDispatcherOptions options)
```
    Specified by:
    
    getRequestDispatcher 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
  - getRequestProgressTracker
```
public org.apache.sling.api.request.RequestProgressTracker getRequestProgressTracker()
```
    Specified by:
    
    getRequestProgressTracker in interface org.apache.sling.api.SlingHttpServletRequest
  - getResourceBundle
```
public ResourceBundle getResourceBundle(Locale pLocale)
```
    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
  - getResponseContentType
```
public String getResponseContentType()
```
    Specified by:
    
    getResponseContentType in interface org.apache.sling.api.SlingHttpServletRequest
  - getResponseContentTypes
```
public Enumeration<String> getResponseContentTypes()
```
    Specified by:
    
    getResponseContentTypes in interface org.apache.sling.api.SlingHttpServletRequest
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - getPathInfo
```
public String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
  - getPathTranslated
```
public String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - 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
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal 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
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
  - 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
  - getReader
```
public BufferedReader getReader()
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
  - getRealPath
```
public String getRealPath(String path)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String env)
```
    Specified by:
    
    setCharacterEncoding 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
  - 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
  - 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
  - getRequestParameterList
```
public List<org.apache.sling.api.request.RequestParameter> getRequestParameterList()
```

Class MockSlingHttpServletRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class org.apache.sling.api.adapter.SlingAdaptable

Methods inherited from class java.lang.Object

Methods inherited from interface org.apache.sling.api.adapter.Adaptable

Constructor Detail

MockSlingHttpServletRequest

MockSlingHttpServletRequest

Method Detail

getResourceResolver

getSession

getSession

getRequestPathInfo

getAttribute

getAttributeNames

removeAttribute

setAttribute

getResource

setResource

getParameter

getParameterMap

getParameterNames

getParameterValues

setParameterMap

getLocale

getContextPath

setContextPath

setQueryString

getQueryString

getScheme

setScheme

getServerName

setServerName

getServerPort

setServerPort

isSecure

getMethod

setMethod

getDateHeader

getHeader

getHeaderNames

getHeaders

getIntHeader

addHeader

addIntHeader

addDateHeader

setHeader

setIntHeader

setDateHeader

getCookie

getCookies

addCookie

getRequestDispatcher

getRequestDispatcher

getRequestDispatcher

getRequestParameter

getRequestParameterMap

getRequestParameters

getRequestProgressTracker

getResourceBundle

getResourceBundle

getResponseContentType

getResponseContentTypes

getAuthType

getPathInfo

getPathTranslated

getRemoteUser

getRequestURI

getRequestURL

getRequestedSessionId

getServletPath

getUserPrincipal

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

isRequestedSessionIdValid

isUserInRole