com.redhat.rhn.testing

Class RhnMockHttpServletRequest

java.lang.Object

com.mockobjects.MockObject

com.mockobjects.servlet.MockHttpServletRequest

com.redhat.rhn.testing.RhnMockHttpServletRequest

All Implemented Interfaces:

com.mockobjects.Verifiable, javax.servlet.http.HttpServletRequest, javax.servlet.ServletRequest

public class RhnMockHttpServletRequest
extends com.mockobjects.servlet.MockHttpServletRequest

RhnMockHttpServletRequest is a mock implementation of the HttpServletRequest which fixes deficiencies in the MockObjects' implementation of MockHttpServletRequest.

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
RhnMockHttpServletRequest() default constructor

Method Summary

Modifier and Type	Method and Description
void	addAttribute(java.lang.String name, java.lang.Object value) Adds a new attribute the Request.
void	addCookie(javax.servlet.http.Cookie cookie) Allows you to add a Cookie to the request to simulate receiving a cookie from the browser.
java.lang.Object	getAttribute(java.lang.String name) Returns the attribute bound to the given name.
java.lang.String	getCharacterEncoding()
javax.servlet.http.Cookie[]	getCookies()
java.lang.String	getHeader(java.lang.String name)
java.util.Enumeration	getHeaderNames()
java.util.Locale	getLocale()
java.util.Enumeration	getLocales()
java.lang.String	getMethod()
java.lang.String	getParameter(java.lang.String paramName) Override to return 'null' if the requested param doesn't exist (Mock throws an AssertionError in this case :(
java.util.Map	getParameterMap()
java.lang.String	getRemoteUser()
java.lang.StringBuffer	getRequestURL() Overrides the MockHttpServletRequest to actually return a value.
int	getServerPort()
boolean	isSecure()
void	setAttribute(java.lang.String name, java.lang.Object value) Sets an attribute the Request.
void	setCharacterEncoding(java.lang.String encodingIn)
void	setLocale(java.util.Locale lcl) Set the primary locale of this Request.
void	setLocales(java.util.List lcls) Set the list of Locales.
void	setMethod(java.lang.String methodIn)
void	setRequestURL(java.lang.String pathIn) Added the ability to specify a context path for testing.
void	setupGetHeader(java.lang.String headerName, java.lang.String value) Add a GET header to the request.
void	setupGetHeaderNames(java.util.Enumeration headerNamesIn) Header Names
void	setupGetParameterMap(java.util.Map map)
void	setupGetServerPort(int p) Sets the server port for this request.
void	setupIsSecure(boolean s) Configures whether this request is secure.

Methods inherited from class com.mockobjects.servlet.MockHttpServletRequest

addExpectedGetAttributeName, addExpectedSetAttribute, getAttributeNames, getAuthType, getContentLength, getContentType, getContextPath, getDateHeader, getHeaders, getInputStream, getIntHeader, getParameterNames, getParameterValues, getPathInfo, getPathTranslated, getProtocol, getQueryString, getReader, getRealPath, getRemoteAddr, getRemoteHost, getRequestDispatcher, getRequestedSessionId, getRequestURI, getScheme, getServerName, getServletPath, getSession, getSession, getUserPrincipal, isRequestedSessionIdFromCookie, isRequestedSessionIdFromUrl, isRequestedSessionIdFromURL, isRequestedSessionIdValid, isUserInRole, removeAttribute, setContentType, setExpectedContentType, setExpectedCreateSession, setExpectedRequestDispatcherURI, setSession, setupAddHeader, setupAddParameter, setupAddParameter, setupGetAttribute, setupGetAttrubuteNames, setupGetContentType, setupGetContextPath, setupGetInputStream, setupGetMethod, setupGetParameterNames, setupGetProtocol, setupGetReader, setupGetRemoteAddr, setupGetRequestDispatcher, setupGetRequestURI, setupGetServletPath, setupGetUserPrincipal, setupPathInfo, setupQueryString, setupRemoveAttribute, setupScheme, setupServerName

Methods inherited from class com.mockobjects.MockObject

assertEquals, assertEquals, assertTrue, fail, notImplemented, notYetImplemented, notYetImplemented, verify

Methods inherited from class java.lang.Object

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

Methods inherited from interface javax.servlet.http.HttpServletRequest

authenticate, getPart, getParts, login, logout

Methods inherited from interface javax.servlet.ServletRequest

getAsyncContext, getDispatcherType, getLocalAddr, getLocalName, getLocalPort, getRemotePort, getServletContext, isAsyncStarted, isAsyncSupported, startAsync, startAsync

Constructor Detail

RhnMockHttpServletRequest

public RhnMockHttpServletRequest()

default constructor

Method Detail

getRequestURL

public java.lang.StringBuffer getRequestURL()

Overrides the MockHttpServletRequest to actually return a value. The Mock version returns null

Specified by:

getRequestURL in interface javax.servlet.http.HttpServletRequest

Overrides:

getRequestURL in class com.mockobjects.servlet.MockHttpServletRequest

Returns:

StringBuffer Context Path

setRequestURL

public void setRequestURL(java.lang.String pathIn)

Added the ability to specify a context path for testing.

Parameters:

pathIn - Request url path.

getAttribute

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

Returns the attribute bound to the given name.

Specified by:

getAttribute in interface javax.servlet.ServletRequest

Overrides:

getAttribute in class com.mockobjects.servlet.MockHttpServletRequest

Parameters:

name - Name of attribute whose value is sought.

Returns:

Object value of attribute with given name.

addAttribute

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

Adds a new attribute the Request.

Parameters:

name - attribute name

value - attribute value

setAttribute

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

Sets an attribute the Request.

Specified by:

setAttribute in interface javax.servlet.ServletRequest

Overrides:

setAttribute in class com.mockobjects.servlet.MockHttpServletRequest

Parameters:

name - attribute name

value - attribute value

getHeader

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

Specified by:

getHeader in interface javax.servlet.http.HttpServletRequest

Overrides:

getHeader in class com.mockobjects.servlet.MockHttpServletRequest

getHeaderNames

public java.util.Enumeration getHeaderNames()

Specified by:

getHeaderNames in interface javax.servlet.http.HttpServletRequest

Overrides:

getHeaderNames in class com.mockobjects.servlet.MockHttpServletRequest

setupGetHeaderNames

public void setupGetHeaderNames(java.util.Enumeration headerNamesIn)

Header Names

Parameters:

headerNamesIn - attribute headerNames

getParameter

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

Override to return 'null' if the requested param doesn't exist (Mock throws an AssertionError in this case :(

Specified by:

getParameter in interface javax.servlet.ServletRequest

Overrides:

getParameter in class com.mockobjects.servlet.MockHttpServletRequest

Parameters:

paramName - name of param to look up

Returns:

value of paramName, or 'null' if paramName isn't in the request

getParameterMap

public java.util.Map getParameterMap()

Specified by:

getParameterMap in interface javax.servlet.ServletRequest

Overrides:

getParameterMap in class com.mockobjects.servlet.MockHttpServletRequest

setupGetParameterMap

public void setupGetParameterMap(java.util.Map map)

Overrides:

setupGetParameterMap in class com.mockobjects.servlet.MockHttpServletRequest

getLocale

public java.util.Locale getLocale()

Specified by:

getLocale in interface javax.servlet.ServletRequest

Overrides:

getLocale in class com.mockobjects.servlet.MockHttpServletRequest

setLocale

public void setLocale(java.util.Locale lcl)

Set the primary locale of this Request.

Parameters:

lcl - The primary Local of this Request.

setLocales

public void setLocales(java.util.List lcls)

Set the list of Locales.

Parameters:

lcls - List of Locales.

getLocales

public java.util.Enumeration getLocales()

Specified by:

getLocales in interface javax.servlet.ServletRequest

Overrides:

getLocales in class com.mockobjects.servlet.MockHttpServletRequest

addCookie

public void addCookie(javax.servlet.http.Cookie cookie)

Allows you to add a Cookie to the request to simulate receiving a cookie from the browser.

Parameters:

cookie - Cookie to added.

getCookies

public javax.servlet.http.Cookie[] getCookies()

Specified by:

getCookies in interface javax.servlet.http.HttpServletRequest

Overrides:

getCookies in class com.mockobjects.servlet.MockHttpServletRequest

getServerPort

public int getServerPort()

Specified by:

getServerPort in interface javax.servlet.ServletRequest

Overrides:

getServerPort in class com.mockobjects.servlet.MockHttpServletRequest

setupGetServerPort

public void setupGetServerPort(int p)

Sets the server port for this request.

Parameters:

p - Port

setupGetHeader

public void setupGetHeader(java.lang.String headerName,
                           java.lang.String value)

Add a GET header to the request.

Parameters:

headerName - name of header to be added

value - value of header to be added.

setupIsSecure

public void setupIsSecure(boolean s)

Configures whether this request is secure.

Parameters:

s - Flag indicating whether request is secure.

isSecure

public boolean isSecure()

Specified by:

isSecure in interface javax.servlet.ServletRequest

Overrides:

isSecure in class com.mockobjects.servlet.MockHttpServletRequest

getCharacterEncoding

public java.lang.String getCharacterEncoding()

Specified by:

getCharacterEncoding in interface javax.servlet.ServletRequest

Overrides:

getCharacterEncoding in class com.mockobjects.servlet.MockHttpServletRequest

setCharacterEncoding

public void setCharacterEncoding(java.lang.String encodingIn)

Specified by:

setCharacterEncoding in interface javax.servlet.ServletRequest

Overrides:

setCharacterEncoding in class com.mockobjects.servlet.MockHttpServletRequest

getMethod

public java.lang.String getMethod()

Specified by:

getMethod in interface javax.servlet.http.HttpServletRequest

Overrides:

getMethod in class com.mockobjects.servlet.MockHttpServletRequest

Returns:

Returns the method.

setMethod

public void setMethod(java.lang.String methodIn)

Parameters:

methodIn - The method to set.

getRemoteUser

public java.lang.String getRemoteUser()

Specified by:

getRemoteUser in interface javax.servlet.http.HttpServletRequest

Overrides:

getRemoteUser in class com.mockobjects.servlet.MockHttpServletRequest