oracle.stellent.ridc.protocol.http.apache4.impl

Class HttpApache4Method<M extends org.apache.http.client.methods.HttpRequestBase>

java.lang.Object

oracle.stellent.ridc.protocol.http.apache4.impl.HttpApache4Method<M>

Type Parameters:

M -

All Implemented Interfaces:

RIDCHttpMethod

Direct Known Subclasses:

HttpApache4GetMethod, HttpApache4PostMethod

public abstract class HttpApache4Method<M extends org.apache.http.client.methods.HttpRequestBase>
extends Object
implements RIDCHttpMethod

Abstract implementation of the GET and POST method in Apache 4.x

Field Summary

Fields

Modifier and Type	Field and Description
protected HttpApache4Client	httpClient
protected M	method
protected IdcRequestConfig	requestConfig
protected ServiceLog	serviceLog

Constructor Summary

Constructors

Constructor and Description
HttpApache4Method()

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
protected void	logRequest(String logID, M method)
protected void	logResponse(String logID, M method, org.apache.http.HttpResponse httpResponse)
void	releaseConnection() Release the connection
void	setCookiePolicy(String cookiePolicy) 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> nvpairList) 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

Methods inherited from class java.lang.Object

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

Field Detail

method

protected M extends org.apache.http.client.methods.HttpRequestBase method

httpClient

protected HttpApache4Client httpClient

serviceLog

protected ServiceLog serviceLog

requestConfig

protected IdcRequestConfig requestConfig

Constructor Detail

HttpApache4Method

public HttpApache4Method()

Method Detail

addRequestHeader

public void addRequestHeader(String name,
                             String value)

Add a request header

Specified by:

addRequestHeader in interface RIDCHttpMethod

Parameters:

name - the header name

value - the header value

getResponseBodyAsStream

public InputStream getResponseBodyAsStream()
                                    throws IOException

Get the response as a stream

Specified by:

getResponseBodyAsStream in interface RIDCHttpMethod

Returns:

the response stream

Throws:

IOException

getResponseHeader

public RIDCHttpHeader getResponseHeader(String headerName)

Get response header

Specified by:

getResponseHeader in interface RIDCHttpMethod

Parameters:

headerName - the header name

Returns:

getResponseHeaders

public List<RIDCHttpHeader> getResponseHeaders()

Get all response headers

Specified by:

getResponseHeaders in interface RIDCHttpMethod

Returns:

list of headers

getStatusCode

public int getStatusCode()

Get the status code of the response

Specified by:

getStatusCode in interface RIDCHttpMethod

Returns:

getStatusLine

public String getStatusLine()

Get the status line of the response

Specified by:

getStatusLine in interface RIDCHttpMethod

Returns:

getURI

public URI getURI()
           throws URISyntaxException

Get the uri of the request

Specified by:

getURI in interface RIDCHttpMethod

Returns:

Throws:

URISyntaxException

releaseConnection

public void releaseConnection()

Release the connection

Specified by:

releaseConnection in interface RIDCHttpMethod

setCookiePolicy

public void setCookiePolicy(String cookiePolicy)

Set Cookie policy for this action

Specified by:

setCookiePolicy in interface RIDCHttpMethod

Parameters:

cookiePolicy -

setFollowRedirects

public void setFollowRedirects(boolean followRedirects)

Set the follow directs option for the connection

Specified by:

setFollowRedirects in interface RIDCHttpMethod

Parameters:

followRedirects -

setRequestHeader

public void setRequestHeader(String headerName,
                             String headerValue)

Set the request header for the request

Specified by:

setRequestHeader in interface RIDCHttpMethod

Parameters:

headerName -

headerValue -

setParameter

public void setParameter(String param,
                         String value)

Set request parameters

Specified by:

setParameter in interface RIDCHttpMethod

Parameters:

param - param name

value - param value

setQueryString

public void setQueryString(List<NameValuePair> nvpairList)

Set the query string for the request

Specified by:

setQueryString in interface RIDCHttpMethod

Parameters:

nvpairList - the list of NameValuePair instances

getRidcClient

public RIDCHttpClient getRidcClient()

Get the connection instance that this method is associated with

Specified by:

getRidcClient in interface RIDCHttpMethod

Returns:

execute

public int execute()
            throws IOException

Execute the request

Specified by:

execute in interface RIDCHttpMethod

Returns:

status code of the response

Throws:

IOException

setServiceLog

public void setServiceLog(ServiceLog serviceLog)

Set the service log for the request

Specified by:

setServiceLog in interface RIDCHttpMethod

Parameters:

serviceLog -

setRequestConfig

public void setRequestConfig(IdcRequestConfig requestConfig)

Description copied from interface: RIDCHttpMethod

Set the request-specific config for the request

Specified by:

setRequestConfig in interface RIDCHttpMethod

logRequest

protected void logRequest(String logID,
                          M method)

logResponse

protected void logResponse(String logID,
                           M method,
                           org.apache.http.HttpResponse httpResponse)