com.uwyn.rife.test
Class MockRequest

java.lang.Object
  com.uwyn.rife.test.MockRequest

All Implemented Interfaces:

Request

public class MockRequest
extends Object
implements Request

Provides a Request implementation that is suitable for testing a web application outside of a servlet container.

Since:

1.1

Version:

$Revision: 3669 $

Author:

Geert Bevin (gbevin[remove] at uwyn dot com)

Constructor Summary

MockRequest()

Method Summary

MockRequest	addDateHeader(String name, long value) Adds a request header with the given name and date-value.
MockRequest	addHeader(String name, String value) Adds a request header with the given name and value.
MockRequest	addIntHeader(String name, int value) Adds a request header with the given name and integer value.
void	addLocale(Locale locale) Adds a Locale to this request.
MockRequest	characterEncoding(String encoding) Set the character encoding of this request.
boolean	containsHeader(String name) Checks whether a certain request header is present.
MockRequest	contentType(String type) Set the content type of this request.
MockRequest	dateHeader(String name, long value) Sets a request header with the given name and date-value.
MockRequest	file(String name, MockFileUpload file) Sets a file in this request.
MockRequest	files(Map<String,MockFileUpload[]> files) Sets a map of files in this request.
MockRequest	files(String name, MockFileUpload[] files) Sets files in this request.
Object	getAttribute(String name) See ServletRequest.getAttribute(String).
Enumeration	getAttributeNames() See ServletRequest.getAttributeNames().
String	getCharacterEncoding() See ServletRequest.getCharacterEncoding().
String	getContentType() See ServletRequest.getContentType().
String	getContextPath() See HttpServletRequest.getContextPath().
Cookie	getCookie(String name) Retrieves a cookie.
Cookie[]	getCookies() See HttpServletRequest.getCookies().
long	getDateHeader(String name) See HttpServletRequest.getDateHeader(String).
UploadedFile	getFile(String name) Retrieves an uploaded file.
Map<String,UploadedFile[]>	getFiles() Retrieves the files that were uploaded in this request.
UploadedFile[]	getFiles(String name) Retrieves all files that have been uploaded for a particular name.
String	getHeader(String name) See HttpServletRequest.getHeader(String).
Enumeration	getHeaderNames() See HttpServletRequest.getHeaderNames().
Enumeration	getHeaders(String name) See HttpServletRequest.getHeaders(String).
HttpServletRequest	getHttpServletRequest() Retrieves the underlying HttpServletRequest.
int	getIntHeader(String name) See HttpServletRequest.getIntHeader(String).
Locale	getLocale() See ServletRequest.getLocale().
Enumeration	getLocales() See ServletRequest.getLocales().
RequestMethod	getMethod() See HttpServletRequest.getMethod().
Map<String,String[]>	getParameters() Retrieves all the parameters of this request.
String	getProtocol() See ServletRequest.getProtocol().
String	getRemoteAddr() See ServletRequest.getRemoteAddr().
String	getRemoteHost() See ServletRequest.getRemoteHost().
String	getRemoteUser() See HttpServletRequest.getRemoteUser().
RequestDispatcher	getRequestDispatcher(String url) See ServletRequest.getRequestDispatcher(String).
String	getScheme() See ServletRequest.getScheme().
String	getServerName() See ServletRequest.getServerName().
int	getServerPort() See ServletRequest.getServerPort().
String	getServerRootUrl(int port) Returns the root URL of the server that is running this web applications.
HttpSession	getSession() See HttpServletRequest.getSession().
HttpSession	getSession(boolean create) See HttpServletRequest.getSession(boolean).
boolean	hasAttribute(String name) Checks if a request attribute exists.
boolean	hasCookie(String name) Checks whether a cookie is present.
boolean	hasFile(String name) Checks if a particular file has been uploaded in this request.
boolean	hasParameter(String name) Checks whether a named parameter is present in this request.
MockRequest	header(String name, String value) Sets a request header with the given name and value.
void	init(StateStore stateStore) Initialize the state of this request from a StateStore.
MockRequest	intHeader(String name, int value) Sets a request header with the given name and integer value.
boolean	isSecure() See ServletRequest.isSecure().
MockRequest	locale(Locale locale) Adds a Locale to this request.
MockRequest	method(RequestMethod method) Sets the method of this request.
MockRequest	parameter(String name, String value) Sets a parameter in this request.
MockRequest	parameter(String name, String[] values) Sets a parameter in this request.
MockRequest	parameters(Map<String,String[]> parameters) Sets a map of parameters in this request.
MockRequest	protocol(String protocol) Set the protocol of this request.
MockRequest	remoteAddr(String remoteAddr) Set the remote address of this request.
MockRequest	remoteHost(String remoteHost) Set the remote host of this request.
MockRequest	remoteUser(String remoteUser) Set the remote user of this request.
void	removeAttribute(String name) See ServletRequest.removeAttribute(String).
void	removeHeader(String name) Removes a request header with the given name.
MockRequest	secure(boolean secure) Set whether this request is secure.
void	setAttribute(String name, Object object) See ServletRequest.setAttribute(String, Object).
void	setCharacterEncoding(String encoding) Set the character encoding of this request.
void	setContentType(String type) Set the content type of this request.
void	setDateHeader(String name, long value) Sets a request header with the given name and date-value.
void	setFile(String name, MockFileUpload file) Sets a file in this request.
void	setFiles(Map<String,MockFileUpload[]> files) Sets a map of files in this request.
void	setFiles(String name, MockFileUpload[] files) Sets files in this request.
void	setHeader(String name, String value) Sets a request header with the given name and value.
void	setIntHeader(String name, int value) Sets a request header with the given name and integer value.
void	setMethod(RequestMethod method) Sets the method of this request.
void	setParameter(String name, String value) Sets a parameter in this request.
void	setParameter(String name, String[] values) Sets a parameter in this request.
void	setParameters(Map<String,String[]> parameters) Sets a map of parameters in this request.
void	setProtocol(String protocol) Set the protocol of this request.
void	setRemoteAddr(String remoteAddr) Set the remote address of this request.
void	setRemoteHost(String remoteHost) Set the remote host of this request.
void	setRemoteUser(String remoteUser) Set the remote user of this request.
void	setSecure(boolean secure) Set whether this request is secure.

Methods inherited from class java.lang.Object

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

Constructor Detail

MockRequest

public MockRequest()

Method Detail

init

public void init(StateStore stateStore)

Description copied from interface: Request

Initialize the state of this request from a StateStore.

This method is only there to be used by the web engine, it should never be called manually.

Specified by:

init in interface Request

Parameters:

stateStore - the StateStore that will be used to initialize the request

getMethod

public RequestMethod getMethod()

Description copied from interface: Request

See HttpServletRequest.getMethod().

Specified by:

getMethod in interface Request

setMethod

public void setMethod(RequestMethod method)

Sets the method of this request.

The method defaults to RequestMethod.GET.

Parameters:

method - the method that will be used by this request

Since:

1.1

See Also:

getMethod(), method(com.uwyn.rife.engine.RequestMethod)

method

public MockRequest method(RequestMethod method)

Sets the method of this request.

Parameters:

method - the method that will be used by this request

Returns:

this MockRequest instance

Since:

1.1

See Also:

getMethod(), setMethod(com.uwyn.rife.engine.RequestMethod)

hasParameter

public boolean hasParameter(String name)

Checks whether a named parameter is present in this request.

Parameters:

name - the name of the parameter to check

Returns:

true if the parameter is present; or

false otherwise

Since:

1.1

See Also:

getParameters(), setParameters(java.util.Map), setParameter(String, String[]), setParameter(String, String)

getParameters

public Map<String,String[]> getParameters()

Retrieves all the parameters of this request.

Specified by:

getParameters in interface Request

Returns:

a Map of the parameters with the names as the keys and their value arrays as the values

Since:

1.1

See Also:

hasParameter(java.lang.String), setParameters(java.util.Map), setParameter(String, String[]), setParameter(String, String)

setParameters

public void setParameters(Map<String,String[]> parameters)

Sets a map of parameters in this request.

Parameters:

parameters - a Map of the parameters that will be set with the names as the keys and their value arrays as the values

Since:

1.1

See Also:

hasParameter(java.lang.String), getParameters(), setParameter(String, String[]), setParameter(String, String)

parameters

public MockRequest parameters(Map<String,String[]> parameters)

Sets a map of parameters in this request.

Parameters:

parameters - a Map of the parameters that will be set with the names as the keys and their value arrays as the values

Returns:

this MockRequest instance

Since:

1.1

See Also:

hasParameter(java.lang.String), getParameters(), setParameters(java.util.Map), setParameter(String, String[]), setParameter(String, String)

setParameter

public void setParameter(String name,
                         String[] values)

Sets a parameter in this request.

Parameters:

name - the name of the parameter

values - the value array of the parameter

Since:

1.1

See Also:

hasParameter(java.lang.String), getParameters(), setParameters(java.util.Map), setParameter(String, String)

parameter

public MockRequest parameter(String name,
                             String[] values)

Sets a parameter in this request.

Parameters:

name - the name of the parameter

values - the value array of the parameter

Returns:

this MockRequest instance

Since:

1.1

See Also:

hasParameter(java.lang.String), getParameters(), setParameters(java.util.Map), setParameter(String, String[]), setParameter(String, String)

setParameter

public void setParameter(String name,
                         String value)

Sets a parameter in this request.

Parameters:

name - the name of the parameter

value - the value of the parameter

Since:

1.1

See Also:

hasParameter(java.lang.String), getParameters(), setParameters(java.util.Map), setParameter(String, String[])

parameter

public MockRequest parameter(String name,
                             String value)

Sets a parameter in this request.

Parameters:

name - the name of the parameter

value - the value of the parameter

Returns:

this MockRequest instance

Since:

1.1

See Also:

hasParameter(java.lang.String), getParameters(), setParameters(java.util.Map), setParameter(String, String[]), setParameter(String, String)

getFiles

public Map<String,UploadedFile[]> getFiles()

Description copied from interface: Request

Retrieves the files that were uploaded in this request.

Specified by:

getFiles in interface Request

Returns:

a Map with all the uploaded files

See Also:

Request.hasFile(String), Request.getFile(String), Request.getFiles(String)

hasFile

public boolean hasFile(String name)

Description copied from interface: Request

Checks if a particular file has been uploaded in this request.

Specified by:

hasFile in interface Request

Parameters:

name - the name of the file, as declared in the submission

Returns:

true if the file was uploaded; or

false otherwise

See Also:

Request.getFiles(), Request.getFile(String), Request.getFiles(String)

getFile

public UploadedFile getFile(String name)

Description copied from interface: Request

Retrieves an uploaded file.

Specified by:

getFile in interface Request

Parameters:

name - the name of the file, as declared in the submission

Returns:

the uploaded file; or

null if no file was uploaded

See Also:

Request.getFiles(), Request.hasFile(String), Request.getFiles(String)

getFiles

public UploadedFile[] getFiles(String name)

Description copied from interface: Request

Retrieves all files that have been uploaded for a particular name.

Specified by:

getFiles in interface Request

Parameters:

name - the name of the file, as declared in the submission

Returns:

the uploaded files; or

null if no files were uploaded for that name

See Also:

Request.getFiles(), Request.hasFile(String), Request.getFile(String)

setFile

public void setFile(String name,
                    MockFileUpload file)

Sets a file in this request.

Parameters:

name - the parameter name of the file

file - the file specification that will be uploaded

Since:

1.1

See Also:

hasFile(java.lang.String), getFile(java.lang.String), getFiles(), setFiles(Map), setFiles(String, MockFileUpload[])

setFiles

public void setFiles(Map<String,MockFileUpload[]> files)

Sets a map of files in this request.

Parameters:

files - a Map of the files that will be set with the names as the keys and their file upload specifications as the values

Since:

1.1

See Also:

hasFile(java.lang.String), getFile(java.lang.String), getFiles(), setFile(String, MockFileUpload), setFiles(String, MockFileUpload[])

setFiles

public void setFiles(String name,
                     MockFileUpload[] files)

Sets files in this request.

Parameters:

name - the parameter name of the file

files - the file specifications that will be uploaded

Since:

1.1

See Also:

hasFile(java.lang.String), getFile(java.lang.String), getFiles(), setFile(String, MockFileUpload), setFiles(Map)

file

public MockRequest file(String name,
                        MockFileUpload file)

Sets a file in this request.

Parameters:

name - the parameter name of the file

file - the file specification that will be uploaded

Returns:

this MockRequest instance

Since:

1.1

See Also:

hasFile(java.lang.String), getFile(java.lang.String), getFiles(), setFile(String, MockFileUpload), setFiles(Map), setFiles(String, MockFileUpload[])

files

public MockRequest files(Map<String,MockFileUpload[]> files)

Sets a map of files in this request.

Parameters:

files - a Map of the files that will be set with the names as the keys and their file upload specifications as the values

Returns:

this MockRequest instance

Since:

1.1

See Also:

hasFile(java.lang.String), getFile(java.lang.String), getFiles(), setFile(String, MockFileUpload), setFiles(Map), setFiles(String, MockFileUpload[])

files

public MockRequest files(String name,
                         MockFileUpload[] files)

Sets files in this request.

Parameters:

name - the parameter name of the file

files - the file specifications that will be uploaded

Returns:

this MockRequest instance

Since:

1.1

See Also:

hasFile(java.lang.String), getFile(java.lang.String), getFiles(), setFile(String, MockFileUpload), setFiles(Map), setFiles(String, MockFileUpload[])

getServerRootUrl

public String getServerRootUrl(int port)

Description copied from interface: Request

Returns the root URL of the server that is running this web applications.

This includes the protocol, the server name and the server port, for example: http://www.somehost.com:8080.

Specified by:

getServerRootUrl in interface Request

Returns:

the server's root url

hasCookie

public boolean hasCookie(String name)

Description copied from interface: Request

Checks whether a cookie is present.

Specified by:

hasCookie in interface Request

Parameters:

name - the name of the cookie

Returns:

true if the cookie was present; or

false otherwise

See Also:

Request.getCookie(String), Request.getCookies()

getCookie

public Cookie getCookie(String name)

Description copied from interface: Request

Retrieves a cookie.

Specified by:

getCookie in interface Request

Parameters:

name - the name of the cookie.

Returns:

the instance of the cookie; or

null if no such cookie is present

See Also:

Request.hasCookie(String), Request.getCookies()

getCookies

public Cookie[] getCookies()

Description copied from interface: Request

See HttpServletRequest.getCookies().

Specified by:

getCookies in interface Request

getAttribute

public Object getAttribute(String name)

Description copied from interface: Request

See ServletRequest.getAttribute(String).

Specified by:

getAttribute in interface Request

hasAttribute

public boolean hasAttribute(String name)

Description copied from interface: Request

Checks if a request attribute exists.

Specified by:

hasAttribute in interface Request

Parameters:

name - a String specifying the name of the attribute

false otherwise

getAttributeNames

public Enumeration getAttributeNames()

Description copied from interface: Request

See ServletRequest.getAttributeNames().

Specified by:

getAttributeNames in interface Request

removeAttribute

public void removeAttribute(String name)

Description copied from interface: Request

See ServletRequest.removeAttribute(String).

Specified by:

removeAttribute in interface Request

setAttribute

public void setAttribute(String name,
                         Object object)

Description copied from interface: Request

See ServletRequest.setAttribute(String, Object).

Specified by:

setAttribute in interface Request

getCharacterEncoding

public String getCharacterEncoding()

Description copied from interface: Request

See ServletRequest.getCharacterEncoding().

Specified by:

getCharacterEncoding in interface Request

setCharacterEncoding

public void setCharacterEncoding(String encoding)

Set the character encoding of this request.

Parameters:

encoding - the name of the character encoding

Since:

1.1

characterEncoding

public MockRequest characterEncoding(String encoding)

Set the character encoding of this request.

Parameters:

encoding - the name of the character encoding

Returns:

this MockRequest instance

Since:

1.1

getContentType

public String getContentType()

Description copied from interface: Request

See ServletRequest.getContentType().

Specified by:

getContentType in interface Request

setContentType

public void setContentType(String type)

Set the content type of this request.

Parameters:

type - the content type

Since:

1.1

contentType

public MockRequest contentType(String type)

Set the content type of this request.

Parameters:

type - the content type

Returns:

this MockRequest instance

Since:

1.1

getDateHeader

public long getDateHeader(String name)

Description copied from interface: Request

See HttpServletRequest.getDateHeader(String).

Specified by:

getDateHeader in interface Request

getHeader

public String getHeader(String name)

Description copied from interface: Request

See HttpServletRequest.getHeader(String).

Specified by:

getHeader in interface Request

getHeaderNames

public Enumeration getHeaderNames()

Description copied from interface: Request

See HttpServletRequest.getHeaderNames().

Specified by:

getHeaderNames in interface Request

getHeaders

public Enumeration getHeaders(String name)

Description copied from interface: Request

See HttpServletRequest.getHeaders(String).

Specified by:

getHeaders in interface Request

getIntHeader

public int getIntHeader(String name)

Description copied from interface: Request

See HttpServletRequest.getIntHeader(String).

Specified by:

getIntHeader in interface Request

addHeader

public MockRequest addHeader(String name,
                             String value)

Adds a request header with the given name and value. This method allows request headers to have multiple values.

Parameters:

name - the name of the header to set

value - the additional header value

Returns:

this MockRequest instance

Since:

1.1

addDateHeader

public MockRequest addDateHeader(String name,
                                 long value)

Adds a request header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. This method allows request headers to have multiple values.

Parameters:

name - the name of the header to set

value - the additional date value

Returns:

this MockRequest instance

Since:

1.1

addIntHeader

public MockRequest addIntHeader(String name,
                                int value)

Adds a request header with the given name and integer value. This method allows request headers to have multiple values.

Parameters:

name - the name of the header to set

value - the additional integer value

Returns:

this MockRequest instance

Since:

1.1

containsHeader

public boolean containsHeader(String name)

Checks whether a certain request header is present.

Parameters:

name - the name of the header to check

Returns:

true if the header was present; or

false otherwise

Since:

1.1

setDateHeader

public void setDateHeader(String name,
                          long value)

Sets a request header with the given name and date-value. The date is specified in terms of milliseconds since the epoch. If the header had already been set, the new value overwrites the previous one. The containsHeader(java.lang.String) method can be used to test for the presence of a header before setting its value.

Parameters:

name - the name of the header to set

value - the assigned date value

Since:

1.1

dateHeader

public MockRequest dateHeader(String name,
                              long value)

Sets a request header with the given name and date-value.

Parameters:

name - the name of the header to set

value - the assigned date value

Since:

1.1

See Also:

setDateHeader(java.lang.String, long)

setHeader

public void setHeader(String name,
                      String value)

Sets a request header with the given name and value. If the header had already been set, the new value overwrites the previous one. The containsHeader(java.lang.String) method can be used to test for the presence of a header before setting its value.

Parameters:

name - the name of the header to set

value - the header value

Since:

1.1

header

public MockRequest header(String name,
                          String value)

Sets a request header with the given name and value.

Parameters:

name - the name of the header to set

value - the header value

Since:

1.1

See Also:

setDateHeader(java.lang.String, long)

setIntHeader

public void setIntHeader(String name,
                         int value)

Sets a request header with the given name and integer value. If the header had already been set, the new value overwrites the previous one. The containsHeader method can be used to test for the presence of a header before setting its value.

Parameters:

name - the name of the header to set

value - the assigned integer value

Since:

1.1

intHeader

public MockRequest intHeader(String name,
                             int value)

Sets a request header with the given name and integer value.

Parameters:

name - the name of the header to set

value - the assigned integer value

Since:

1.1

See Also:

setDateHeader(java.lang.String, long)

removeHeader

public void removeHeader(String name)

Removes a request header with the given name.

Parameters:

name - the name of the header to remove

Since:

1.1

getLocale

public Locale getLocale()

Description copied from interface: Request

See ServletRequest.getLocale().

Specified by:

getLocale in interface Request

getLocales

public Enumeration getLocales()

Description copied from interface: Request

See ServletRequest.getLocales().

Specified by:

getLocales in interface Request

addLocale

public void addLocale(Locale locale)

Adds a Locale to this request.

Parameters:

locale - the locale to add

Since:

1.1

locale

public MockRequest locale(Locale locale)

Adds a Locale to this request.

Parameters:

locale - the locale to add

Returns:

this MockRequest instance

Since:

1.1

getProtocol

public String getProtocol()

Description copied from interface: Request

See ServletRequest.getProtocol().

Specified by:

getProtocol in interface Request

setProtocol

public void setProtocol(String protocol)

Set the protocol of this request.

The default protocol is "HTTP/1.1".

Parameters:

protocol - the protocol to set

Since:

1.1

protocol

public MockRequest protocol(String protocol)

Set the protocol of this request.

Parameters:

protocol - the protocol to set

Returns:

this MockRequest instance

Since:

1.1

getRemoteAddr

public String getRemoteAddr()

Description copied from interface: Request

See ServletRequest.getRemoteAddr().

Specified by:

getRemoteAddr in interface Request

setRemoteAddr

public void setRemoteAddr(String remoteAddr)

Set the remote address of this