FakeHttpServletRequest (Apache Shindig Common Code 2.5.2 Test API)

java.lang.Object
- org.apache.shindig.common.testing.FakeHttpServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class FakeHttpServletRequest
extends Object
implements javax.servlet.http.HttpServletRequest
```
This class fakes a HttpServletRequest for unit test purposes. Currently, it supports servlet API 2.4.
To use this class, you specify the request info (URL, parameters) in the constructors.
Lots of stuff are still not implemented here. Feel free to implement them.

Field Summary

Fields
Modifier and Type	Field and Description
`protected Map<String,Object>`	`attributes`
`protected String`	`characterEncoding`
`protected String`	`contentType`
`protected String`	`contextPath`
`protected Map<String,javax.servlet.http.Cookie>`	`cookies`
`protected static String`	`DEFAULT_HOST`
`protected static int`	`DEFAULT_PORT`
`protected boolean`	`getInputStreamCalled`
`protected boolean`	`getReaderCalled`
`protected Hashtable<String,String>`	`headers`
`protected String`	`host`
`protected String`	`ip`
`protected Locale`	`locale`
`protected List<Locale>`	`locales`
`protected String`	`method`
`protected Map<String,String[]>`	`parameters`
`protected String`	`pathInfo`
`protected int`	`port`
`protected byte[]`	`postData`
`protected Set<String>`	`postParameters`
`protected String`	`protocol`
`protected String`	`queryString`
`protected String`	`scheme`
`protected boolean`	`secure`
`protected String`	`servletPath`

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

Constructor Summary

Constructors
Constructor and Description
`FakeHttpServletRequest()`
`FakeHttpServletRequest(String urlStr)`
`FakeHttpServletRequest(String host, int port, String contextPath, String servletPath, String queryString)` Example: http://www.example.com:1234/foo/bar?abc=xyz "www.example.com" is the host 1234 is the port "/foo" is the contextPath "/bar" is the servletPath "abc=xyz" is the queryString
`FakeHttpServletRequest(String contextPath, String servletPath, String queryString)`
`FakeHttpServletRequest(String host, String port, String contextPath, String servletPath, String queryString)`

Method Summary

Methods
Modifier and Type	Method and Description
`protected void`	`addParameter(Map<String,String[]> parameters, String name, String value)`
`protected void`	`constructor(String host, int port, String contextPath, String servletPath, String queryString)` This method serves as the central constructor of this class.
`protected void`	`decodeQueryString(String queryString, Map<String,String[]> parameters)`
`Object`	`getAttribute(String name)`
`Enumeration<?>`	`getAttributeNames()`
`String`	`getAuthType()`
`String`	`getCharacterEncoding()`
`int`	`getContentLength()`
`String`	`getContentType()`
`String`	`getContextPath()`
`javax.servlet.http.Cookie[]`	`getCookies()`
`long`	`getDateHeader(String name)`
`String`	`getHeader(String name)`
`Enumeration<String>`	`getHeaderNames()`
`Enumeration<?>`	`getHeaders(String name)`
`javax.servlet.ServletInputStream`	`getInputStream()` Get the body of the request (i.e.
`int`	`getIntHeader(String name)`
`String`	`getLocalAddr()`
`Locale`	`getLocale()`
`Enumeration<?>`	`getLocales()`
`String`	`getLocalName()`
`int`	`getLocalPort()`
`String`	`getMethod()`
`String`	`getParameter(String name)`
`Map<String,String[]>`	`getParameterMap()`
`Enumeration<String>`	`getParameterNames()`
`String[]`	`getParameterValues(String name)`
`String`	`getPathInfo()`
`String`	`getPathTranslated()`
`String`	`getProtocol()`
`String`	`getQueryString()`
`BufferedReader`	`getReader()`
`String`	`getRealPath(String path)` Deprecated.
`String`	`getRemoteAddr()`
`String`	`getRemoteHost()`
`int`	`getRemotePort()`
`String`	`getRemoteUser()`
`javax.servlet.RequestDispatcher`	`getRequestDispatcher(String path)`
`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`	`isRequestedSessionIdFromCookie()`
`boolean`	`isRequestedSessionIdFromUrl()` Deprecated.
`boolean`	`isRequestedSessionIdFromURL()`
`boolean`	`isRequestedSessionIdValid()`
`boolean`	`isSecure()`
`boolean`	`isUserInRole(String role)`
`void`	`removeAttribute(String name)`
`void`	`setAttribute(String name, Object value)`
`void`	`setCharacterEncoding(String env)`
`FakeHttpServletRequest`	`setContentType(String contentType)` Sets the content type.
`FakeHttpServletRequest`	`setCookie(javax.servlet.http.Cookie c)` Sets a single cookie associated with this fake request.
`FakeHttpServletRequest`	`setCookies(javax.servlet.http.Cookie... cookies)` Associates a set of cookies with this fake request.
`FakeHttpServletRequest`	`setDateHeader(String name, long value)`
`FakeHttpServletRequest`	`setHeader(String name, String value)`
`FakeHttpServletRequest`	`setLocale(Locale locale)`
`FakeHttpServletRequest`	`setLocales(List<Locale> locales)`
`FakeHttpServletRequest`	`setMethod(String method)`
`FakeHttpServletRequest`	`setParameter(String name, boolean isPost, String... values)` Sets the a parameter in this fake request.
`FakeHttpServletRequest`	`setParameter(String name, String... values)` Sets the a parameter in this fake request.
`FakeHttpServletRequest`	`setPathInfo(String path)` Set the path info field.
`FakeHttpServletRequest`	`setPostData(byte[] data)` Specify the mock POST data in raw binary format.
`FakeHttpServletRequest`	`setPostData(String postString, String encoding)` Specify the mock POST data.
`FakeHttpServletRequest`	`setProtocol(String prot)`
`FakeHttpServletRequest`	`setQueryString(String queryString)` Set a new value for the query string.
`FakeHttpServletRequest`	`setRemoteAddr(String ip)` Sets the remote IP address for this `FakeHttpServletRequest`.
`FakeHttpServletRequest`	`setSecure(boolean secure)`
`FakeHttpServletRequest`	`setServletPath(String servletPath)`
`FakeHttpServletRequest`	`setSession(javax.servlet.http.HttpSession session)` Sets the session for this request.

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

- Field Detail
  - DEFAULT_HOST
```
protected static final String DEFAULT_HOST
```
    See Also:
    Constant Field Values
  - DEFAULT_PORT
```
protected static final int DEFAULT_PORT
```
    See Also:
    Constant Field Values
  - scheme
```
protected String scheme
```
  - host
```
protected String host
```
  - port
```
protected int port
```
  - secure
```
protected boolean secure
```
  - method
```
protected String method
```
  - protocol
```
protected String protocol
```
  - contextPath
```
protected String contextPath
```
  - servletPath
```
protected String servletPath
```
  - pathInfo
```
protected String pathInfo
```
  - queryString
```
protected String queryString
```
  - ip
```
protected String ip
```
  - contentType
```
protected String contentType
```
  - headers
```
protected Hashtable<String,String> headers
```
  - parameters
```
protected Map<String,String[]> parameters
```
  - postParameters
```
protected Set<String> postParameters
```
  - cookies
```
protected Map<String,javax.servlet.http.Cookie> cookies
```
  - attributes
```
protected Map<String,Object> attributes
```
  - locale
```
protected Locale locale
```
  - locales
```
protected List<Locale> locales
```
  - postData
```
protected byte[] postData
```
  - characterEncoding
```
protected String characterEncoding
```
  - getReaderCalled
```
protected boolean getReaderCalled
```
  - getInputStreamCalled
```
protected boolean getInputStreamCalled
```
- Constructor Detail
  - FakeHttpServletRequest
```
public FakeHttpServletRequest(String host,
                      int port,
                      String contextPath,
                      String servletPath,
                      String queryString)
```
    Example: http://www.example.com:1234/foo/bar?abc=xyz "www.example.com" is the host 1234 is the port "/foo" is the contextPath "/bar" is the servletPath "abc=xyz" is the queryString
  - FakeHttpServletRequest
```
public FakeHttpServletRequest(String host,
                      String port,
                      String contextPath,
                      String servletPath,
                      String queryString)
```
  - FakeHttpServletRequest
```
public FakeHttpServletRequest(String contextPath,
                      String servletPath,
                      String queryString)
```
  - FakeHttpServletRequest
```
public FakeHttpServletRequest()
```
  - FakeHttpServletRequest
```
public FakeHttpServletRequest(String urlStr)
                       throws MalformedURLException
```
    Throws:
    
    MalformedURLException
- Method Detail
  - setLocale
```
public FakeHttpServletRequest setLocale(Locale locale)
```
  - setLocales
```
public FakeHttpServletRequest setLocales(List<Locale> locales)
```
  - setProtocol
```
public FakeHttpServletRequest setProtocol(String prot)
```
  - setSecure
```
public FakeHttpServletRequest setSecure(boolean secure)
```
  - setHeader
```
public FakeHttpServletRequest setHeader(String name,
                               String value)
```
  - setCookies
```
public FakeHttpServletRequest setCookies(javax.servlet.http.Cookie... cookies)
```
    Associates a set of cookies with this fake request.
    
    Parameters:
    cookies - the cookies associated with this request.
  - setCookie
```
public FakeHttpServletRequest setCookie(javax.servlet.http.Cookie c)
```
    Sets a single cookie associated with this fake request. Cookies are cumulative, but ones with the same name will overwrite one another.
    
    Parameters:
    c - the cookie to associate with this request.
  - setParameter
```
public FakeHttpServletRequest setParameter(String name,
                                  boolean isPost,
                                  String... values)
```
    Sets the a parameter in this fake request.
    
    Parameters:
    name - the string key
    values - the string array value
    isPost - if the paramenter comes in the post body.
  - setParameter
```
public FakeHttpServletRequest setParameter(String name,
                                  String... values)
```
    Sets the a parameter in this fake request.
    
    Parameters:
    name - the string key
    values - the string array value
  - setPathInfo
```
public FakeHttpServletRequest setPathInfo(String path)
```
    Set the path info field.
  - setPostData
```
public FakeHttpServletRequest setPostData(String postString,
                                 String encoding)
                                   throws UnsupportedEncodingException
```
    Specify the mock POST data.
    
    Parameters:
    postString - the mock post data
    encoding - format with which to encode mock post data
    
    Throws:
    
    UnsupportedEncodingException
  - setPostData
```
public FakeHttpServletRequest setPostData(byte[] data)
```
    Specify the mock POST data in raw binary format. This implicitly sets character encoding to not specified.
    
    Parameters:
    data - the mock post data; this is owned by the caller, so modifications made after this call will show up when the post data is read
  - setQueryString
```
public FakeHttpServletRequest setQueryString(String queryString)
```
    Set a new value for the query string. The query string will be parsed and all parameters reset.
    
    Parameters:
    queryString - representing the new value. i.e.: "bug=1&id=23"
  - setSession
```
public FakeHttpServletRequest setSession(javax.servlet.http.HttpSession session)
```
    Sets the session for this request.
    
    Parameters:
    session - the new session
  - setContentType
```
public FakeHttpServletRequest setContentType(String contentType)
```
    Sets the content type.
    
    Parameters:
    contentType - of the request.
  - getAuthType
```
public String getAuthType()
```
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - getContextPath
```
public String getContextPath()
```
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
  - getDateHeader
```
public long getDateHeader(String name)
```
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
  - setDateHeader
```
public FakeHttpServletRequest setDateHeader(String name,
                                   long value)
```
  - 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<?> 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
  - getMethod
```
public String getMethod()
```
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
  - setMethod
```
public FakeHttpServletRequest setMethod(String method)
```
  - 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
  - getQueryString
```
public String getQueryString()
```
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
  - getRemoteUser
```
public String getRemoteUser()
```
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public String getRequestedSessionId()
```
    Specified by:
    
    getRequestedSessionId 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
  - getServletPath
```
public String getServletPath()
```
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - setServletPath
```
public FakeHttpServletRequest setServletPath(String servletPath)
```
  - 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
  - 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
```
@Deprecated
public boolean isRequestedSessionIdFromUrl()
```
    Deprecated.
    
    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
  - getAttribute
```
public Object getAttribute(String name)
```
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
  - getAttributeNames
```
public Enumeration<?> getAttributeNames()
```
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - 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()
```
    Get the body of the request (i.e. the POST data) as a binary stream. As per Java docs, this OR getReader() may be called, but not both (attempting that will result in an IllegalStateException)
    
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
  - getLocale
```
public Locale getLocale()
```
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public Enumeration<?> getLocales()
```
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - 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
  - getProtocol
```
public String getProtocol()
```
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
  - getReader
```
public BufferedReader getReader()
                         throws IOException
```
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    IOException
  - getRealPath
```
@Deprecated
public String getRealPath(String path)
```
    Deprecated.
    
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - getRemoteAddr
```
public String getRemoteAddr()
```
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
  - setRemoteAddr
```
public FakeHttpServletRequest setRemoteAddr(String ip)
```
    Sets the remote IP address for this FakeHttpServletRequest.
    
    Parameters:
    ip - the IP to set
    
    Returns:
    this FakeHttpServletRequest object
  - getRemoteHost
```
public String getRemoteHost()
```
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Specified by:
    
    getLocalPort 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
  - 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
  - getScheme
```
public String getScheme()
```
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
  - getServerName
```
public String getServerName()
```
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
  - getServerPort
```
public int getServerPort()
```
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Specified by:
    
    isSecure 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 value)
```
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(String env)
```
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
  - constructor
```
protected void constructor(String host,
               int port,
               String contextPath,
               String servletPath,
               String queryString)
```
    This method serves as the central constructor of this class. The reason it is not an actual constructor is that Java doesn't allow calling another constructor at the end of a constructor. e.g.
```
 public FakeHttpServletRequest(String foo) {
   // Do something here
   this(foo, bar); // calling another constructor here is not allowed
 }
 
```
  - decodeQueryString
```
protected void decodeQueryString(String queryString,
                     Map<String,String[]> parameters)
```
  - addParameter
```
protected void addParameter(Map<String,String[]> parameters,
                String name,
                String value)
```

Class FakeHttpServletRequest

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

DEFAULT_HOST

DEFAULT_PORT

scheme

host

port

secure

method

protocol

contextPath

servletPath

pathInfo

queryString

ip

contentType

headers

parameters

postParameters

cookies

attributes

locale

locales

postData

characterEncoding

getReaderCalled

getInputStreamCalled

Constructor Detail

FakeHttpServletRequest

FakeHttpServletRequest

FakeHttpServletRequest

FakeHttpServletRequest

FakeHttpServletRequest

Method Detail

setLocale

setLocales

setProtocol

setSecure

setHeader

setCookies

setCookie

setParameter

setParameter

setPathInfo

setPostData

setPostData

setQueryString

setSession

setContentType

getAuthType

getContextPath

getCookies

getDateHeader

setDateHeader

getHeader

getHeaderNames

getHeaders

getIntHeader

getMethod

setMethod

getPathInfo

getPathTranslated

getQueryString

getRemoteUser

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

setServletPath

getSession

getSession

getUserPrincipal

isRequestedSessionIdFromCookie

isRequestedSessionIdFromUrl

isRequestedSessionIdFromURL