oracle.stellent.ridc.protocol.http.apache3.impl

Class HttpApache3Method<M extends org.apache.commons.httpclient.HttpMethodBase>

java.lang.Object

oracle.stellent.ridc.protocol.http.apache3.impl.HttpApache3Method<M>

Type Parameters:

M -

All Implemented Interfaces:

RIDCHttpMethod

Direct Known Subclasses:

HttpApache3GetMethod, HttpApache3PostMethod

public abstract class HttpApache3Method<M extends org.apache.commons.httpclient.HttpMethodBase>
extends Object
implements RIDCHttpMethod

Method implementation for Apache 3.x

Field Summary

Fields

Modifier and Type	Field and Description
protected M	apacheMethod
protected IdcRequestConfig	requestConfig
protected HttpApache3Client	ridcClient
protected ServiceLog	serviceLog

Constructor Summary

Constructors

Constructor and Description
HttpApache3Method()

Method Summary

Modifier and Type	Method and Description
void	addRequestHeader(String name, String value) Add a request header
int	execute() Execute this method
M	getDelegateObject() Get the delegated object
InputStream	getResponseBodyAsStream() Get the response body as a stream
RIDCHttpHeader	getResponseHeader(String headerName) Get the response header
List<RIDCHttpHeader>	getResponseHeaders() Get the response headers
RIDCHttpClient	getRidcClient() Get the associated client with this method
int	getStatusCode() Get the status code
String	getStatusLine() Get the status line of the response
URI	getURI() Get the URI of this method
protected void	logRequest(String logID, M method)
protected void	logResponse(String logID, M method)
void	releaseConnection() Release the connection
void	setCookiePolicy(String cookiePolicy) Set the cookie policy
void	setFollowRedirects(boolean followRedirects) set if the client should follow redirects
void	setParameter(String param, String value) Set the request parameter
void	setQueryString(List<NameValuePair> params) Set the query string for the URL of this method
void	setRequestConfig(IdcRequestConfig requestConfig) Set the request-specific config for the request
void	setRequestHeader(String headerName, String headerValue) Set the request header
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

apacheMethod

protected M extends org.apache.commons.httpclient.HttpMethodBase apacheMethod

ridcClient

protected HttpApache3Client ridcClient

serviceLog

protected ServiceLog serviceLog

requestConfig

protected IdcRequestConfig requestConfig

Constructor Detail

HttpApache3Method

public HttpApache3Method()

Method Detail

releaseConnection

public void releaseConnection()

Release the connection

Specified by:

releaseConnection in interface RIDCHttpMethod

getDelegateObject

public M getDelegateObject()

Get the delegated object

Returns:

the delegated object

getStatusCode

public int getStatusCode()

Get the status code

Specified by:

getStatusCode in interface RIDCHttpMethod

Returns:

the status code

getURI

public URI getURI()
           throws URISyntaxException

Get the URI of this method

Specified by:

getURI in interface RIDCHttpMethod

Returns:

Throws:

URISyntaxException

getResponseBodyAsStream

public InputStream getResponseBodyAsStream()
                                    throws IOException

Get the response body as a stream

Specified by:

getResponseBodyAsStream in interface RIDCHttpMethod

Returns:

the response stream

Throws:

IOException

setRequestHeader

public void setRequestHeader(String headerName,
                             String headerValue)

Set the request header

Specified by:

setRequestHeader in interface RIDCHttpMethod

Parameters:

headerName - header name

headerValue - header value

getResponseHeader

public RIDCHttpHeader getResponseHeader(String headerName)

Get the response header

Specified by:

getResponseHeader in interface RIDCHttpMethod

Parameters:

headerName - header name

Returns:

setQueryString

public void setQueryString(List<NameValuePair> params)

Set the query string for the URL of this method

Specified by:

setQueryString in interface RIDCHttpMethod

Parameters:

params -

getResponseHeaders

public List<RIDCHttpHeader> getResponseHeaders()

Get the response headers

Specified by:

getResponseHeaders in interface RIDCHttpMethod

Returns:

getStatusLine

public String getStatusLine()

Get the status line of the response

Specified by:

getStatusLine in interface RIDCHttpMethod

Returns:

setFollowRedirects

public void setFollowRedirects(boolean followRedirects)

set if the client should follow redirects

Specified by:

setFollowRedirects in interface RIDCHttpMethod

Parameters:

followRedirects -

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

setCookiePolicy

public void setCookiePolicy(String cookiePolicy)

Set the cookie policy

Specified by:

setCookiePolicy in interface RIDCHttpMethod

Parameters:

cookiePolicy - policy name

setParameter

public void setParameter(String param,
                         String value)

Set the request parameter

Specified by:

setParameter in interface RIDCHttpMethod

Parameters:

param - param name

value - param value

getRidcClient

public RIDCHttpClient getRidcClient()

Get the associated client with this method

Specified by:

getRidcClient in interface RIDCHttpMethod

Returns:

execute

public int execute()
            throws IOException

Execute this method

Specified by:

execute in interface RIDCHttpMethod

Returns:

the status code

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)