oracle.stellent.ridc.protocol.http.httpurlconnection.impl

Class HttpURLConnectionMethod

java.lang.Object

oracle.stellent.ridc.protocol.http.httpurlconnection.impl.HttpURLConnectionMethod

All Implemented Interfaces:

RIDCHttpMethod

Direct Known Subclasses:

HttpURLConnectionGetMethod, HttpURLConnectionPostMethod

public abstract class HttpURLConnectionMethod
extends Object
implements RIDCHttpMethod

Field Summary

Fields

Modifier and Type	Field and Description
protected IdcRequestConfig	requestConfig
protected ServiceLog	serviceLog

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	HttpURLConnectionMethod(String uri, String method, HttpURLConnectionClient client)

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
HttpURLConnectionClient	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	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

Methods inherited from class java.lang.Object

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

Methods inherited from interface oracle.stellent.ridc.common.http.RIDCHttpMethod

setFollowRedirects

Field Detail

serviceLog

protected ServiceLog serviceLog

requestConfig

protected IdcRequestConfig requestConfig

Constructor Detail

HttpURLConnectionMethod

protected HttpURLConnectionMethod(String uri,
                                  String method,
                                  HttpURLConnectionClient client)

Method Detail

addRequestHeader

public void addRequestHeader(String name,
                             String value)

Description copied from interface: RIDCHttpMethod

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,
                                           ProtocolException

Description copied from interface: RIDCHttpMethod

Get the response as a stream

Specified by:

getResponseBodyAsStream in interface RIDCHttpMethod

Returns:

the response stream

Throws:

IOException

ProtocolException

getResponseHeader

public RIDCHttpHeader getResponseHeader(String headerName)
                                 throws ProtocolException

Description copied from interface: RIDCHttpMethod

Get response header

Specified by:

getResponseHeader in interface RIDCHttpMethod

Returns:

Throws:

ProtocolException

getResponseHeaders

public List<RIDCHttpHeader> getResponseHeaders()
                                        throws ProtocolException

Description copied from interface: RIDCHttpMethod

Get all response headers

Specified by:

getResponseHeaders in interface RIDCHttpMethod

Returns:

list of headers

Throws:

ProtocolException

getStatusCode

public int getStatusCode()
                  throws ProtocolException

Description copied from interface: RIDCHttpMethod

Get the status code of the response

Specified by:

getStatusCode in interface RIDCHttpMethod

Returns:

Throws:

ProtocolException

getStatusLine

public String getStatusLine()
                     throws ProtocolException

Description copied from interface: RIDCHttpMethod

Get the status line of the response

Specified by:

getStatusLine in interface RIDCHttpMethod

Returns:

Throws:

ProtocolException

getURI

public URI getURI()
           throws URISyntaxException

Description copied from interface: RIDCHttpMethod

Get the uri of the request

Specified by:

getURI in interface RIDCHttpMethod

Returns:

Throws:

URISyntaxException

releaseConnection

public void releaseConnection()

Description copied from interface: RIDCHttpMethod

Release the connection

Specified by:

releaseConnection in interface RIDCHttpMethod

setCookiePolicy

public void setCookiePolicy(String policy)

Description copied from interface: RIDCHttpMethod

Set Cookie policy for this action

Specified by:

setCookiePolicy in interface RIDCHttpMethod

setParameter

public void setParameter(String param,
                         String value)

Description copied from interface: RIDCHttpMethod

Set request parameters

Specified by:

setParameter in interface RIDCHttpMethod

Parameters:

param - param name

value - param value

setQueryString

public void setQueryString(List<NameValuePair> paramList)

Description copied from interface: RIDCHttpMethod

Set the query string for the request

Specified by:

setQueryString in interface RIDCHttpMethod

setRequestHeader

public void setRequestHeader(String headerName,
                             String headerValue)

Description copied from interface: RIDCHttpMethod

Set the request header for the request

Specified by:

setRequestHeader in interface RIDCHttpMethod

getRidcClient

public HttpURLConnectionClient getRidcClient()

Description copied from interface: RIDCHttpMethod

Get the connection instance that this method is associated with

Specified by:

getRidcClient in interface RIDCHttpMethod

Returns:

execute

public int execute()
            throws IOException,
                   ProtocolException

Description copied from interface: RIDCHttpMethod

Execute the request

Specified by:

execute in interface RIDCHttpMethod

Returns:

status code of the response

Throws:

IOException

ProtocolException

setServiceLog

public void setServiceLog(ServiceLog serviceLog)

Description copied from interface: RIDCHttpMethod

Set the service log for the request

Specified by:

setServiceLog in interface RIDCHttpMethod

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