Package oracle.stellent.ridc.common.http
Interface RIDCHttpMethod
- All Known Subinterfaces:
RIDCHttpGetMethod,RIDCHttpPostMethod
- All Known Implementing Classes:
HttpOracleGetMethod,HttpOracleMethod,HttpOraclePostMethod,HttpURLConnectionGetMethod,HttpURLConnectionMethod,HttpURLConnectionPostMethod
@Concealed
public interface RIDCHttpMethod
Generic interface for HTTP Methods/Actions (GET and POST)
-
Method Summary
Modifier and TypeMethodDescriptionvoidaddRequestHeader(String name, String value) Add a request headerintexecute()Execute the requestGet the response as a streamgetResponseHeader(String headerName) Get response headerGet all response headersGet the connection instance that this method is associated withintGet the status code of the responseGet the status line of the responsegetURI()Get the uri of the requestvoidRelease the connectionvoidsetCookiePolicy(String policy) Set Cookie policy for this actionvoidsetFollowRedirects(boolean followRedirects) Set the follow directs option for the connectionvoidsetParameter(String param, String value) Set request parametersvoidsetQueryString(List<NameValuePair> paramList) Set the query string for the requestvoidsetRequestConfig(IdcRequestConfig requestConfig) Set the request-specific config for the requestvoidsetRequestHeader(String headerName, String headerValue) Set the request header for the requestvoidsetServiceLog(ServiceLog serviceLog) Set the service log for the request
-
Method Details
-
addRequestHeader
Add a request header- Parameters:
name- the header namevalue- the header value
-
getResponseBodyAsStream
Get the response as a stream- Returns:
- the response stream
- Throws:
IOExceptionProtocolException
-
getResponseHeader
Get response header- Parameters:
headerName-- Returns:
- Throws:
ProtocolException
-
getResponseHeaders
Get all response headers- Returns:
- list of headers
- Throws:
ProtocolException
-
getStatusCode
Get the status code of the response- Returns:
- Throws:
ProtocolException
-
getStatusLine
Get the status line of the response- Returns:
- Throws:
ProtocolException
-
getURI
Get the uri of the request- Returns:
- Throws:
URISyntaxException
-
releaseConnection
void releaseConnection()Release the connection -
setCookiePolicy
Set Cookie policy for this action- Parameters:
policy-
-
setFollowRedirects
void setFollowRedirects(boolean followRedirects) Set the follow directs option for the connection- Parameters:
followRedirects-
-
setParameter
Set request parameters- Parameters:
param- param namevalue- param value
-
setQueryString
Set the query string for the request- Parameters:
paramList-
-
setRequestHeader
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
Execute the request- Returns:
- status code of the response
- Throws:
IOExceptionProtocolException
-
setServiceLog
Set the service log for the request- Parameters:
serviceLog-
-
setRequestConfig
Set the request-specific config for the request- Parameters:
requestConfig-
-