edu.wisc.my.webproxy.beans.http

Interface Request

All Known Implementing Classes:

RequestImpl

public interface Request

Represents the data needed to make a HTTP request.

Version:

$Id$

Author:

nramzan

Method Summary

Methods

Modifier and Type	Method and Description
IHeader	createHeader(String name, String value) Creates and return an empty Header
String	getAuthType() Retrives the type(Basic, Form, NTML) of the authentication that was set on this object
IHeader[]	getHeaders() Retrieves an array of Headers that this object contains.
ParameterPair[]	getParameters() Retrieves all the post parameters on this object contained in map to make a post request
String	getType() Retrieves the type of the request that this object contains
String	getUrl() Retrieves the base url as a String that this object contains
void	setAuthType(String authType) There are a few differnt type of HTTP authentications, such as Basic, Form-based, NTLM etc.
void	setHeaders(IHeader[] h) Sets the Static Headers to this object
void	setParameters(ParameterPair[] attributes) Sets all the post parameters on this object contained in map to make a post request
void	setType(String type) Sets the type (GET, POST, HEAD) of the request that need to made to the remote server It may not be null
void	setUrl(String url) Sets the base url that is needed to make the request.

Method Detail

setHeaders

void setHeaders(IHeader[] h)

Sets the Static Headers to this object

Parameters:

h - the Headers to use for the request

getHeaders

IHeader[] getHeaders()

Retrieves an array of Headers that this object contains.

Returns:

Header[] an array of Headers that this object contains.

setUrl

void setUrl(String url)

Sets the base url that is needed to make the request. It may be not be null

Parameters:

url - the url as a string that is needed to make request to the remote server.

getUrl

String getUrl()

Retrieves the base url as a String that this object contains

Returns:

url the url as String that this object contains.

setType

void setType(String type)

Sets the type (GET, POST, HEAD) of the request that need to made to the remote server It may not be null

Parameters:

type - the request type as a String that need to be made to the remote server

getType

String getType()

Retrieves the type of the request that this object contains

Returns:

type the request type as String that this object contains.

createHeader

IHeader createHeader(String name,
                   String value)

Creates and return an empty Header

Returns:

header a empty Header that has no name and value.

setParameters

void setParameters(ParameterPair[] attributes)

Sets all the post parameters on this object contained in map to make a post request

Parameters:

postParameters - a Map containing all the parameters to make a post request.

getParameters

ParameterPair[] getParameters()

Retrieves all the post parameters on this object contained in map to make a post request

Returns:

postParameters a Map containing all the parameters to make a post request.

setAuthType

void setAuthType(String authType)

There are a few differnt type of HTTP authentications, such as Basic, Form-based, NTLM etc. Sets the type(Basic, Form, NTML) of the authentication that need to be used for successful authentication

Parameters:

authType - the authentication type as a String to identify the type of authentication request

getAuthType

String getAuthType()

Retrives the type(Basic, Form, NTML) of the authentication that was set on this object

Returns:

authType the authentication type as a String that was set on thsi object