|
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.intradoc.HdaProtocol<TConnection>
public abstract class HdaProtocol<TConnection extends Connection>
Field Summary | |
---|---|
static java.lang.String |
BEGIN_HDA |
static java.lang.String |
BEGIN_HDA_NO_HEADER |
static java.lang.String |
CONTENT_LENGTH |
static java.lang.String |
CONTENT_LENGTH_HEADER |
static java.lang.String |
CONTENT_TYPE_HEADER |
static java.lang.String |
END_HDA |
static java.lang.String |
END_HEADER_LINE |
static java.lang.String |
END_HEADERS |
static java.lang.String |
END_MESSAGE |
static java.lang.String |
END_SERVER_HEADERS |
static java.lang.String |
HEADER_ENCODING_HEADER |
static java.lang.String |
HEADER_LINE |
static java.lang.String |
HTTP_HOST |
static java.lang.String |
HTTP_HOST_HEADER |
static java.lang.String |
IDC_FILE |
static java.lang.String |
IDC_HEADER_PREFIX |
static java.lang.String |
REMOTE_USER_HEADER |
static java.lang.String |
REQUEST_METHOD_HEADER |
static int |
RETRY_COUNT |
static java.lang.String |
USER_AGENT_HEADER |
Constructor Summary | |
---|---|
HdaProtocol(DataFactory dataFactory, ServiceRequest<TConnection> serviceRequest) Constructor |
Method Summary | |
---|---|
protected java.util.Map<java.lang.String,java.lang.String> |
getAdditionalHeaders(DataBinder binder) Returns a properties object with headers contained in binder. |
TConnection |
getConnection() |
DataFactory |
getDataFactory() |
java.lang.String |
getEncoding() |
java.lang.String |
getHeaderCharset() |
protected java.util.Map<java.lang.String,java.lang.String> |
getHeaders() The headers |
protected java.lang.String |
getHeadersAsString(java.util.Map<java.lang.String,java.lang.String> headerMap) Get all the headers in a hda-compliant (EOL seperated) string |
protected java.lang.String |
getHeaderString(boolean isMultiPart, long contentLength, java.util.Map<java.lang.String,java.lang.String> additionalHeaders) |
java.io.OutputStream |
getRequestStream() |
java.io.InputStream |
getResponseStream() |
ServiceRequest<TConnection> |
getServiceRequest() |
protected java.io.InputStream |
readHdaStream() Creates a stream to the next HDA message. |
protected boolean |
readHeaders() Read the headers (Http format) from the content server |
ServiceResponse |
readResponse() Reads the next message, if a message is not completely received within the timeout specified an exception is thrown. |
void |
setHeaderCharset(java.lang.String headerCharset) |
protected void |
writeMultipartRequest(java.util.Map<java.lang.String,java.lang.String> additionalHeaders) Special handling for the multipart message |
void |
writeRequest() Sends the specified message to the Content Server. |
protected void |
writeStandardRequest(java.util.Map<java.lang.String,java.lang.String> additionalHeaders) |
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 HEADER_ENCODING_HEADER
public static final java.lang.String CONTENT_TYPE_HEADER
public static final java.lang.String USER_AGENT_HEADER
public static final java.lang.String HTTP_HOST_HEADER
public static final java.lang.String CONTENT_LENGTH_HEADER
public static final java.lang.String REMOTE_USER_HEADER
public static final java.lang.String REQUEST_METHOD_HEADER
public static final java.lang.String IDC_HEADER_PREFIX
public static final java.lang.String END_HEADERS
public static final java.lang.String HEADER_LINE
public static final java.lang.String END_SERVER_HEADERS
public static final java.lang.String END_MESSAGE
public static final java.lang.String END_HEADER_LINE
public static final java.lang.String BEGIN_HDA
public static final java.lang.String BEGIN_HDA_NO_HEADER
public static final java.lang.String END_HDA
public static final java.lang.String HTTP_HOST
public static final int RETRY_COUNT
public static final java.lang.String CONTENT_LENGTH
public static final java.lang.String IDC_FILE
Constructor Detail |
---|
public HdaProtocol(DataFactory dataFactory, ServiceRequest<TConnection> serviceRequest)
dataFactory
- the data factoryserviceRequest
- the service requestMethod Detail |
---|
public DataFactory getDataFactory()
public ServiceRequest<TConnection> getServiceRequest()
public TConnection getConnection()
public java.io.InputStream getResponseStream() throws java.io.IOException
java.io.IOException
public java.io.OutputStream getRequestStream() throws java.io.IOException
java.io.IOException
public java.lang.String getHeaderCharset()
public void setHeaderCharset(java.lang.String headerCharset)
public java.lang.String getEncoding()
public void writeRequest() throws ProtocolException
writeRequest
in interface Protocol
ProtocolException
- If an error occurs during the send.public ServiceResponse readResponse() throws ProtocolException
readResponse
in interface Protocol
ProtocolException
- If an error occurs or timeout is reached.protected void writeStandardRequest(java.util.Map<java.lang.String,java.lang.String> additionalHeaders) throws java.io.IOException
additionalHeaders
-java.io.IOException
protected void writeMultipartRequest(java.util.Map<java.lang.String,java.lang.String> additionalHeaders) throws java.io.IOException
additionalHeaders
- additional headers to sendjava.io.IOException
protected java.util.Map<java.lang.String,java.lang.String> getAdditionalHeaders(DataBinder binder)
binder
- The binder to look for additional headers.protected java.lang.String getHeaderString(boolean isMultiPart, long contentLength, java.util.Map<java.lang.String,java.lang.String> additionalHeaders)
protected java.lang.String getHeadersAsString(java.util.Map<java.lang.String,java.lang.String> headerMap)
headerMap
- a header mapprotected boolean readHeaders() throws java.io.IOException
java.io.IOException
protected java.io.InputStream readHdaStream() throws java.io.IOException
java.io.IOException
- If an error occurs or timeout is reached.protected java.util.Map<java.lang.String,java.lang.String> getHeaders()
|
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 |