MockHttpServletRequest (MockRunner-Servlet 1.0.9 API)

java.lang.Object
- com.mockrunner.mock.web.MockHttpServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class MockHttpServletRequest
extends Object
implements javax.servlet.http.HttpServletRequest
```
Mock implementation of HttpServletRequest.

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

MockHttpServletRequest()

Constructors
Constructor and Description
`MockHttpServletRequest()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addAttributeListener(javax.servlet.ServletRequestAttributeListener listener)`
`void`	`addCookie(javax.servlet.http.Cookie cookie)`
`void`	`addHeader(String key, String value)`
`void`	`addLocale(Locale locale)`
`void`	`addLocales(List localeList)`
`void`	`clearAttributes()`
`void`	`clearHeaders()`
`void`	`clearParameters()` Clears the parameters.
`void`	`clearRequestDispatcherMap()` Clears the map of `RequestDispatcher` objects.
`Object`	`getAttribute(String key)`
`Enumeration`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String key)`
`String`	`getHeader(String key)`
`Enumeration`	`getHeaderNames()`
`Enumeration`	`getHeaders(String key)`
`javax.servlet.ServletInputStream`	`getInputStream()`
`int`	`getIntHeader(String key)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String key)`
`Map`	`getParameterMap()`
`Enumeration`	`getParameterNames()`
`String[]`	`getParameterValues(String key)`
`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(String path)`
`Map`	`getRequestDispatcherMap()` Returns the map of `RequestDispatcher` objects.
`String`	`getRequestedSessionId()`
`String`	`getRequestURI()`
`StringBuffer`	`getRequestURL()`
`String`	`getScheme()`
`String`	`getServerName()`
`int`	`getServerPort()`
`String`	`getServletPath()`
`javax.servlet.http.HttpSession`	`getSession()`
`javax.servlet.http.HttpSession`	`getSession(boolean create)`
`Principal`	`getUserPrincipal()`
`boolean`	`isAsyncSupported()`
`boolean`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()`
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`removeAttribute(String key)`
`void`	`resetAll()` Resets the state of this object to the default values
`void`	`setAsyncSupported(boolean isAsyncSupported)`
`void`	`setAttribute(String key, Object value)`
`void`	`setAuthType(String authType)`
`void`	`setBodyContent(byte[] data)`
`void`	`setBodyContent(String bodyContent)`
`void`	`setCharacterEncoding(String characterEncoding)`
`void`	`setContentLength(int contentLength)`
`void`	`setContentType(String contentType)`
`void`	`setContextPath(String contextPath)`
`void`	`setHeader(String key, String value)`
`void`	`setLocalAddr(String localAddr)`
`void`	`setLocalName(String localName)`
`void`	`setLocalPort(int localPort)`
`void`	`setMethod(String method)`
`void`	`setPathInfo(String pathInfo)`
`void`	`setPathTranslated(String pathTranslated)`
`void`	`setProtocol(String protocol)`
`void`	`setQueryString(String queryString)`
`void`	`setRemoteAddr(String remoteAddr)`
`void`	`setRemoteHost(String remoteHost)`
`void`	`setRemotePort(int remotePort)`
`void`	`setRemoteUser(String remoteUser)`
`void`	`setRequestDispatcher(String path, javax.servlet.RequestDispatcher dispatcher)` Sets a `RequestDispatcher` that will be returned when calling `getRequestDispatcher(java.lang.String)` with the specified path.
`void`	`setRequestedSessionIdFromCookie(boolean requestedSessionIdIsFromCookie)`
`void`	`setRequestURI(String requestUri)`
`void`	`setRequestURL(String requestUrl)`
`void`	`setScheme(String scheme)`
`void`	`setServerName(String serverName)`
`void`	`setServerPort(int serverPort)`
`void`	`setServletPath(String servletPath)`
`void`	`setSession(javax.servlet.http.HttpSession session)` Sets the `HttpSession`.
`void`	`setupAddParameter(String key, String value)` Adds a request parameter.
`void`	`setupAddParameter(String key, String[] values)` Adds a request multivalue parameter.
`void`	`setUserInRole(String role, boolean isInRole)`
`void`	`setUserPrincipal(Principal principal)`

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

- Constructor Detail
  - MockHttpServletRequest
```
public MockHttpServletRequest()
```
- Method Detail
  - resetAll
```
public void resetAll()
```
    Resets the state of this object to the default values
  - addAttributeListener
```
public void addAttributeListener(javax.servlet.ServletRequestAttributeListener listener)
```
  - getParameter
```
public String getParameter(String key)
```
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
  - clearParameters
```
public void clearParameters()
```
    Clears the parameters.
  - getParameterValues
```
public String[] getParameterValues(String key)
```
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
  - setupAddParameter
```
public void setupAddParameter(String key,
                     String[] values)
```
    Adds a request multivalue parameter.
    
    Parameters:
    key - the parameter key
    values - the parameters values
  - setupAddParameter
```
public void setupAddParameter(String key,
                     String value)
```
    Adds a request parameter.
    
    Parameters:
    key - the parameter key
    value - the parameters value
  - getParameterNames
```
public Enumeration getParameterNames()
```
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
  - getParameterMap
```
public Map getParameterMap()
```
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
  - clearAttributes
```
public void clearAttributes()
```
  - getAttribute
```
public Object getAttribute(String key)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
  - getAttributeNames
```
public Enumeration getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(String key)
```
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(String key,
                Object value)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
  - 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
  - setSession
```
public void setSession(javax.servlet.http.HttpSession session)
```
    Sets the HttpSession.
    
    Parameters:
    session - the HttpSession
  - getRequestDispatcher
```
public javax.servlet.RequestDispatcher getRequestDispatcher(String path)
```
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - getRequestDispatcherMap
```
public Map getRequestDispatcherMap()
```
    Returns the map of RequestDispatcher objects. The specified path maps to the corresponding RequestDispatcher object.
    
    Returns:
    the map of RequestDispatcher objects
  - clearRequestDispatcherMap
```
public void clearRequestDispatcherMap()
```
    Clears the map of RequestDispatcher objects.
  - setRequestDispatcher
```
public void setRequestDispatcher(String path,
                        javax.servlet.RequestDispatcher dispatcher)
```
    Sets a RequestDispatcher that will be returned when calling getRequestDispatcher(java.lang.String) with the specified path. If no RequestDispatcher is set for the specified path, getRequestDispatcher(java.lang.String) automatically creates a new one.
    
    Parameters:
    path - the path for the RequestDispatcher
    dispatcher - the RequestDispatcher object
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public Enumeration getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - addLocale
```
public void addLocale(Locale locale)
```
  - addLocales
```
public void addLocales(List localeList)
```
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
  - setMethod
```
public void setMethod(String method)
```
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - setAuthType
```
public void setAuthType(String authType)
```
  - getDateHeader
```
public long getDateHeader(String key)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
  - getHeader
```
public String getHeader(String key)
```
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
  - getHeaderNames
```
public Enumeration getHeaderNames()
```
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
  - getHeaders
```
public Enumeration getHeaders(String key)
```
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(String key)
```
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
  - addHeader
```
public void addHeader(String key,
             String value)
```
  - setHeader
```
public void setHeader(String key,
             String value)
```
  - clearHeaders
```
public void clearHeaders()
```
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - setContextPath
```
public void setContextPath(String contextPath)
```
  - getPathInfo
```
public String getPathInfo()
```
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
  - setPathInfo
```
public void setPathInfo(String pathInfo)
```
  - getPathTranslated
```
public String getPathTranslated()
```
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
  - setPathTranslated
```
public void setPathTranslated(String pathTranslated)
```
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
  - setQueryString
```
public void setQueryString(String queryString)
```
  - getRequestURI
```
public String getRequestURI()
```
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
  - setRequestURI
```
public void setRequestURI(String requestUri)
```
  - getRequestURL
```
public StringBuffer getRequestURL()
```
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
  - setRequestURL
```
public void setRequestURL(String requestUrl)
```
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - setServletPath
```
public void setServletPath(String servletPath)
```
  - getUserPrincipal
```
public Principal getUserPrincipal()
```
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
  - setUserPrincipal
```
public void setUserPrincipal(Principal principal)
```
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - setRemoteUser
```
public void setRemoteUser(String remoteUser)
```
  - 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)
```
  - 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
  - setRequestedSessionIdFromCookie
```
public void setRequestedSessionIdFromCookie(boolean requestedSessionIdIsFromCookie)
```
  - 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
  - setUserInRole
```
public void setUserInRole(String role,
                 boolean isInRole)
```
  - getCharacterEncoding
```
public String getCharacterEncoding()
```
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String characterEncoding)
                          throws UnsupportedEncodingException
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
    
    Throws:
    
    UnsupportedEncodingException
  - getContentLength
```
public int getContentLength()
```
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
  - setContentLength
```
public void setContentLength(int contentLength)
```
  - getContentType
```
public String getContentType()
```
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
  - setContentType
```
public void setContentType(String contentType)
```
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
  - setProtocol
```
public void setProtocol(String protocol)
```
  - 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)
```
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
  - setScheme
```
public void setScheme(String scheme)
```
  - 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)
```
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws IOException
```
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - setBodyContent
```
public void setBodyContent(byte[] data)
```
  - setBodyContent
```
public void setBodyContent(String bodyContent)
```
  - getRealPath
```
public String getRealPath(String path)
```
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
  - getLocalAddr
```
public String getLocalAddr()
```
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - setLocalAddr
```
public void setLocalAddr(String localAddr)
```
  - getLocalName
```
public String getLocalName()
```
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
  - setLocalName
```
public void setLocalName(String localName)
```
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
  - setLocalPort
```
public void setLocalPort(int localPort)
```
  - getRemotePort
```
public int getRemotePort()
```
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
  - setRemotePort
```
public void setRemotePort(int remotePort)
```
  - isAsyncSupported
```
public boolean isAsyncSupported()
```
  - setAsyncSupported
```
public void setAsyncSupported(boolean isAsyncSupported)
```

Class MockHttpServletRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

MockHttpServletRequest

Method Detail

resetAll

addAttributeListener

getParameter

clearParameters

getParameterValues

setupAddParameter

setupAddParameter

getParameterNames

getParameterMap

clearAttributes

getAttribute

getAttributeNames

removeAttribute

setAttribute

getSession

getSession

setSession

getRequestDispatcher

getRequestDispatcherMap

clearRequestDispatcherMap

setRequestDispatcher

getLocale

getLocales

addLocale

addLocales

getMethod

setMethod

getAuthType

setAuthType

getDateHeader

getHeader

getHeaderNames

getHeaders

getIntHeader

addHeader

setHeader

clearHeaders

getContextPath

setContextPath

getPathInfo

setPathInfo

getPathTranslated

setPathTranslated

getQueryString

setQueryString

getRequestURI

setRequestURI

getRequestURL

setRequestURL

getServletPath

setServletPath

getUserPrincipal

setUserPrincipal

getRemoteUser

setRemoteUser

getCookies

addCookie

getRequestedSessionId

isRequestedSessionIdFromCookie

isRequestedSessionIdFromUrl

isRequestedSessionIdFromURL

setRequestedSessionIdFromCookie

isRequestedSessionIdValid

isUserInRole

setUserInRole

getCharacterEncoding

setCharacterEncoding

getContentLength

setContentLength

getContentType

setContentType