oracle.stellent.ridc.common.http

Interface RIDCHttpMethod

All Known Subinterfaces:

RIDCHttpGetMethod, RIDCHttpPostMethod

All Known Implementing Classes:

HttpApache3GetMethod, HttpApache3Method, HttpApache3PostMethod, HttpApache4GetMethod, HttpApache4Method, HttpApache4PostMethod, HttpOracleGetMethod, HttpOracleMethod, HttpOraclePostMethod, HttpURLConnectionGetMethod, HttpURLConnectionMethod, HttpURLConnectionPostMethod

public interface RIDCHttpMethod

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

Method Summary

Modifier and Type	Method and Description
void	addRequestHeader(String name, String value) Add a request header
int	execute() Execute the request
InputStream	getResponseBodyAsStream() Get the response as a stream
RIDCHttpHeader	getResponseHeader(String headerName) Get response header
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
String	getStatusLine() Get the status line of the response
URI	getURI() Get the uri of the request
void	releaseConnection() Release the connection
void	setCookiePolicy(String policy) Set Cookie policy for this action
void	setFollowRedirects(boolean followRedirects) Set the follow directs option for the connection
void	setParameter(String param, String value) Set request parameters
void	setQueryString(List<NameValuePair> paramList) Set the query string for the request
void	setRequestConfig(IdcRequestConfig requestConfig) Set the request-specific config for the request
void	setRequestHeader(String headerName, String headerValue) Set the request header for the request
void	setServiceLog(ServiceLog serviceLog) Set the service log for the request

Method Detail

addRequestHeader

void addRequestHeader(String name,
                      String value)

Add a request header

Parameters:

name - the header name

value - the header value

getResponseBodyAsStream

InputStream getResponseBodyAsStream()
                             throws IOException,
                                    ProtocolException

Get the response as a stream

Returns:

the response stream

Throws:

IOException

ProtocolException

getResponseHeader

RIDCHttpHeader getResponseHeader(String headerName)
                          throws ProtocolException

Get response header

Parameters:

headerName -

Returns:

Throws:

ProtocolException

getResponseHeaders

List<RIDCHttpHeader> getResponseHeaders()
                                 throws ProtocolException

Get all response headers

Returns:

list of headers

Throws:

ProtocolException

getStatusCode

int getStatusCode()
           throws ProtocolException

Get the status code of the response

Returns:

Throws:

ProtocolException

getStatusLine

String getStatusLine()
              throws ProtocolException

Get the status line of the response

Returns:

Throws:

ProtocolException

getURI

URI getURI()
    throws URISyntaxException

Get the uri of the request

Returns:

Throws:

URISyntaxException

releaseConnection

void releaseConnection()

Release the connection

setCookiePolicy

void setCookiePolicy(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(String param,
                  String value)

Set request parameters

Parameters:

param - param name

value - param value

setQueryString

void setQueryString(List<NameValuePair> paramList)

Set the query string for the request

Parameters:

paramList -

setRequestHeader

void setRequestHeader(String headerName,
                      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 IOException,
            ProtocolException

Execute the request

Returns:

status code of the response

Throws:

IOException

ProtocolException

setServiceLog

void setServiceLog(ServiceLog serviceLog)

Set the service log for the request

Parameters:

serviceLog -

setRequestConfig

void setRequestConfig(IdcRequestConfig requestConfig)

Set the request-specific config for the request

Parameters:

requestConfig -