| org.apache.cactus.WebRequest
All known Subclasses: org.apache.cactus.internal.BaseWebRequest,
| WebRequest | | public interface WebRequest extends Request(Code) | | Contains HTTP request data for a Cactus test case.
version:
$Id: WebRequest.java 238991 2004-05-22 11:34:50Z vmassol $ |
| Method Summary | |
| void | addCookie(String theName, String theValue)
Adds a cookie to the request. | | void | addCookie(String theDomain, String theName, String theValue)
Adds a cookie to the request. | | void | addCookie(Cookie theCookie)
Adds a cookie to the request. | | void | addHeader(String theName, String theValue)
Adds a header to the request. | | void | addParameter(String theName, String theValue, String theMethod)
Adds a parameter to the request. | | void | addParameter(String theName, String theValue)
Adds a parameter to the request. | | Authentication | getAuthentication()
| | boolean | getAutomaticSession()
| | String | getContentType()
| | Vector | getCookies()
| | String | getHeader(String theName)
Returns the first value corresponding to this header's name. | | Enumeration | getHeaderNames()
| | String[] | getHeaderValues(String theName)
Returns all the values associated with this header's name. | | String | getParameterGet(String theName)
Returns the first value corresponding to this parameter's name (provided
this parameter is passed in the URL). | | Enumeration | getParameterNamesGet()
| | Enumeration | getParameterNamesPost()
| | String | getParameterPost(String theName)
Returns the first value corresponding to this parameter's name (provided
this parameter is passed in the request body - POST). | | String[] | getParameterValuesGet(String theName)
Returns all the values corresponding to this parameter's name (provided
this parameter is passed in the URL). | | String[] | getParameterValuesPost(String theName)
Returns all the values corresponding to this parameter's name (provided
this parameter is passed in the request body - POST). | | String | getRedirectorName()
| | HttpSessionCookie | getSessionCookie()
Gets an HTTP session id by calling the server side and retrieving
the jsessionid cookie in the HTTP response. | | ServletURL | getURL()
| | InputStream | getUserData()
| | void | setAuthentication(Authentication theAuthentication)
| | void | setAutomaticSession(boolean isAutomaticSession)
Parameters:
isAutomaticSession - whether the redirector servlet willautomatically create the HTTP session or not. | | void | setContentType(String theContentType)
| | void | setRedirectorName(String theRedirectorName)
Override the redirector Name defined in cactus.properties. | | void | setURL(String theServerName, String theContextPath, String theServletPath, String thePathInfo, String theQueryString)
Sets the simulated URL. | | void | setUserData(InputStream theDataStream)
|
| POST_METHOD | | String POST_METHOD(Code) | | POST Method identifier.
|
| addCookie | | void addCookie(String theDomain, String theName, String theValue)(Code) | | 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
Parameters:
theName - the cookie name
Parameters:
theValue - the cookie value |
| addCookie | | void addCookie(Cookie theCookie)(Code) | | 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 |
| addHeader | | void addHeader(String theName, String theValue)(Code) | | Adds a header to the request. Supports adding several values for the
same header name.
Parameters:
theName - the header's name
Parameters:
theValue - the header's value |
| addParameter | | void addParameter(String theName, String theValue, String theMethod)(Code) | | 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
Parameters:
theValue - the parameter's value
Parameters:
theMethod - GET_METHOD or POST_METHOD. If GET_METHOD then theparameter will be sent in the query string of the URL. IfPOST_METHOD, it will be sent as a parameter in the request body. |
| getAuthentication | | Authentication getAuthentication()(Code) | | the authentication that will configure the http request |
| getAutomaticSession | | boolean getAutomaticSession()(Code) | | true if session will be automatically created for the user orfalse otherwise. |
| getContentType | | String getContentType()(Code) | | the content type that will be set in the http request |
| getCookies | | Vector getCookies()(Code) | | the cookies (vector of Cookie objects) |
| getHeader | | String getHeader(String theName)(Code) | | Returns the first value corresponding to this header's name.
Parameters:
theName - the header's name the first value corresponding to this header's name or null ifnot found |
| getHeaderValues | | String[] getHeaderValues(String theName)(Code) | | Returns all the values associated with this header's name.
Parameters:
theName - the header's name the values corresponding to this header's name or null if notfound |
| getParameterGet | | String getParameterGet(String theName)(Code) | | Returns the first value corresponding to this parameter's name (provided
this parameter is passed in the URL).
Parameters:
theName - the parameter's name the first value corresponding to this parameter's name or nullif not found in the list of parameters to be sent in the URL |
| getParameterNamesGet | | Enumeration getParameterNamesGet()(Code) | | the parameter names that will be passed in the URL (GET) |
| getParameterNamesPost | | Enumeration getParameterNamesPost()(Code) | | the parameter names that will be passed in the request body(POST) |
| getParameterPost | | String getParameterPost(String theName)(Code) | | 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 the first value corresponding to this parameter's name or nullif not found in the list of parameters to be sent in the requestbody |
| getParameterValuesGet | | String[] getParameterValuesGet(String theName)(Code) | | Returns all the values corresponding to this parameter's name (provided
this parameter is passed in the URL).
Parameters:
theName - the parameter's name the first value corresponding to this parameter's name or nullif not found in the list of parameters to be sent in the URL |
| getParameterValuesPost | | String[] getParameterValuesPost(String theName)(Code) | | 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 the first value corresponding to this parameter's name or nullif not found in the list of parameters to be sent in the requestbody |
| getRedirectorName | | String getRedirectorName()(Code) | | the overriden redirector Name or null if none has been defined |
| getSessionCookie | | HttpSessionCookie getSessionCookie()(Code) | | Gets an HTTP session id by calling the server side and retrieving
the jsessionid cookie in the HTTP response. This is achieved by
calling the Cactus redirector used by the current test case.
the HTTP session id as a HttpSessionCookie object |
| setAuthentication | | void setAuthentication(Authentication theAuthentication)(Code) | | Sets the authentication object that will configure the http request
Parameters:
theAuthentication - the authentication object |
| setAutomaticSession | | void setAutomaticSession(boolean isAutomaticSession)(Code) | |
Parameters:
isAutomaticSession - whether the redirector servlet willautomatically create the HTTP session or not. Default is true. |
| setContentType | | void setContentType(String theContentType)(Code) | | Sets the content type that will be set in the http request
Parameters:
theContentType - the content type |
| setRedirectorName | | void setRedirectorName(String theRedirectorName)(Code) | | Override the redirector Name defined in cactus.properties.
This is useful to define a per test case Name (for example, if some
test case need to have authentication turned on and not other tests,
etc).
Parameters:
theRedirectorName - the new redirector Name to use |
| setURL | | void setURL(String theServerName, String theContextPath, String theServletPath, String thePathInfo, String theQueryString)(Code) | | Sets the simulated URL. A URL is of the form :
URL = "http://" + serverName (including port) + requestURI ? queryString
requestURI = contextPath + servletPath + pathInfo
- Context Path: The path prefix associated with the
ServletContext that this servlet is a part of. If this context is the
default context rooted at the base of the web server's URL namespace,
this path will be an empty string. Otherwise, this path starts with a
character but does not end with a character.
- Servlet Path: The path section that directly corresponds to
the mapping which activated this request. This path starts with a
character.
- PathInfo: The part of the request path that is not part of the
Context Path or the Servlet Path.
Parameters:
theServerName - the server name (and port) in the URL to simulate,i.e. this is the name that will be returned by theHttpServletRequest.getServerName() andHttpServletRequest.getServerPort().
Parameters:
theContextPath - the webapp context path in the URL to simulate,i.e. this is the name that will be returned by theHttpServletRequest.getContextPath().Can be null. Format: "/" + name or an empty stringfor the default context.
Parameters:
theServletPath - the servlet path in the URL to simulate,i.e. this is the name that will be returned by theHttpServletRequest.getServletPath().Can be null. Format : "/" + name.
Parameters:
thePathInfo - the path info in the URL to simulate, i.e. this isthe name that will be returned by theHttpServletRequest.getPathInfo(). Canbe null. Format : "/" + name.
Parameters:
theQueryString - the Query string in the URL to simulate, i.e. thisis the string that will be returned by theHttpServletResquest.getQueryString().Can be null. |
| setUserData | | void setUserData(InputStream theDataStream)(Code) | | Allow the user to send arbitrary data in the request body
Parameters:
theDataStream - the stream on which the data are put by the user |
|
|