MockHttpServletRequest (Stripes 1.5.3 API Documentation)

java.lang.Object
- net.sourceforge.stripes.mock.MockHttpServletRequest

All Implemented Interfaces:

javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest
```
public class MockHttpServletRequest
extends java.lang.Object
implements javax.servlet.http.HttpServletRequest
```
Mock implementation of an HttpServletRequest object. Allows for setting most values that are likely to be of interest (and can always be subclassed to affect others). Of key interest and perhaps not completely obvious, the way to get request parameters into an instance of MockHttpServletRequest is to fetch the parameter map using getParameterMap() and use the put() and putAll() methods on it. Values must be String arrays. Examples follow:
```
 MockHttpServletRequest req = new MockHttpServletRequest("/foo", "/bar.action");
 req.getParameterMap().put("param1", new String[] {"value"});
 req.getParameterMap().put("param2", new String[] {"value1", "value2"});
 
```
It should also be noted that unless you generate an instance of MockHttpSession (or another implementation of HttpSession) and set it on the request, then your request will never have a session associated with it.
Since:

Stripes 1.1.1

Author:

Tim Fennell

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(java.lang.String contextPath, java.lang.String servletPath)
Minimal constructor that makes sense.

Constructors
Constructor and Description
`MockHttpServletRequest(java.lang.String contextPath, java.lang.String servletPath)` Minimal constructor that makes sense.

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`addHeader(java.lang.String name, java.lang.Object value)` Allows headers to be set on the request.
`void`	`addLocale(java.util.Locale locale)` Adds a Locale to the set of requested locales.
`java.lang.Object`	`getAttribute(java.lang.String key)` Gets the named request attribute from an internal Map.
`java.util.Enumeration<java.lang.String>`	`getAttributeNames()` Gets an enumeration of all request attribute names.
`java.lang.String`	`getAuthType()` Gets the auth type being used by this request.
`java.lang.String`	`getCharacterEncoding()` Gets the character encoding, defaults to UTF-8.
`int`	`getContentLength()` Always returns -1 (unknown).
`java.lang.String`	`getContentType()` Always returns null.
`java.lang.String`	`getContextPath()` Returns the context path.
`javax.servlet.http.Cookie[]`	`getCookies()` Returns any cookies that are set on the request.
`long`	`getDateHeader(java.lang.String name)` Gets the named header as a long.
`java.lang.String`	`getForwardUrl()` Gets the URL that was forwarded to, if a forward was processed.
`java.lang.String`	`getHeader(java.lang.String name)` Returns any header as a String if it exists.
`java.util.Enumeration<java.lang.String>`	`getHeaderNames()` Returns an enumeration containing all the names of headers supplied.
`java.util.Enumeration<java.lang.String>`	`getHeaders(java.lang.String name)` Returns an enumeration with single value of the named header, or an empty enum if no value.
`java.util.List<java.lang.String>`	`getIncludedUrls()` Gets the list (potentially empty) or URLs that were included during the request.
`javax.servlet.ServletInputStream`	`getInputStream()` Always returns null.
`int`	`getIntHeader(java.lang.String name)` Gets the named header as an int.
`java.lang.String`	`getLocalAddr()` Always returns 127.0.0.1).
`java.util.Locale`	`getLocale()` Returns the preferred locale.
`java.util.Enumeration<java.util.Locale>`	`getLocales()` Returns an enumeration of requested locales.
`java.lang.String`	`getLocalName()` Always returns the same value as getServerName().
`int`	`getLocalPort()` Always returns the same value as getServerPort().
`java.lang.String`	`getMethod()` Gets the method used by the request.
`java.lang.String`	`getParameter(java.lang.String name)` Gets the first value of the named parameter or null if a value does not exist.
`java.util.Map<java.lang.String,java.lang.String[]>`	`getParameterMap()` Provides access to the parameter map.
`java.util.Enumeration<java.lang.String>`	`getParameterNames()` Gets an enumeration containing all the parameter names present.
`java.lang.String[]`	`getParameterValues(java.lang.String name)` Returns an array of all values for a parameter, or null if the parameter does not exist.
`java.lang.String`	`getPathInfo()` Returns the path info.
`java.lang.String`	`getPathTranslated()` Always returns the same as getPathInfo().
`java.lang.String`	`getProtocol()` Gets the protocol for the request.
`java.lang.String`	`getQueryString()` Returns the query string set on the request.
`java.io.BufferedReader`	`getReader()` Always returns null.
`java.lang.String`	`getRealPath(java.lang.String path)` Always returns the path passed in without any alteration.
`java.lang.String`	`getRemoteAddr()` Aways returns "127.0.0.1".
`java.lang.String`	`getRemoteHost()` Always returns "localhost".
`int`	`getRemotePort()` Always returns 1088 (and yes, that was picked arbitrarily).
`java.lang.String`	`getRemoteUser()` Returns the name from the user principal if one exists, otherwise null.
`MockRequestDispatcher`	`getRequestDispatcher(java.lang.String url)` Returns an instance of MockRequestDispatcher that just records what URLs are forwarded to or included.
`java.lang.String`	`getRequestedSessionId()` Returns the ID of the session if one is attached to this request.
`java.lang.String`	`getRequestURI()` Returns the request URI as defined by the servlet spec.
`java.lang.StringBuffer`	`getRequestURL()` Returns (an attempt at) a reconstructed URL based on it's constituent parts.
`java.lang.String`	`getScheme()` Always returns the same as getProtocol.
`java.lang.String`	`getServerName()` Gets the server name.
`int`	`getServerPort()` Returns the server port.
`java.lang.String`	`getServletPath()` Gets the part of the path which matched the servlet.
`javax.servlet.http.HttpSession`	`getSession()` Gets the session object attached to this request.
`javax.servlet.http.HttpSession`	`getSession(boolean b)` Gets the session object attached to this request.
`java.security.Principal`	`getUserPrincipal()` Returns the Principal if one is set on the request.
`boolean`	`isRequestedSessionIdFromCookie()` Always returns true.
`boolean`	`isRequestedSessionIdFromUrl()` Always returns false.
`boolean`	`isRequestedSessionIdFromURL()` Always returns false.
`boolean`	`isRequestedSessionIdValid()` Always returns true.
`boolean`	`isSecure()` Returns true if the protocol is set to https (default), false otherwise.
`boolean`	`isUserInRole(java.lang.String role)` Returns true if the set of roles contains the role specified, false otherwise.
`void`	`removeAttribute(java.lang.String name)` Removes any value for the named request attribute.
`void`	`setAttribute(java.lang.String name, java.lang.Object value)` Sets the supplied value for the named request attribute.
`void`	`setAuthType(java.lang.String authType)` Sets the auth type that will be reported by this request.
`void`	`setCharacterEncoding(java.lang.String encoding)` Sets the character encoding that will be returned by getCharacterEncoding().
`void`	`setContextPath(java.lang.String contextPath)` Sets the context path.
`void`	`setCookies(javax.servlet.http.Cookie[] cookies)` Sets the array of cookies that will be available from the request.
`void`	`setMethod(java.lang.String method)` Sets the method used by the request.
`void`	`setPathInfo(java.lang.String pathInfo)` Sets the path info.
`void`	`setProtocol(java.lang.String protocol)` Sets the protocol for the request.
`void`	`setQueryString(java.lang.String queryString)` Sets the query string set on the request; this value is not parsed for anything.
`void`	`setRoles(java.util.Set<java.lang.String> roles)` Sets the set of roles that the user is deemed to be in for the request.
`void`	`setServerName(java.lang.String serverName)` Sets the server name.
`void`	`setServerPort(int serverPort)` Sets the server port.
`void`	`setSession(javax.servlet.http.HttpSession session)` Allows a session to be associated with the request.
`void`	`setUserPrincipal(java.security.Principal userPrincipal)` Sets the Principal for the current request.

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

- Constructor Detail
  - MockHttpServletRequest
```
public MockHttpServletRequest(java.lang.String contextPath,
                      java.lang.String servletPath)
```
    Minimal constructor that makes sense. Requires a context path (should be the same as the name of the servlet context, prepended with a '/') and a servlet path. E.g. new MockHttpServletRequest("/myapp", "/actionType/foo.action").
    
    Parameters:
    contextPath -
    servletPath -
- Method Detail
  - setAuthType
```
public void setAuthType(java.lang.String authType)
```
    Sets the auth type that will be reported by this request.
  - getAuthType
```
public java.lang.String getAuthType()
```
    Gets the auth type being used by this request.
    
    Specified by:
    
    getAuthType in interface javax.servlet.http.HttpServletRequest
  - setCookies
```
public void setCookies(javax.servlet.http.Cookie[] cookies)
```
    Sets the array of cookies that will be available from the request.
  - getCookies
```
public javax.servlet.http.Cookie[] getCookies()
```
    Returns any cookies that are set on the request.
    
    Specified by:
    
    getCookies in interface javax.servlet.http.HttpServletRequest
  - addHeader
```
public void addHeader(java.lang.String name,
             java.lang.Object value)
```
    Allows headers to be set on the request. These will be returned by the various getXxHeader() methods. If the header is a date header it should be set with a Long. If the header is an Int header it should be set with an Integer.
  - getDateHeader
```
public long getDateHeader(java.lang.String name)
```
    Gets the named header as a long. Must have been set as a long with addHeader().
    
    Specified by:
    
    getDateHeader in interface javax.servlet.http.HttpServletRequest
  - getHeader
```
public java.lang.String getHeader(java.lang.String name)
```
    Returns any header as a String if it exists.
    
    Specified by:
    
    getHeader in interface javax.servlet.http.HttpServletRequest
  - getHeaders
```
public java.util.Enumeration<java.lang.String> getHeaders(java.lang.String name)
```
    Returns an enumeration with single value of the named header, or an empty enum if no value.
    
    Specified by:
    
    getHeaders in interface javax.servlet.http.HttpServletRequest
  - getHeaderNames
```
public java.util.Enumeration<java.lang.String> getHeaderNames()
```
    Returns an enumeration containing all the names of headers supplied.
    
    Specified by:
    
    getHeaderNames in interface javax.servlet.http.HttpServletRequest
  - getIntHeader
```
public int getIntHeader(java.lang.String name)
```
    Gets the named header as an int. Must have been set as an Integer with addHeader().
    
    Specified by:
    
    getIntHeader in interface javax.servlet.http.HttpServletRequest
  - setMethod
```
public void setMethod(java.lang.String method)
```
    Sets the method used by the request. Defaults to POST.
  - getMethod
```
public java.lang.String getMethod()
```
    Gets the method used by the request. Defaults to POST.
    
    Specified by:
    
    getMethod in interface javax.servlet.http.HttpServletRequest
  - setPathInfo
```
public void setPathInfo(java.lang.String pathInfo)
```
    Sets the path info. Defaults to the empty string.
  - getPathInfo
```
public java.lang.String getPathInfo()
```
    Returns the path info. Defaults to the empty string.
    
    Specified by:
    
    getPathInfo in interface javax.servlet.http.HttpServletRequest
  - getPathTranslated
```
public java.lang.String getPathTranslated()
```
    Always returns the same as getPathInfo().
    
    Specified by:
    
    getPathTranslated in interface javax.servlet.http.HttpServletRequest
  - setContextPath
```
public void setContextPath(java.lang.String contextPath)
```
    Sets the context path. Defaults to the empty string.
  - getContextPath
```
public java.lang.String getContextPath()
```
    Returns the context path. Defaults to the empty string.
    
    Specified by:
    
    getContextPath in interface javax.servlet.http.HttpServletRequest
  - setQueryString
```
public void setQueryString(java.lang.String queryString)
```
    Sets the query string set on the request; this value is not parsed for anything.
  - getQueryString
```
public java.lang.String getQueryString()
```
    Returns the query string set on the request.
    
    Specified by:
    
    getQueryString in interface javax.servlet.http.HttpServletRequest
  - getRemoteUser
```
public java.lang.String getRemoteUser()
```
    Returns the name from the user principal if one exists, otherwise null.
    
    Specified by:
    
    getRemoteUser in interface javax.servlet.http.HttpServletRequest
  - setRoles
```
public void setRoles(java.util.Set<java.lang.String> roles)
```
    Sets the set of roles that the user is deemed to be in for the request.
  - isUserInRole
```
public boolean isUserInRole(java.lang.String role)
```
    Returns true if the set of roles contains the role specified, false otherwise.
    
    Specified by:
    
    isUserInRole in interface javax.servlet.http.HttpServletRequest
  - setUserPrincipal
```
public void setUserPrincipal(java.security.Principal userPrincipal)
```
    Sets the Principal for the current request.
  - getUserPrincipal
```
public java.security.Principal getUserPrincipal()
```
    Returns the Principal if one is set on the request.
    
    Specified by:
    
    getUserPrincipal in interface javax.servlet.http.HttpServletRequest
  - getRequestedSessionId
```
public java.lang.String getRequestedSessionId()
```
    Returns the ID of the session if one is attached to this request. Otherwise null.
    
    Specified by:
    
    getRequestedSessionId in interface javax.servlet.http.HttpServletRequest
  - getRequestURI
```
public java.lang.String getRequestURI()
```
    Returns the request URI as defined by the servlet spec.
    
    Specified by:
    
    getRequestURI in interface javax.servlet.http.HttpServletRequest
  - getRequestURL
```
public java.lang.StringBuffer getRequestURL()
```
    Returns (an attempt at) a reconstructed URL based on it's constituent parts.
    
    Specified by:
    
    getRequestURL in interface javax.servlet.http.HttpServletRequest
  - getServletPath
```
public java.lang.String getServletPath()
```
    Gets the part of the path which matched the servlet.
    
    Specified by:
    
    getServletPath in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession(boolean b)
```
    Gets the session object attached to this request.
    
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - getSession
```
public javax.servlet.http.HttpSession getSession()
```
    Gets the session object attached to this request.
    
    Specified by:
    
    getSession in interface javax.servlet.http.HttpServletRequest
  - setSession
```
public void setSession(javax.servlet.http.HttpSession session)
```
    Allows a session to be associated with the request.
  - isRequestedSessionIdValid
```
public boolean isRequestedSessionIdValid()
```
    Always returns true.
    
    Specified by:
    
    isRequestedSessionIdValid in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromCookie
```
public boolean isRequestedSessionIdFromCookie()
```
    Always returns true.
    
    Specified by:
    
    isRequestedSessionIdFromCookie in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromURL
```
public boolean isRequestedSessionIdFromURL()
```
    Always returns false.
    
    Specified by:
    
    isRequestedSessionIdFromURL in interface javax.servlet.http.HttpServletRequest
  - isRequestedSessionIdFromUrl
```
public boolean isRequestedSessionIdFromUrl()
```
    Always returns false.
    
    Specified by:
    
    isRequestedSessionIdFromUrl in interface javax.servlet.http.HttpServletRequest
  - getAttribute
```
public java.lang.Object getAttribute(java.lang.String key)
```
    Gets the named request attribute from an internal Map.
    
    Specified by:
    
    getAttribute in interface javax.servlet.ServletRequest
  - getAttributeNames
```
public java.util.Enumeration<java.lang.String> getAttributeNames()
```
    Gets an enumeration of all request attribute names.
    
    Specified by:
    
    getAttributeNames in interface javax.servlet.ServletRequest
  - getCharacterEncoding
```
public java.lang.String getCharacterEncoding()
```
    Gets the character encoding, defaults to UTF-8.
    
    Specified by:
    
    getCharacterEncoding in interface javax.servlet.ServletRequest
  - setCharacterEncoding
```
public void setCharacterEncoding(java.lang.String encoding)
```
    Sets the character encoding that will be returned by getCharacterEncoding().
    
    Specified by:
    
    setCharacterEncoding in interface javax.servlet.ServletRequest
  - getContentLength
```
public int getContentLength()
```
    Always returns -1 (unknown).
    
    Specified by:
    
    getContentLength in interface javax.servlet.ServletRequest
  - getContentType
```
public java.lang.String getContentType()
```
    Always returns null.
    
    Specified by:
    
    getContentType in interface javax.servlet.ServletRequest
  - getInputStream
```
public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException
```
    Always returns null.
    
    Specified by:
    
    getInputStream in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.io.IOException
  - getParameter
```
public java.lang.String getParameter(java.lang.String name)
```
    Gets the first value of the named parameter or null if a value does not exist.
    
    Specified by:
    
    getParameter in interface javax.servlet.ServletRequest
  - getParameterNames
```
public java.util.Enumeration<java.lang.String> getParameterNames()
```
    Gets an enumeration containing all the parameter names present.
    
    Specified by:
    
    getParameterNames in interface javax.servlet.ServletRequest
  - getParameterValues
```
public java.lang.String[] getParameterValues(java.lang.String name)
```
    Returns an array of all values for a parameter, or null if the parameter does not exist.
    
    Specified by:
    
    getParameterValues in interface javax.servlet.ServletRequest
  - getParameterMap
```
public java.util.Map<java.lang.String,java.lang.String[]> getParameterMap()
```
    Provides access to the parameter map. Note that this returns a reference to the live, modifiable parameter map. As a result it can be used to insert parameters when constructing the request.
    
    Specified by:
    
    getParameterMap in interface javax.servlet.ServletRequest
  - setProtocol
```
public void setProtocol(java.lang.String protocol)
```
    Sets the protocol for the request. Defaults to "https".
  - getProtocol
```
public java.lang.String getProtocol()
```
    Gets the protocol for the request. Defaults to "https".
    
    Specified by:
    
    getProtocol in interface javax.servlet.ServletRequest
  - getScheme
```
public java.lang.String getScheme()
```
    Always returns the same as getProtocol.
    
    Specified by:
    
    getScheme in interface javax.servlet.ServletRequest
  - setServerName
```
public void setServerName(java.lang.String serverName)
```
    Sets the server name. Defaults to "localhost".
  - getServerName
```
public java.lang.String getServerName()
```
    Gets the server name. Defaults to "localhost".
    
    Specified by:
    
    getServerName in interface javax.servlet.ServletRequest
  - setServerPort
```
public void setServerPort(int serverPort)
```
    Sets the server port. Defaults to 8080.
  - getServerPort
```
public int getServerPort()
```
    Returns the server port. Defaults to 8080.
    
    Specified by:
    
    getServerPort in interface javax.servlet.ServletRequest
  - getReader
```
public java.io.BufferedReader getReader()
                                 throws java.io.IOException
```
    Always returns null.
    
    Specified by:
    
    getReader in interface javax.servlet.ServletRequest
    
    Throws:
    
    java.io.IOException
  - getRemoteAddr
```
public java.lang.String getRemoteAddr()
```
    Aways returns "127.0.0.1".
    
    Specified by:
    
    getRemoteAddr in interface javax.servlet.ServletRequest
  - getRemoteHost
```
public java.lang.String getRemoteHost()
```
    Always returns "localhost".
    
    Specified by:
    
    getRemoteHost in interface javax.servlet.ServletRequest
  - setAttribute
```
public void setAttribute(java.lang.String name,
                java.lang.Object value)
```
    Sets the supplied value for the named request attribute.
    
    Specified by:
    
    setAttribute in interface javax.servlet.ServletRequest
  - removeAttribute
```
public void removeAttribute(java.lang.String name)
```
    Removes any value for the named request attribute.
    
    Specified by:
    
    removeAttribute in interface javax.servlet.ServletRequest
  - addLocale
```
public void addLocale(java.util.Locale locale)
```
    Adds a Locale to the set of requested locales.
  - getLocale
```
public java.util.Locale getLocale()
```
    Returns the preferred locale. Defaults to the system locale.
    
    Specified by:
    
    getLocale in interface javax.servlet.ServletRequest
  - getLocales
```
public java.util.Enumeration<java.util.Locale> getLocales()
```
    Returns an enumeration of requested locales. Defaults to the system locale.
    
    Specified by:
    
    getLocales in interface javax.servlet.ServletRequest
  - isSecure
```
public boolean isSecure()
```
    Returns true if the protocol is set to https (default), false otherwise.
    
    Specified by:
    
    isSecure in interface javax.servlet.ServletRequest
  - getRequestDispatcher
```
public MockRequestDispatcher getRequestDispatcher(java.lang.String url)
```
    Returns an instance of MockRequestDispatcher that just records what URLs are forwarded to or included. The results can be examined later by calling getForwardUrl() and getIncludedUrls().
    
    Specified by:
    
    getRequestDispatcher in interface javax.servlet.ServletRequest
  - getRealPath
```
public java.lang.String getRealPath(java.lang.String path)
```
    Always returns the path passed in without any alteration.
    
    Specified by:
    
    getRealPath in interface javax.servlet.ServletRequest
  - getRemotePort
```
public int getRemotePort()
```
    Always returns 1088 (and yes, that was picked arbitrarily).
    
    Specified by:
    
    getRemotePort in interface javax.servlet.ServletRequest
  - getLocalName
```
public java.lang.String getLocalName()
```
    Always returns the same value as getServerName().
    
    Specified by:
    
    getLocalName in interface javax.servlet.ServletRequest
  - getLocalAddr
```
public java.lang.String getLocalAddr()
```
    Always returns 127.0.0.1).
    
    Specified by:
    
    getLocalAddr in interface javax.servlet.ServletRequest
  - getLocalPort
```
public int getLocalPort()
```
    Always returns the same value as getServerPort().
    
    Specified by:
    
    getLocalPort in interface javax.servlet.ServletRequest
  - getForwardUrl
```
public java.lang.String getForwardUrl()
```
    Gets the URL that was forwarded to, if a forward was processed. Null otherwise.
  - getIncludedUrls
```
public java.util.List<java.lang.String> getIncludedUrls()
```
    Gets the list (potentially empty) or URLs that were included during the request.

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

setAuthType

getAuthType

setCookies

getCookies

addHeader

getDateHeader

getHeader

getHeaders

getHeaderNames

getIntHeader

setMethod

getMethod

setPathInfo

getPathInfo

getPathTranslated

setContextPath

getContextPath

setQueryString

getQueryString

getRemoteUser

setRoles

isUserInRole

setUserPrincipal

getUserPrincipal

getRequestedSessionId

getRequestURI

getRequestURL

getServletPath

getSession

getSession

setSession

isRequestedSessionIdValid

isRequestedSessionIdFromCookie

isRequestedSessionIdFromURL

isRequestedSessionIdFromUrl

getAttribute

getAttributeNames

getCharacterEncoding

setCharacterEncoding

getContentLength

getContentType

getInputStream

getParameter

getParameterNames

getParameterValues

getParameterMap

setProtocol

getProtocol

getScheme

setServerName

getServerName

setServerPort

getServerPort

getReader

getRemoteAddr

getRemoteHost

setAttribute

removeAttribute

addLocale

getLocale

getLocales

isSecure

getRequestDispatcher

getRealPath

getRemotePort

getLocalName

getLocalAddr

getLocalPort

getForwardUrl

getIncludedUrls