|
Sun Adapter for SAG API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface RemoteApis.RaSAG
It is for RA SAG APIs.
Nested Class Summary | |
---|---|
static interface |
RemoteApis.RaSAG.SAGLMAC
It is for SAG Local Message Authentication Code (LMAC) APIs. |
Method Summary | |
---|---|
void |
call()
Call |
void |
connect()
This function establishes the connection. |
void |
connect(java.lang.String args)
This function establishes the connection. |
void |
disconnect()
This function disconnects the connection but keeps the handle object. |
RemoteApis.RaSAG.SAGLMAC |
getLMAC()
Gets the SAG LMAC. |
SAGMessage |
getRequest()
Gets the request. |
SAGMessage |
getResponse()
Gets the response. |
long |
getToken()
Gets the token. |
void |
receiveAnyResponse()
Receive any response. |
void |
receiveAnyResponse(long timeout)
Receive any response. |
void |
receiveRequest()
Receive the request. |
void |
receiveRequest(long timeout)
Receive the request (long). |
void |
receiveResponse()
Receive response. |
void |
receiveResponse(long timeout)
Receive response. |
void |
sendError(long errorCode,
java.lang.String errorData)
Send the error. |
void |
sendRequest()
Send request. |
void |
sendResponse()
Send the response. |
void |
setRequest(SAGMessage request)
Sets the request. |
void |
setResponse(SAGMessage response)
Sets the response. |
void |
setToken(long token)
Sets the token. |
void |
subscribe()
This method establishes the subscription of a message partner to get its addressed server traffic. |
void |
subscribe(java.lang.String address)
This method establishes the subscription of a message partner to get its addressed server traffic. |
void |
subscribe(java.lang.String address,
java.lang.String arguments)
This method establishes the subscription of a message partner to get its addressed server traffic. |
void |
unsubscribe(java.lang.String address)
This method ends the subscription of a message partner. |
Method Detail |
---|
void connect() throws SAGApplicationException
SAGApplicationException
- on errorvoid connect(java.lang.String args) throws SAGApplicationException
args
- Argument passing for future use. Must be an empty string with SAG 6.0.0.
SAGApplicationException
- on errorvoid disconnect() throws SAGApplicationException
SAGApplicationException
- on errorvoid call() throws SAGApplicationException
Input : Request Output: Response
SAGApplicationException
- upon error.void sendRequest() throws SAGApplicationException
Input : Request Output: Token
SAGApplicationException
- upon error.void receiveResponse() throws SAGApplicationException
Input : Token Output: Response
SAGApplicationException
- upon error.void receiveResponse(long timeout) throws SAGApplicationException
Input : Token Output: Response
timeout
-
SAGApplicationException
- upon error.void receiveAnyResponse() throws SAGApplicationException
Input : None Output: Response, Token
SAGApplicationException
- upon error.void receiveAnyResponse(long timeout) throws SAGApplicationException
Input : None Output: Response, Token
timeout
-
SAGApplicationException
- upon error.void subscribe() throws SAGApplicationException
SAGApplicationException
- on errorvoid subscribe(java.lang.String address) throws SAGApplicationException
address
- Argument to set with the message partner name.
This name is used as the address of the server traffic of a message partner.
SAGApplicationException
- on errorvoid subscribe(java.lang.String address, java.lang.String arguments) throws SAGApplicationException
address
- Argument to set with the message partner name.
This name is used as the address of the server traffic of a message partner.arguments
- Argument passing of the subscription.
One important argument is the local message authentication code (LMAC),
needed to authenticate the subscription. This argument is only needed
if the message partner requires local authentication.
SAGApplicationException
- on errorvoid unsubscribe(java.lang.String address) throws SAGApplicationException
address
- Argument to set with the message partner name.
This name is used as the address of the server traffic of a message partner.
SAGApplicationException
- on errorvoid sendResponse() throws SAGApplicationException
Input : Token, Response Output: None
SAGApplicationException
- upon error.void receiveRequest() throws SAGApplicationException
Input : None Output: Token, Request
SAGApplicationException
- upon error.void receiveRequest(long timeout) throws SAGApplicationException
Input : None Output: Token, Request
timeout
-
SAGApplicationException
- upon error.void sendError(long errorCode, java.lang.String errorData) throws SAGApplicationException
Input : Token Output: None
errorCode
- Error Code (0: Local authentication; 1: No server business response)errorData
- Error data that can be given back.
SAGApplicationException
- upon error.long getToken()
long
- Returns token.
SAGMessage getRequest()
SAGMessage
- Returns SAGMessage.
SAGMessage getResponse()
SAGMessage
- Returns SAGMessage.
void setRequest(SAGMessage request) throws SAGApplicationException
request
-
SAGApplicationException
- upon error.void setResponse(SAGMessage response) throws SAGApplicationException
response
-
SAGApplicationException
- upon error.void setToken(long token) throws SAGApplicationException
token
-
SAGApplicationException
- upon error.RemoteApis.RaSAG.SAGLMAC getLMAC() throws SAGApplicationException
SAGLMAC
- Returns SAGLMAC.
SAGApplicationException
- upon error.
|
Sun Adapter for SAG API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |