Skip navigation links

oracle.stellent.ridc.common.http
Interface RIDCHttpMethod

All Known Subinterfaces:

RIDCHttpGetMethod, RIDCHttpPostMethod

All Known Implementing Classes:

HttpApache3GetMethod, HttpApache3Method, HttpApache3PostMethod, HttpApache4GetMethod, HttpApache4Method, HttpApache4PostMethod

public interface RIDCHttpMethod

Generic interface for HTTP Methods/Actions (GET and POST)

Method Summary

void	addRequestHeader(java.lang.String name, java.lang.String value) Add a request header
int	execute() Execute the request
java.io.InputStream	getResponseBodyAsStream() Get the response as a stream
RIDCHttpHeader	getResponseHeader(java.lang.String headerName) Get response header
java.util.List<RIDCHttpHeader>	getResponseHeaders() Get all response headers
RIDCHttpClient	getRidcClient() Get the connection instance that this method is associated with
int	getStatusCode() Get the status code of the response
java.lang.String	getStatusLine() Get the status line of the response
java.net.URI	getURI() Get the uri of the request
void	releaseConnection() Release the connection
void	setCookiePolicy(java.lang.String policy) Set Cookie policy for this action
void	setFollowRedirects(boolean followRedirects) Set the follow directs option for the connection
void	setParameter(java.lang.String param, java.lang.String value) Set request parameters
void	setQueryString(java.util.List<NameValuePair> paramList) Set the query string for the request
void	setRequestHeader(java.lang.String headerName, java.lang.String headerValue) Set the request header for the request

Method Detail

addRequestHeader

void addRequestHeader(java.lang.String name,
                      java.lang.String value)

Add a request header

Parameters:

name - the header name

value - the header value

getResponseBodyAsStream

java.io.InputStream getResponseBodyAsStream()
                                            throws java.io.IOException

Get the response as a stream

Returns:

the response stream

Throws:

java.io.IOException

getResponseHeader

RIDCHttpHeader getResponseHeader(java.lang.String headerName)

Get response header

Parameters:

headerName -

Returns:

getResponseHeaders

java.util.List<RIDCHttpHeader> getResponseHeaders()

Get all response headers

Returns:

list of headers

getStatusCode

int getStatusCode()

Get the status code of the response

Returns:

getStatusLine

java.lang.String getStatusLine()

Get the status line of the response

Returns:

getURI

java.net.URI getURI()
                    throws java.net.URISyntaxException,
                           org.apache.commons.httpclient.URIException

Get the uri of the request

Returns:

Throws:

java.net.URISyntaxException

org.apache.commons.httpclient.URIException

releaseConnection

void releaseConnection()

Release the connection

setCookiePolicy

void setCookiePolicy(java.lang.String policy)

Set Cookie policy for this action

Parameters:

policy -

setFollowRedirects

void setFollowRedirects(boolean followRedirects)

Set the follow directs option for the connection

Parameters:

followRedirects -

setParameter

void setParameter(java.lang.String param,
                  java.lang.String value)

Set request parameters

Parameters:

param - param name

value - param value

setQueryString

void setQueryString(java.util.List<NameValuePair> paramList)

Set the query string for the request

Parameters:

paramList -

setRequestHeader

void setRequestHeader(java.lang.String headerName,
                      java.lang.String headerValue)

Set the request header for the request

Parameters:

headerName -

headerValue -

getRidcClient

RIDCHttpClient getRidcClient()

Get the connection instance that this method is associated with

Returns:

execute

int execute()
            throws java.io.IOException

Execute the request

Returns:

status code of the response

Throws:

java.io.IOException

Skip navigation links