|
Sun Adapter for Siebel EAI API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface ISiebelEAIHttpRequest
Object Type Definition for HTTP incoming requests for EAI transactions.
| Method Summary | |
|---|---|
int |
getHttpStatusCode()
Retrieve the HTTP response status code designated for this request. |
java.lang.String |
getRequestData()
Retrieve the request's data as a string, using the platform's default character set to construct the string content from the original (byte) content. |
java.lang.String |
getRequestData(java.lang.String charset)
Retrieve the request's data as a string, using the specified character set to construct the string content from the original (byte) content. |
java.io.ByteArrayInputStream |
getRequestDataByteInputStream()
Obtain a byte input stream object for the request's data. |
byte[] |
getRequestDataBytes()
Retrieve the 'raw' bytes of the request data. |
java.io.Reader |
getRequestDataReader()
Obtain a Reader (character stream) object for the request's data, using the default character set to translate the original (byte) content to character content. |
java.io.Reader |
getRequestDataReader(java.lang.String charset)
Obtain a Reader (character stream) object for the request's data, using the specified character set to translate the original (byte) content to character content. |
void |
respond()
Direct a HTTP response for the request to be sent now. |
void |
setHttpBadRequestStatusCode()
Indicate that the HTTP response for the request should be status code 400, to indicate that the request is 'bad' (e.g., syntactically or structurally incorrect). |
void |
setHttpInternalErrorStatusCode()
Indicate that the HTTP response for the request should be status code 500, to indicate the request could not be processed due to an internal error. |
void |
setHttpOkStatusCode()
Indicate that the HTTP response for the request should be status code 200, to indicate a successful request. |
void |
setHttpServiceNotAvailableStatusCode()
Indicate that the HTTP response for the request should be status code 503, to indicate a temporary inability to process the request. |
void |
setHttpStatusCode(int status)
Indicate the HTTP response status code to send back for the request. |
| Method Detail |
|---|
java.lang.String getRequestData()
java.lang.String getRequestData(java.lang.String charset)
throws java.io.UnsupportedEncodingException
charset - the name of a supported character set, for example,
US-ASCII and UTF-8.
java.io.UnsupportedEncodingException - if the named charset is not supported.java.io.Reader getRequestDataReader()
java.io.Reader getRequestDataReader(java.lang.String charset)
throws java.io.UnsupportedEncodingException
charset - the name of a supported character set, for example,
US-ASCII and UTF-8.
java.io.UnsupportedEncodingException - if the named charset is not supported.byte[] getRequestDataBytes()
java.io.ByteArrayInputStream getRequestDataByteInputStream()
void setHttpStatusCode(int status)
status - HTTP status code.int getHttpStatusCode()
setHttpStatusCode(int) et al. If
the status code has not been set, then implementations should
return a default status code.void setHttpOkStatusCode()
setHttpStatusCode(int)void setHttpServiceNotAvailableStatusCode()
setHttpStatusCode(int)void setHttpInternalErrorStatusCode()
setHttpStatusCode(int)void setHttpBadRequestStatusCode()
setHttpStatusCode(int)void respond()
If none of the setHttpStatusCode class of methods
(setHttpStatusCode(int), setHttpOkStatusCode(), etc) are
invoked prior to calling this method, then the implementation must
assume a default status code for use in the generated response.
|
Sun Adapter for Siebel EAI API | ||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||