org.apache.struts.mock
Class MockHttpServletRequest

java.lang.Object
  org.apache.struts.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 HttpServletRequest object for low-level unit tests of Struts controller components. Coarser grained tests should be implemented in terms of the Cactus framework, instead of the mock object classes.

WARNING - Only the minimal set of methods needed to create unit tests is provided, plus additional methods to configure this object as necessary. Methods for unsupported operations will throw UnsupportedOperationException.

WARNING - Because unit tests operate in a single threaded environment, no synchronization is performed.

Version:

$Rev: 471754 $ $Date: 2006-11-06 08:55:09 -0600 (Mon, 06 Nov 2006) $

Field Summary

protected java.util.HashMap	attributes The set of request attributes.
protected java.lang.String	contentType The Content Type for this request.
protected java.lang.String	contextPath The context path for this request.
protected java.util.Locale	locale The preferred locale for this request.
protected java.lang.String	method The HTTP request method.
protected java.util.HashMap	parameters The set of arrays of parameter values, keyed by parameter name.
protected java.lang.String	pathInfo The extra path information for this request.
protected java.security.Principal	principal The authenticated user for this request.
protected java.lang.String	queryString The query string for this request.
protected java.lang.String	servletPath The servlet path for this request.
protected javax.servlet.http.HttpSession	session The HttpSession with which we are associated.

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

MockHttpServletRequest()

MockHttpServletRequest(javax.servlet.http.HttpSession session)

MockHttpServletRequest(java.lang.String contextPath, java.lang.String servletPath, java.lang.String pathInfo, java.lang.String queryString)

MockHttpServletRequest(java.lang.String contextPath, java.lang.String servletPath, java.lang.String pathInfo, java.lang.String queryString, javax.servlet.http.HttpSession session)

Method Summary

void	addParameter(java.lang.String name, java.lang.String value)
java.lang.Object	getAttribute(java.lang.String name)
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 name)
java.lang.String	getHeader(java.lang.String name)
java.util.Enumeration	getHeaderNames()
java.util.Enumeration	getHeaders(java.lang.String name)
javax.servlet.ServletInputStream	getInputStream()
int	getIntHeader(java.lang.String name)
java.util.Locale	getLocale()
java.util.Enumeration	getLocales()
java.lang.String	getMethod()
java.lang.String	getParameter(java.lang.String name)
java.util.Map	getParameterMap()
java.util.Enumeration	getParameterNames()
java.lang.String[]	getParameterValues(java.lang.String name)
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()
java.lang.String	getRemoteUser()
javax.servlet.RequestDispatcher	getRequestDispatcher(java.lang.String path)
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 name)
void	setAttribute(java.lang.String name, java.lang.Object value)
void	setCharacterEncoding(java.lang.String name)
void	setContentType(java.lang.String contentType)
void	setHttpSession(javax.servlet.http.HttpSession session)
void	setLocale(java.util.Locale locale)
void	setMethod(java.lang.String method)
void	setPathElements(java.lang.String contextPath, java.lang.String servletPath, java.lang.String pathInfo, java.lang.String queryString)
void	setUserPrincipal(java.security.Principal principal)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

attributes

protected java.util.HashMap attributes

The set of request attributes.

contextPath

protected java.lang.String contextPath

The context path for this request.

locale

protected java.util.Locale locale

The preferred locale for this request.

parameters

protected java.util.HashMap parameters

The set of arrays of parameter values, keyed by parameter name.

pathInfo

protected java.lang.String pathInfo

The extra path information for this request. v *

principal

protected java.security.Principal principal

The authenticated user for this request.

queryString

protected java.lang.String queryString

The query string for this request.

servletPath

protected java.lang.String servletPath

The servlet path for this request.

session

protected javax.servlet.http.HttpSession session

The HttpSession with which we are associated.

method

protected java.lang.String method

The HTTP request method.

contentType

protected java.lang.String contentType

The Content Type for this request.

Constructor Detail

MockHttpServletRequest

public MockHttpServletRequest()

MockHttpServletRequest

public MockHttpServletRequest(javax.servlet.http.HttpSession session)

MockHttpServletRequest

public MockHttpServletRequest(java.lang.String contextPath,
                              java.lang.String servletPath,
                              java.lang.String pathInfo,
                              java.lang.String queryString)

MockHttpServletRequest

public MockHttpServletRequest(java.lang.String contextPath,
                              java.lang.String servletPath,
                              java.lang.String pathInfo,
                              java.lang.String queryString,
                              javax.servlet.http.HttpSession session)

Method Detail

addParameter

public void addParameter(java.lang.String name,
                         java.lang.String value)

setHttpSession

public void setHttpSession(javax.servlet.http.HttpSession session)

setLocale

public void setLocale(java.util.Locale locale)

setMethod

public void setMethod(java.lang.String method)

setContentType

public void setContentType(java.lang.String contentType)

setPathElements

public void setPathElements(java.lang.String contextPath,
                            java.lang.String servletPath,
                            java.lang.String pathInfo,
                            java.lang.String queryString)

setUserPrincipal

public void setUserPrincipal(java.security.Principal principal)

getAuthType

public java.lang.String getAuthType()

Specified by:

getAuthType in interface javax.servlet.http.HttpServletRequest

getContextPath

public java.lang.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(java.lang.String name)

Specified by:

getDateHeader in interface javax.servlet.http.HttpServletRequest

getHeader

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

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 name)

Specified by:

getHeaders in interface javax.servlet.http.HttpServletRequest

getIntHeader

public int getIntHeader(java.lang.String name)

Specified by:

getIntHeader in interface javax.servlet.http.HttpServletRequest

getMethod

public java.lang.String getMethod()

Specified by:

getMethod in interface javax.servlet.http.HttpServletRequest

getPathInfo

public java.lang.String getPathInfo()

Specified by:

getPathInfo in interface javax.servlet.http.HttpServletRequest

getPathTranslated

public java.lang.String getPathTranslated()

Specified by:

getPathTranslated in interface javax.servlet.http.HttpServletRequest

getQueryString

public java.lang.String getQueryString()

Specified by:

getQueryString in interface javax.servlet.http.HttpServletRequest

getRemoteUser

public java.lang.String getRemoteUser()

Specified by:

getRemoteUser in interface javax.servlet.http.HttpServletRequest

getRequestedSessionId

public java.lang.String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface javax.servlet.http.HttpServletRequest

getRequestURI

public java.lang.String getRequestURI()

Specified by:

getRequestURI in interface javax.servlet.http.HttpServletRequest

getRequestURL

public java.lang.StringBuffer getRequestURL()

Specified by:

getRequestURL in interface javax.servlet.http.HttpServletRequest

getServletPath

public java.lang.String getServletPath()

Specified by:

getServletPath in interface javax.servlet.http.HttpServletRequest

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 java.security.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(java.lang.String role)

Specified by:

isUserInRole in interface javax.servlet.http.HttpServletRequest

getAttribute

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

Specified by:

getAttribute in interface javax.servlet.ServletRequest

getAttributeNames

public java.util.Enumeration getAttributeNames()

Specified by:

getAttributeNames in interface javax.servlet.ServletRequest

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletRequest

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface javax.servlet.ServletRequest

getContentType

public java.lang.String getContentType()

Specified by:

getContentType in interface javax.servlet.ServletRequest

getInputStream

public javax.servlet.ServletInputStream getInputStream()

Specified by:

getInputStream in interface javax.servlet.ServletRequest

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

getParameter

public java.lang.String getParameter(java.lang.String name)

Specified by:

getParameter in interface javax.servlet.ServletRequest

getParameterMap

public java.util.Map getParameterMap()

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

getParameterNames

public java.util.Enumeration getParameterNames()

Specified by:

getParameterNames in interface javax.servlet.ServletRequest

getParameterValues

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

Specified by:

getParameterValues in interface javax.servlet.ServletRequest

getProtocol

public java.lang.String getProtocol()

Specified by:

getProtocol in interface javax.servlet.ServletRequest

getReader

public java.io.BufferedReader getReader()

Specified by:

getReader in interface javax.servlet.ServletRequest

getRealPath

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

Specified by:

getRealPath in interface javax.servlet.ServletRequest

getRemoteAddr

public java.lang.String getRemoteAddr()

Specified by:

getRemoteAddr in interface javax.servlet.ServletRequest

getRemoteHost

public java.lang.String getRemoteHost()

Specified by:

getRemoteHost in interface javax.servlet.ServletRequest

getRequestDispatcher

public javax.servlet.RequestDispatcher getRequestDispatcher(java.lang.String path)

Specified by:

getRequestDispatcher in interface javax.servlet.ServletRequest

getScheme

public java.lang.String getScheme()

Specified by:

getScheme in interface javax.servlet.ServletRequest

getServerName

public java.lang.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(java.lang.String name)

Specified by:

removeAttribute in interface javax.servlet.ServletRequest

setAttribute

public void setAttribute(java.lang.String name,
                         java.lang.Object value)

Specified by:

setAttribute in interface javax.servlet.ServletRequest

setCharacterEncoding

public void setCharacterEncoding(java.lang.String name)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletRequest