org.apache.shale.test.mock
Class MockHttpServletRequest

java.lang.Object
  org.apache.shale.test.mock.MockHttpServletRequest

All Implemented Interfaces:

HttpServletRequest, ServletRequest

public class MockHttpServletRequest
extends Object
implements HttpServletRequest

Mock implementation of HttpServletContext.

$Id$

Field Summary

Fields inherited from interface javax.servlet.http.HttpServletRequest

BASIC_AUTH, CLIENT_CERT_AUTH, DIGEST_AUTH, FORM_AUTH

Constructor Summary

MockHttpServletRequest()

MockHttpServletRequest(HttpSession session)

MockHttpServletRequest(String contextPath, String servletPath, String pathInfo, String queryString)

MockHttpServletRequest(String contextPath, String servletPath, String pathInfo, String queryString, HttpSession session)

Method Summary

void	addAttributeListener(ServletRequestAttributeListener listener) Add a new listener instance that should be notified about attribute changes.
void	addDateHeader(String name, long value) Add a date-valued header for this request.
void	addHeader(String name, String value) Add a String-valued header for this request.
void	addIntHeader(String name, int value) Add an integer-valued header for this request.
void	addParameter(String name, String value) Add a request parameter for this request.
Object	getAttribute(String name)
Enumeration	getAttributeNames()
String	getAuthType()
String	getCharacterEncoding()
int	getContentLength()
String	getContentType()
String	getContextPath()
Cookie[]	getCookies()
long	getDateHeader(String name)
String	getHeader(String name)
Enumeration	getHeaderNames()
Enumeration	getHeaders(String name)
ServletInputStream	getInputStream()
int	getIntHeader(String name)
String	getLocalAddr()
Locale	getLocale()
Enumeration	getLocales()
String	getLocalName()
int	getLocalPort()
String	getMethod()
String	getParameter(String name)
Map	getParameterMap()
Enumeration	getParameterNames()
String[]	getParameterValues(String name)
String	getPathInfo()
String	getPathTranslated()
String	getProtocol()
String	getQueryString()
BufferedReader	getReader()
String	getRealPath(String path)
String	getRemoteAddr()
String	getRemoteHost()
int	getRemotePort()
String	getRemoteUser()
RequestDispatcher	getRequestDispatcher(String path)
String	getRequestedSessionId()
String	getRequestURI()
StringBuffer	getRequestURL()
String	getScheme()
String	getServerName()
int	getServerPort()
ServletContext	getServletContext() Return the ServletContext associated with this request.
String	getServletPath()
HttpSession	getSession()
HttpSession	getSession(boolean create)
Principal	getUserPrincipal()
boolean	isRequestedSessionIdFromCookie()
boolean	isRequestedSessionIdFromUrl()
boolean	isRequestedSessionIdFromURL()
boolean	isRequestedSessionIdValid()
boolean	isSecure()
boolean	isUserInRole(String role)
void	removeAttribute(String name)
void	setAttribute(String name, Object value)
void	setCharacterEncoding(String name)
void	setHttpSession(HttpSession session) Set the HttpSession associated with this request.
void	setLocale(Locale locale) Set the Locale associated with this request.
void	setPathElements(String contextPath, String servletPath, String pathInfo, String queryString) Set the parsed path elements associated with this request.
void	setServletContext(ServletContext servletContext) Set the ServletContext associated with this request.
void	setUserPrincipal(Principal principal) Set the Principal associated with this request.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockHttpServletRequest

public MockHttpServletRequest()

MockHttpServletRequest

public MockHttpServletRequest(HttpSession session)

MockHttpServletRequest

public MockHttpServletRequest(String contextPath,
                              String servletPath,
                              String pathInfo,
                              String queryString)

MockHttpServletRequest

public MockHttpServletRequest(String contextPath,
                              String servletPath,
                              String pathInfo,
                              String queryString,
                              HttpSession session)

Method Detail

addAttributeListener

public void addAttributeListener(ServletRequestAttributeListener listener)

Add a new listener instance that should be notified about attribute changes.

Parameters:

listener - The new listener to register

addDateHeader

public void addDateHeader(String name,
                          long value)

Add a date-valued header for this request.

Parameters:

name - Header name

value - Header value

addHeader

public void addHeader(String name,
                      String value)

Add a String-valued header for this request.

Parameters:

name - Header name

value - Header value

addIntHeader

public void addIntHeader(String name,
                         int value)

Add an integer-valued header for this request.

Parameters:

name - Header name

value - Header value

addParameter

public void addParameter(String name,
                         String value)

Add a request parameter for this request.

Parameters:

name - Parameter name

value - Parameter value

getServletContext

public ServletContext getServletContext()

Return the ServletContext associated with this request.

setHttpSession

public void setHttpSession(HttpSession session)

Set the HttpSession associated with this request.

Parameters:

session - The new session

setLocale

public void setLocale(Locale locale)

Set the Locale associated with this request.

Parameters:

locale - The new locale

setPathElements

public void setPathElements(String contextPath,
                            String servletPath,
                            String pathInfo,
                            String queryString)

Set the parsed path elements associated with this request.

Parameters:

contextPath - The context path

servletPath - The servlet path

pathInfo - The extra path information

queryString - The query string

setServletContext

public void setServletContext(ServletContext servletContext)

Set the ServletContext associated with this request.

Parameters:

servletContext - The new servlet context

setUserPrincipal

public void setUserPrincipal(Principal principal)

Set the Principal associated with this request.

Parameters:

principal - The new Principal

getAuthType

public String getAuthType()

Specified by:

getAuthType in interface HttpServletRequest

getContextPath

public String getContextPath()

Specified by:

getContextPath in interface HttpServletRequest

getCookies

public Cookie[] getCookies()

Specified by:

getCookies in interface HttpServletRequest

getDateHeader

public long getDateHeader(String name)

Specified by:

getDateHeader in interface HttpServletRequest

getHeader

public String getHeader(String name)

Specified by:

getHeader in interface HttpServletRequest

getHeaderNames

public Enumeration getHeaderNames()

Specified by:

getHeaderNames in interface HttpServletRequest

getHeaders

public Enumeration getHeaders(String name)

Specified by:

getHeaders in interface HttpServletRequest

getIntHeader

public int getIntHeader(String name)

Specified by:

getIntHeader in interface HttpServletRequest

getMethod

public String getMethod()

Specified by:

getMethod in interface HttpServletRequest

getPathInfo

public String getPathInfo()

Specified by:

getPathInfo in interface HttpServletRequest

getPathTranslated

public String getPathTranslated()

Specified by:

getPathTranslated in interface HttpServletRequest

getQueryString

public String getQueryString()

Specified by:

getQueryString in interface HttpServletRequest

getRemoteUser

public String getRemoteUser()

Specified by:

getRemoteUser in interface HttpServletRequest

getRequestedSessionId

public String getRequestedSessionId()

Specified by:

getRequestedSessionId in interface HttpServletRequest

getRequestURI

public String getRequestURI()

Specified by:

getRequestURI in interface HttpServletRequest

getRequestURL

public StringBuffer getRequestURL()

Specified by:

getRequestURL in interface HttpServletRequest

getServletPath

public String getServletPath()

Specified by:

getServletPath in interface HttpServletRequest

getSession

public HttpSession getSession()

Specified by:

getSession in interface HttpServletRequest

getSession

public HttpSession getSession(boolean create)

Specified by:

getSession in interface HttpServletRequest

getUserPrincipal

public Principal getUserPrincipal()

Specified by:

getUserPrincipal in interface HttpServletRequest

isRequestedSessionIdFromCookie

public boolean isRequestedSessionIdFromCookie()

Specified by:

isRequestedSessionIdFromCookie in interface HttpServletRequest

isRequestedSessionIdFromUrl

public boolean isRequestedSessionIdFromUrl()

Specified by:

isRequestedSessionIdFromUrl in interface HttpServletRequest

isRequestedSessionIdFromURL

public boolean isRequestedSessionIdFromURL()

Specified by:

isRequestedSessionIdFromURL in interface HttpServletRequest

isRequestedSessionIdValid

public boolean isRequestedSessionIdValid()

Specified by:

isRequestedSessionIdValid in interface HttpServletRequest

isUserInRole

public boolean isUserInRole(String role)

Specified by:

isUserInRole in interface HttpServletRequest

getAttribute

public Object getAttribute(String name)

Specified by:

getAttribute in interface ServletRequest

getAttributeNames

public Enumeration getAttributeNames()

Specified by:

getAttributeNames in interface ServletRequest

getCharacterEncoding

public String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface ServletRequest

getContentLength

public int getContentLength()

Specified by:

getContentLength in interface ServletRequest

getContentType

public String getContentType()

Specified by:

getContentType in interface ServletRequest

getInputStream

public ServletInputStream getInputStream()

Specified by:

getInputStream in interface ServletRequest

getLocale

public Locale getLocale()

Specified by:

getLocale in interface ServletRequest

getLocales

public Enumeration getLocales()

Specified by:

getLocales in interface ServletRequest

getLocalAddr

public String getLocalAddr()

Specified by:

getLocalAddr in interface ServletRequest

getLocalName

public String getLocalName()

Specified by:

getLocalName in interface ServletRequest

getLocalPort

public int getLocalPort()

Specified by:

getLocalPort in interface ServletRequest

getParameter

public String getParameter(String name)

Specified by:

getParameter in interface ServletRequest

getParameterMap

public Map getParameterMap()

Specified by:

getParameterMap in interface ServletRequest

getParameterNames

public Enumeration getParameterNames()

Specified by:

getParameterNames in interface ServletRequest

getParameterValues

public String[] getParameterValues(String name)

Specified by:

getParameterValues in interface ServletRequest

getProtocol

public String getProtocol()

Specified by:

getProtocol in interface ServletRequest

getReader

public BufferedReader getReader()

Specified by:

getReader in interface ServletRequest

getRealPath

public String getRealPath(String path)

Specified by:

getRealPath in interface ServletRequest

getRemoteAddr

public String getRemoteAddr()

Specified by:

getRemoteAddr in interface ServletRequest

getRemoteHost

public String getRemoteHost()

Specified by:

getRemoteHost in interface ServletRequest

getRemotePort

public int getRemotePort()

Specified by:

getRemotePort in interface ServletRequest

getRequestDispatcher

public RequestDispatcher getRequestDispatcher(String path)

Specified by:

getRequestDispatcher in interface ServletRequest

getScheme

public String getScheme()

Specified by:

getScheme in interface ServletRequest

getServerName

public String getServerName()

Specified by:

getServerName in interface ServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface ServletRequest

isSecure

public boolean isSecure()

Specified by:

isSecure in interface ServletRequest

removeAttribute

public void removeAttribute(String name)

Specified by:

removeAttribute in interface ServletRequest

setAttribute

public void setAttribute(String name,
                         Object value)

Specified by:

setAttribute in interface ServletRequest

setCharacterEncoding

public void setCharacterEncoding(String name)

Specified by:

setCharacterEncoding in interface ServletRequest