|
Oracle® Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC) 11g Release 1 (11.1) E17274-04 |
|||||||||
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 String |
IDC_HTTP_METHOD |
static String |
IDC_VERSION |
Fields inherited from interface oracle.stellent.ridc.protocol.Protocol |
---|
IDC_HEADER_PREFIX |
Constructor Summary | |
---|---|
IdcHttpProtocol(ServiceRequest<IdcHttpClientConnection> serviceRequest, DataFactory dataFactory, IdcHttpClientConfig config) |
Method Summary | |
---|---|
protected void |
addRequestData(DataBinder binder, RIDCHttpMethod httpMethod) Set standard request headers, cookies and other info into the HTTP method. |
protected void |
addStringToBinder(String searchString, 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, List<NameValuePair> parameters) Execute an HTTP method against the content server that POSTs a binder in HDA format |
protected int |
executeStreamMethod(ServiceRequest<?> serviceRequest, List<NameValuePair> parameters) Execute a multipart POST method against the content server that uploads the given files. |
static Set<IdcContext.HttpAuthScheme> |
getAuthSchemes() |
IdcHttpClientConfig |
getClientConfig() |
IdcHttpClientConnection |
getConnection() |
DataFactory |
getDataFactory() |
protected List<NameValuePair> |
getDefaultParameters(ServiceRequest<?> serviceRequest) Create a list of the default NameValuePair parameters |
String |
getEncoding() |
IdcFilterManager |
getFilterManager() |
RIDCHttpClient |
getHttpClient() |
InputStream |
getInputStream() |
ServiceRequest<IdcHttpClientConnection> |
getServiceRequest() |
void |
logout() Best-effort Logout from Content Server |
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 |
setFilterManager(IdcFilterManager filterManager) |
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 String IDC_VERSION
public static final String IDC_HTTP_METHOD
Constructor Detail |
---|
public IdcHttpProtocol(ServiceRequest<IdcHttpClientConnection> serviceRequest, DataFactory dataFactory, IdcHttpClientConfig config)
Method Detail |
---|
public static 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 String getEncoding()
public IdcHttpClientConfig getClientConfig()
public IdcHttpClientConnection getConnection()
public RIDCHttpClient getHttpClient()
public InputStream getInputStream() throws IOException, ProtocolException
IOException
ProtocolException
public void setFilterManager(IdcFilterManager filterManager)
setFilterManager
in interface Protocol
public IdcFilterManager getFilterManager()
getFilterManager
in interface Protocol
public void writeRequest() throws ProtocolException
writeRequest
in interface Protocol
ProtocolException
public ServiceResponse readResponse() throws ProtocolException
readResponse
in interface Protocol
ProtocolException
public void logout() throws ProtocolException
Protocol
logout
in interface Protocol
ProtocolException
public int sendRequest() throws ProtocolException
ProtocolException
protected void addStringToBinder(String searchString, String htmlBody, DataBinder binder)
protected List<NameValuePair> getDefaultParameters(ServiceRequest<?> serviceRequest)
NameValuePair
parametersserviceRequest
- the requestprotected int executeStreamMethod(ServiceRequest<?> serviceRequest, List<NameValuePair> parameters) throws IOException, ProtocolException
serviceRequest
- the requestparameters
- the default parametersIOException
ProtocolException
protected int executeBinderMethod(ServiceRequest<?> serviceRequest, List<NameValuePair> parameters) throws IOException, ProtocolException
serviceRequest
- the service requestparameters
- the default parametersIOException
ProtocolException
protected void addRequestData(DataBinder binder, RIDCHttpMethod httpMethod)
binder
- (optional) the binderhttpMethod
- the http method to set the parameters
|
Oracle® Fusion Middleware Java API Reference for Oracle WebCenter Content Remote Intradoc Client (RIDC) 11g Release 1 (11.1) E17274-04 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |