org.apache.cactus
Class BaseWebRequest

java.lang.Object
  org.apache.cactus.BaseWebRequest

All Implemented Interfaces:

Request

Direct Known Subclasses:

WebRequest

public class BaseWebRequest

extends java.lang.Object

implements Request

Contains all HTTP request data for a test case but independently of the fact that there is or there is not a Cactus redirector. It is the data that will be sent to the server side.

Version:

$Id: BaseWebRequest.java,v 1.9 2003/06/27 08:34:11 cmlenz Exp $

Author:

Vincent Massol, Jason Robertson

Field Summary

static java.lang.String	GET_METHOD GET Method identifier.
static java.lang.String	POST_METHOD POST Method identifier.

Constructor Summary

BaseWebRequest()
Default constructor that requires that setConfiguration(Configuration) be called before the methods requiring a configuration object.

BaseWebRequest(Configuration theConfiguration)

Method Summary

void	addCookie(Cookie theCookie) Adds a cookie to the request.
void	addCookie(java.lang.String theName, java.lang.String theValue) Adds a cookie to the request.
void	addCookie(java.lang.String theDomain, java.lang.String theName, java.lang.String theValue) Adds a cookie to the request.
void	addHeader(java.lang.String theName, java.lang.String theValue) Adds a header to the request.
void	addParameter(java.lang.String theName, java.lang.String theValue) Adds a parameter to the request.
void	addParameter(java.lang.String theName, java.lang.String theValue, java.lang.String theMethod) Adds a parameter to the request.
Authentication	getAuthentication()
protected Configuration	getConfiguration()
java.lang.String	getContentType()
java.util.Vector	getCookies()
java.lang.String	getHeader(java.lang.String theName) Returns the first value corresponding to this header's name.
java.util.Enumeration	getHeaderNames()
java.lang.String[]	getHeaderValues(java.lang.String theName) Returns all the values associated with this header's name.
java.lang.String	getParameterGet(java.lang.String theName) Returns the first value corresponding to this parameter's name (provided this parameter is passed in the URL).
java.util.Enumeration	getParameterNamesGet()
java.util.Enumeration	getParameterNamesPost()
java.lang.String	getParameterPost(java.lang.String theName) Returns the first value corresponding to this parameter's name (provided this parameter is passed in the request body - POST).
java.lang.String[]	getParameterValuesGet(java.lang.String theName) Returns all the values corresponding to this parameter's name (provided this parameter is passed in the URL).
java.lang.String[]	getParameterValuesPost(java.lang.String theName) Returns all the values corresponding to this parameter's name (provided this parameter is passed in the request body - POST).
java.io.InputStream	getUserData()
void	setAuthentication(Authentication theAuthentication) Sets the authentication object that will configure the http request
void	setConfiguration(Configuration theConfiguration)
void	setContentType(java.lang.String theContentType) Sets the content type that will be set in the http request
void	setUserData(java.io.InputStream theDataStream) Allow the user to send arbitrary data in the request body
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

GET_METHOD

public static final java.lang.String GET_METHOD

GET Method identifier.

See Also:

Constant Field Values

POST_METHOD

public static final java.lang.String POST_METHOD

POST Method identifier.

See Also:

Constant Field Values

Constructor Detail

BaseWebRequest

public BaseWebRequest()

Default constructor that requires that setConfiguration(Configuration) be called before the methods requiring a configuration object.

BaseWebRequest

public BaseWebRequest(Configuration theConfiguration)

Parameters:

theConfiguration - the Cactus configuration

Method Detail

getConfiguration

protected Configuration getConfiguration()

Returns:

the Cactus configuration

setConfiguration

public void setConfiguration(Configuration theConfiguration)

Parameters:

theConfiguration - the cactus configuration to assign to this request

setContentType

public void setContentType(java.lang.String theContentType)

Sets the content type that will be set in the http request

Parameters:

theContentType - the content type

getContentType

public java.lang.String getContentType()

Returns:

the content type that will be set in the http request

setUserData

public void setUserData(java.io.InputStream theDataStream)

Allow the user to send arbitrary data in the request body

Parameters:

theDataStream - the stream on which the data are put by the user

getUserData

public java.io.InputStream getUserData()

Returns:

the data stream set up by the user

addParameter

public void addParameter(java.lang.String theName,
                         java.lang.String theValue,
                         java.lang.String theMethod)

Adds a parameter to the request. It is possible to add several times the the same parameter name, but with different value (the same as for the HttpServletRequest).

Parameters:

theName - the parameter's name

theValue - the parameter's value

theMethod - GET_METHOD or POST_METHOD. If GET_METHOD then the parameter will be sent in the query string of the URL. If POST_METHOD, it will be sent as a parameter in the request body.

addParameter

public void addParameter(java.lang.String theName,
                         java.lang.String theValue)

Adds a parameter to the request. The parameter is added to the query string of the URL.

Parameters:

theName - the parameter's name

theValue - the parameter's value

See Also:

addParameter(String, String, String)

getParameterNamesPost

public java.util.Enumeration getParameterNamesPost()

Returns:

the parameter names that will be passed in the request body (POST)

getParameterNamesGet

public java.util.Enumeration getParameterNamesGet()

Returns:

the parameter names that will be passed in the URL (GET)

getParameterGet

public java.lang.String getParameterGet(java.lang.String theName)

Returns the first value corresponding to this parameter's name (provided this parameter is passed in the URL).

Parameters:

theName - the parameter's name

Returns:

the first value corresponding to this parameter's name or null if not found in the list of parameters to be sent in the URL

getParameterPost

public java.lang.String getParameterPost(java.lang.String theName)

Returns the first value corresponding to this parameter's name (provided this parameter is passed in the request body - POST).

Parameters:

theName - the parameter's name

Returns:

the first value corresponding to this parameter's name or null if not found in the list of parameters to be sent in the request body

getParameterValuesGet

public java.lang.String[] getParameterValuesGet(java.lang.String theName)

Returns all the values corresponding to this parameter's name (provided this parameter is passed in the URL).

Parameters:

theName - the parameter's name

Returns:

the first value corresponding to this parameter's name or null if not found in the list of parameters to be sent in the URL

getParameterValuesPost

public java.lang.String[] getParameterValuesPost(java.lang.String theName)

Returns all the values corresponding to this parameter's name (provided this parameter is passed in the request body - POST).

Parameters:

theName - the parameter's name

Returns:

the first value corresponding to this parameter's name or null if not found in the list of parameters to be sent in the request body

addCookie

public void addCookie(java.lang.String theName,
                      java.lang.String theValue)

Adds a cookie to the request. The cookie will be created with a default localhost domain. If you need to specify a domain for the cookie, use the addCookie(String, String, String) method or the method addCookie(Cookie).

Parameters:

theName - the cookie's name

theValue - the cookie's value

addCookie

public void addCookie(java.lang.String theDomain,
                      java.lang.String theName,
                      java.lang.String theValue)

Adds a cookie to the request. The cookie will be created with the domain passed as parameter (i.e. the cookie will get sent only to requests to that domain). Note that the domain must match either the redirector host (specified in cactus.properties) or the host set using setURL().

Parameters:

theDomain - the cookie domain

theName - the cookie name

theValue - the cookie value

addCookie

public void addCookie(Cookie theCookie)

Adds a cookie to the request. Note that the domain must match either the redirector host (specified in cactus.properties) or the host set using setURL().

Parameters:

theCookie - the cookie to add

getCookies

public java.util.Vector getCookies()

Returns:

the cookies (vector of Cookie objects)

addHeader

public void addHeader(java.lang.String theName,
                      java.lang.String theValue)

Adds a header to the request. Supports adding several values for the same header name.

Parameters:

theName - the header's name

theValue - the header's value

getHeaderNames

public java.util.Enumeration getHeaderNames()

Returns:

the header names

getHeader

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

Returns the first value corresponding to this header's name.

Parameters:

theName - the header's name

Returns:

the first value corresponding to this header's name or null if not found

getHeaderValues

public java.lang.String[] getHeaderValues(java.lang.String theName)

Returns all the values associated with this header's name.

Parameters:

theName - the header's name

Returns:

the values corresponding to this header's name or null if not found

toString

public java.lang.String toString()

Returns:

a string representation of the request

setAuthentication

public void setAuthentication(Authentication theAuthentication)

Sets the authentication object that will configure the http request

Parameters:

theAuthentication - the authentication object

getAuthentication

public Authentication getAuthentication()

Returns:

the authentication that will configure the http request