com.mockrunner.mock.web
Class MockHttpServletRequest

java.lang.Object
  com.mockrunner.mock.web.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 HttpServletRequest.

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

MockHttpServletRequest()

Method Summary

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

Specified by:

getParameter in interface javax.servlet.ServletRequest

clearParameters

public void clearParameters()

Clears the parameters.

getParameterValues

public java.lang.String[] getParameterValues(java.lang.String key)

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

setupAddParameter

public void setupAddParameter(java.lang.String key,
                              java.lang.String[] values)

Adds a request multivalue parameter.

Parameters:

key - the parameter key

values - the parameters values

setupAddParameter

public void setupAddParameter(java.lang.String key,
                              java.lang.String value)

Adds a request parameter.

Parameters:

key - the parameter key

value - the parameters value

getParameterNames

public java.util.Enumeration getParameterNames()

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

getParameterMap

public java.util.Map getParameterMap()

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

clearAttributes

public void clearAttributes()

getAttribute

public java.lang.Object getAttribute(java.lang.String key)

Specified by:

getAttribute in interface javax.servlet.ServletRequest

getAttributeNames

public java.util.Enumeration getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.ServletRequest

removeAttribute

public void removeAttribute(java.lang.String key)

Specified by:

removeAttribute in interface javax.servlet.ServletRequest

setAttribute

public void setAttribute(java.lang.String key,
                         java.lang.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(java.lang.String path)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletRequest

getRequestDispatcherMap

public java.util.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(java.lang.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 java.util.Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletRequest

getLocales

public java.util.Enumeration getLocales()

Specified by:

getLocales in interface javax.servlet.ServletRequest

addLocale

public void addLocale(java.util.Locale locale)

addLocales

public void addLocales(java.util.List localeList)

getMethod

public java.lang.String getMethod()

Specified by:

getMethod in interface javax.servlet.http.HttpServletRequest

setMethod

public void setMethod(java.lang.String method)

getAuthType

public java.lang.String getAuthType()

Specified by:

getAuthType in interface javax.servlet.http.HttpServletRequest

setAuthType

public void setAuthType(java.lang.String authType)

getDateHeader

public long getDateHeader(java.lang.String key)

Specified by:

getDateHeader in interface javax.servlet.http.HttpServletRequest

getHeader

public java.lang.String getHeader(java.lang.String key)

Specified by:

getHeader in interface javax.servlet.http.HttpServletRequest

getHeaderNames

public java.util.Enumeration getHeaderNames()

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletRequest

getHeaders

public java.util.Enumeration getHeaders(java.lang.String key)

Specified by:

getHeaders in interface javax.servlet.http.HttpServletRequest

getIntHeader

public int getIntHeader(java.lang.String key)

Specified by:

getIntHeader in interface javax.servlet.http.HttpServletRequest

addHeader

public void addHeader(java.lang.String key,
                      java.lang.String value)

setHeader

public void setHeader(java.lang.String key,
                      java.lang.String value)

clearHeaders

public void clearHeaders()

getContextPath

public java.lang.String getContextPath()

Specified by:

getContextPath in interface javax.servlet.http.HttpServletRequest

setContextPath

public void setContextPath(java.lang.String contextPath)

getPathInfo

public java.lang.String getPathInfo()

Specified by:

getPathInfo in interface javax.servlet.http.HttpServletRequest

setPathInfo

public void setPathInfo(java.lang.String pathInfo)

getPathTranslated

public java.lang.String getPathTranslated()

Specified by:

getPathTranslated in interface javax.servlet.http.HttpServletRequest

setPathTranslated

public void setPathTranslated(java.lang.String pathTranslated)

getQueryString

public java.lang.String getQueryString()

Specified by:

getQueryString in interface javax.servlet.http.HttpServletRequest

setQueryString

public void setQueryString(java.lang.String queryString)

getRequestURI

public java.lang.String getRequestURI()

Specified by:

getRequestURI in interface javax.servlet.http.HttpServletRequest

setRequestURI

public void setRequestURI(java.lang.String requestUri)

getRequestURL

public java.lang.StringBuffer getRequestURL()

Specified by:

getRequestURL in interface javax.servlet.http.HttpServletRequest

setRequestURL

public void setRequestURL(java.lang.String requestUrl)

getServletPath

public java.lang.String getServletPath()

Specified by:

getServletPath in interface javax.servlet.http.HttpServletRequest

setServletPath

public void setServletPath(java.lang.String servletPath)

getUserPrincipal

public java.security.Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface javax.servlet.http.HttpServletRequest

setUserPrincipal

public void setUserPrincipal(java.security.Principal principal)

getRemoteUser

public java.lang.String getRemoteUser()

Specified by:

getRemoteUser in interface javax.servlet.http.HttpServletRequest

setRemoteUser

public void setRemoteUser(java.lang.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 java.lang.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(java.lang.String role)

Specified by:

isUserInRole in interface javax.servlet.http.HttpServletRequest

setUserInRole

public void setUserInRole(java.lang.String role,
                          boolean isInRole)

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletRequest

setCharacterEncoding

public void setCharacterEncoding(java.lang.String characterEncoding)
                          throws java.io.UnsupportedEncodingException

Specified by:

setCharacterEncoding in interface javax.servlet.ServletRequest

Throws:

java.io.UnsupportedEncodingException

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface javax.servlet.ServletRequest

setContentLength

public void setContentLength(int contentLength)

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletRequest

setContentType

public void setContentType(java.lang.String contentType)

getProtocol

public java.lang.String getProtocol()

Specified by:

getProtocol in interface javax.servlet.ServletRequest

setProtocol

public void setProtocol(java.lang.String protocol)

getServerName

public java.lang.String getServerName()

Specified by:

getServerName in interface javax.servlet.ServletRequest

setServerName

public void setServerName(java.lang.String serverName)

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface javax.servlet.ServletRequest

setServerPort

public void setServerPort(int serverPort)

getScheme

public java.lang.String getScheme()

Specified by:

getScheme in interface javax.servlet.ServletRequest

setScheme

public void setScheme(java.lang.String scheme)

getRemoteAddr

public java.lang.String getRemoteAddr()

Specified by:

getRemoteAddr in interface javax.servlet.ServletRequest

setRemoteAddr

public void setRemoteAddr(java.lang.String remoteAddr)

getRemoteHost

public java.lang.String getRemoteHost()

Specified by:

getRemoteHost in interface javax.servlet.ServletRequest

setRemoteHost

public void setRemoteHost(java.lang.String remoteHost)

getReader

public java.io.BufferedReader getReader()
                                 throws java.io.IOException

Specified by:

getReader in interface javax.servlet.ServletRequest

Throws:

java.io.IOException

getInputStream

public javax.servlet.ServletInputStream getInputStream()
                                                throws java.io.IOException

Specified by:

getInputStream in interface javax.servlet.ServletRequest

Throws:

java.io.IOException

setBodyContent

public void setBodyContent(byte[] data)

setBodyContent

public void setBodyContent(java.lang.String bodyContent)

getRealPath

public java.lang.String getRealPath(java.lang.String path)

Specified by:

getRealPath in interface javax.servlet.ServletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.servlet.ServletRequest

getLocalAddr

public java.lang.String getLocalAddr()

Specified by:

getLocalAddr in interface javax.servlet.ServletRequest

setLocalAddr

public void setLocalAddr(java.lang.String localAddr)

getLocalName

public java.lang.String getLocalName()

Specified by:

getLocalName in interface javax.servlet.ServletRequest

setLocalName

public void setLocalName(java.lang.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)