|
Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference 11g Release 1 (11.1.1) E17274-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object
oracle.stellent.ridc.protocol.http.IdcHttpProtocol
public class IdcHttpProtocol
Field Summary | |
---|---|
static java.lang.String |
IDC_HEADER_PREFIX |
static java.lang.String |
IDC_HTTP_METHOD |
static java.lang.String |
IDC_VERSION |
Constructor Summary | |
---|---|
IdcHttpProtocol(ServiceRequest<IdcHttpClientConnection> serviceRequest, DataFactory dataFactory, IdcHttpClientConfig config) |
Method Summary | |
---|---|
protected void |
addRequestData(DataBinder binder, org.apache.commons.httpclient.HttpMethod httpMethod) Set standard request headers, cookies and other info into the HTTP method. |
protected void |
addStringToBinder(java.lang.String searchString, java.lang.String htmlBody, DataBinder binder) |
static AuthenticationHandler |
createAuthHandler(IdcContext.HttpAuthScheme authScheme, IdcHttpProtocol httpProtocol) Retrieve the authentication handler associated with the given authentication scheme |
protected int |
executeBinderMethod(ServiceRequest serviceRequest, java.util.List<org.apache.commons.httpclient.NameValuePair> parameters) Execute an HTTP method against the content server that POSTs a binder in HDA format |
protected int |
executeStreamMethod(ServiceRequest serviceRequest, java.util.List<org.apache.commons.httpclient.NameValuePair> parameters) Execute a multipart POST method against the content server that uploads the given files. |
static java.util.Set<IdcContext.HttpAuthScheme> |
getAuthSchemes() |
IdcHttpClientConfig |
getClientConfig() |
IdcHttpClientConnection |
getConnection() |
DataFactory |
getDataFactory() |
protected java.util.List<org.apache.commons.httpclient.NameValuePair> |
getDefaultParameters(ServiceRequest serviceRequest) Create a list of the default NameValuePair parameters |
java.lang.String |
getEncoding() |
org.apache.commons.httpclient.HttpClient |
getHttpClient() |
java.io.InputStream |
getInputStream() |
ServiceRequest<IdcHttpClientConnection> |
getServiceRequest() |
ServiceResponse |
readResponse() Reads the next message, if a message is not completely received within the timeout specified an exception is thrown. |
int |
sendRequest() Send the request to the Content Server; used internally by the AuthHandler implementations |
void |
writeRequest() Write the request to the Content Server |
Methods inherited from class java.lang.Object |
---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static final java.lang.String IDC_HEADER_PREFIX
public static final java.lang.String IDC_VERSION
public static final java.lang.String IDC_HTTP_METHOD
Constructor Detail |
---|
public IdcHttpProtocol(ServiceRequest<IdcHttpClientConnection> serviceRequest, DataFactory dataFactory, IdcHttpClientConfig config)
Method Detail |
---|
public static java.util.Set<IdcContext.HttpAuthScheme> getAuthSchemes()
public static AuthenticationHandler createAuthHandler(IdcContext.HttpAuthScheme authScheme, IdcHttpProtocol httpProtocol) throws ProtocolException
authScheme
- the auth schemehttpProtocol
- the http protocol to initialize the auth handlerProtocolException
public DataFactory getDataFactory()
public ServiceRequest<IdcHttpClientConnection> getServiceRequest()
public java.lang.String getEncoding()
public IdcHttpClientConfig getClientConfig()
public IdcHttpClientConnection getConnection()
public org.apache.commons.httpclient.HttpClient getHttpClient()
public java.io.InputStream getInputStream() throws java.io.IOException
java.io.IOException
public void writeRequest() throws ProtocolException
writeRequest
in interface Protocol
ProtocolException
public ServiceResponse readResponse() throws ProtocolException
readResponse
in interface Protocol
ProtocolException
public int sendRequest() throws ProtocolException
ProtocolException
protected void addStringToBinder(java.lang.String searchString, java.lang.String htmlBody, DataBinder binder)
protected java.util.List<org.apache.commons.httpclient.NameValuePair> getDefaultParameters(ServiceRequest serviceRequest)
NameValuePair
parametersserviceRequest
- the requestprotected int executeStreamMethod(ServiceRequest serviceRequest, java.util.List<org.apache.commons.httpclient.NameValuePair> parameters) throws java.io.IOException
serviceRequest
- the requestparameters
- the default parametersjava.io.IOException
protected int executeBinderMethod(ServiceRequest serviceRequest, java.util.List<org.apache.commons.httpclient.NameValuePair> parameters) throws java.io.IOException
serviceRequest
- the service requestparameters
- the default parametersjava.io.IOException
protected void addRequestData(DataBinder binder, org.apache.commons.httpclient.HttpMethod httpMethod)
binder
- (optional) the binderhttpMethod
- the http method to set the parameters
|
Oracle® Fusion Middleware Remote Intradoc Client (RIDC) Java API Reference 11g Release 1 (11.1.1) E17274-01 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |