|
Sun Adapter for SAG API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public static interface SAGApi.Services.FileActServer
It is server component for FileAct. It can do FileAct scenarios like get file, put file, etc. It constructs the responses by use of Configuration. It populates the requests to corresponding Primitives.
Method Summary | |
---|---|
void |
abortFile(java.lang.String transferKey)
Aborts the file transfer which is against the last get/put/fetch. |
void |
abortFile(java.lang.String transferRef,
java.lang.String transferKey)
Aborts the file transfer with the specified transfer reference. |
void |
ackFile(boolean accepted)
Acks the previously-received file. |
java.lang.String |
checkFileStatus()
Checks the state for the file transfer which is against the last get/put/fetch. |
java.lang.String |
checkFileStatus(java.lang.String transferRef)
Checks the state for the file transfer with the specified transfer reference. |
java.lang.String |
checkFinalFileStatus()
Checks the final state for the file transfer which is against the last get/put/fetch. |
java.lang.String |
checkFinalFileStatus(java.lang.String transferRef)
Checks the final state for the file transfer with the specified transfer reference. |
java.lang.String |
checkFinalFileStatus(java.lang.String transferRef,
long interval,
int count)
Checks the final state for the file transfer with the specified transfer reference. |
java.lang.String |
checkSnFStatus()
Checks SnF status for the SnF session which is from the last acquire. |
java.lang.String |
checkSnFStatus(java.lang.String snfSession)
Checks SnF status for the specified SnF session. |
java.lang.String |
computeFileDigest(java.lang.String physicalFileFullName)
Computes File Digest locally using TransferEP from configuration if it exists. |
java.lang.String |
computeFileDigest(java.lang.String physicalFileFullName,
java.lang.String transferEP)
Computes File Digest locally using specified TransferEP. |
SAGMessage |
getRequest()
Gets the current request message. |
java.lang.String |
getResponse()
Returns the current Response message which will be sent out. |
SAGMessage.SAGEnvelope |
getResponseEnvelope()
Returns SAG envelope of the current Response message which will be sent out. |
java.lang.String |
getResponseLetter()
Returns letter of the current Response message which will be sent out. |
long |
getToken()
Returns the token number for current transfer. |
boolean |
isHandleFileEventRequestReceived()
Checks whether the request received on receiveRequest() is Sw:HandleFileEventRequest. |
boolean |
isHandleFileRequestReceived()
Checks whether the request received on receiveRequest() is Sw:HandleFileRequest. |
boolean |
isHandleInitRequestReceived()
Checks whether the request received on receiveRequest() is Sw:HandleInitRequest. |
boolean |
isHandleRequestReceived()
Checks whether the request received on receiveRequest() is SwInt:HandleRequest. |
boolean |
isHandleSnFRequestReceived()
Checks whether the request received on receiveRequest() is Sw:HandleSnFRequest. |
boolean |
isHandleTermRequestReceived()
Checks whether the request received on receiveRequest() is Sw:HandleTermRequest. |
boolean |
isNoRequestReceived()
Checks whether no request is received on receiveRequest() - timeout happens. |
boolean |
isRemoteFileHandlerAlive()
Checks whether Remote File Handler process is alive. |
java.lang.String |
listFileStatus()
It allows for several selection criteria. |
void |
process(long token)
Analyzes the received request and prepares the response accordingly for the message transfer associated with the specified token. |
void |
processHandleFileEventRequest(long token)
Processes the request Sw:HandleFileEventRequest. |
void |
processHandleFileRequest(long token)
Processes the request Sw:HandleFileRequest. |
void |
processHandleInitRequest(long token)
Processes the request Sw:HandleInitRequest. |
void |
processHandleRequest(long token)
Processes the request message SwInt:HandleRequest. |
void |
processHandleSnFRequest(long token)
Processes the request Sw:HandleSnFRequest. |
void |
processHandleTermRequest(long token)
Processes the request Sw:HandleTermRequest. |
long |
receiveRequest()
Receives the request message. |
void |
sendError(long token,
long errorCode,
java.lang.String errorData)
Sends error with the specified token, error code, error data. |
void |
sendError(long errorCode,
java.lang.String errorData)
Sends error with the specified error code, error data. |
void |
sendHandleFileEventResponse(long token)
Sends the response message Sw:HandleFileEventResponse. |
void |
sendHandleFileResponse(long token)
Sends the response message Sw:HandleFileResponse. |
void |
sendHandleInitResponse(long token)
Sends the response message Sw:HandleInitResponse. |
void |
sendHandleResponse(long token)
Sends the response message SwInt:HandleResponse. |
void |
sendHandleSnFResponse(long token)
Sends the response message Sw:HandleSnFResponse. |
void |
sendHandleTermResponse(long token)
Sends the response message Sw:HandleTermResponse. |
void |
sendResponse(long token)
Sends out the current response message with the specified token number. |
void |
snfAck()
Acks the previously-fetched file or previously-handled message in current SnF session. |
void |
snfAck(java.lang.String acceptStatus)
Acks the previously-fetched file or previously-handled message in current SnF session with specified accept status. |
java.lang.String |
snfAcquire()
Acquires SnF queue and opens a SnF session. |
java.lang.String |
snfFetch()
Fetches the file from SnF central server in current SnF session. |
void |
snfRelease()
Releases SnF queue and closes the SnF session which corresponds to the last acquire. |
void |
snfRelease(java.lang.String sessionId)
Releases SnF queue and closes the SnF session. |
java.lang.String |
startRemoteFileHandler()
Starts Remote File Handler process with e*Way interlly assigned Transfer EndPoint. |
void |
startRemoteFileHandler(java.lang.String transferEP)
Starts Remote File Handler process with the specified Transfer EndPoint. |
void |
stopRemoteFileHandler()
Stops the Remote File Handler process which is started from this e*Way instance. |
java.lang.String |
subscribeFileEvent()
Subscribes file transfer event with e*Way assigned event endpoint. |
void |
subscribeFileEvent(java.lang.String eventEP)
Subscribes file transfer event with the specified event endpoint. |
Method Detail |
---|
void process(long token) throws SAGApplicationException
token
- Token number
SAGApplicationException
- upon error.long receiveRequest() throws SAGApplicationException
SAGApplicationException
- upon error.void processHandleRequest(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void sendHandleResponse(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void processHandleSnFRequest(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void sendHandleSnFResponse(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void processHandleFileRequest(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void sendHandleFileResponse(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void processHandleFileEventRequest(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void sendHandleFileEventResponse(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void processHandleInitRequest(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void sendHandleInitResponse(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void processHandleTermRequest(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.void sendHandleTermResponse(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.boolean isNoRequestReceived()
boolean isHandleTermRequestReceived()
boolean isHandleInitRequestReceived()
boolean isHandleFileEventRequestReceived()
boolean isHandleSnFRequestReceived()
boolean isHandleFileRequestReceived()
boolean isHandleRequestReceived()
java.lang.String subscribeFileEvent() throws SAGApplicationException
SAGApplicationException
- upon error.void subscribeFileEvent(java.lang.String eventEP) throws SAGApplicationException
eventEP
- The event endpoint
SAGApplicationException
- upon error.void ackFile(boolean accepted) throws SAGApplicationException
accepted
- true or false
SAGApplicationException
- upon error.java.lang.String snfAcquire() throws SAGApplicationException
String
- Returns the SnF session ID.
SAGApplicationException
- upon error.void snfRelease() throws SAGApplicationException
SAGApplicationException
- upon error.void snfRelease(java.lang.String sessionId) throws SAGApplicationException
SnF
- SessionId to release.
SAGApplicationException
- upon error.void snfAck() throws SAGApplicationException
SAGApplicationException
- upon error.void snfAck(java.lang.String acceptStatus) throws SAGApplicationException
acceptStatus
- The accept status.
SAGApplicationException
- upon error.java.lang.String snfFetch() throws SAGApplicationException
String
- Returns the transfer reference, or returns null when the current session is Closed or TimedOut.
SAGApplicationException
- upon error.java.lang.String checkSnFStatus(java.lang.String snfSession) throws SAGApplicationException
snfSession
- SnF session Id
String
- Returns the SnF status.
SAGApplicationException
- upon error.java.lang.String checkSnFStatus() throws SAGApplicationException
String
- Returns the SnF status.
SAGApplicationException
- upon error.java.lang.String checkFileStatus(java.lang.String transferRef) throws SAGApplicationException
In progress: INITIATED ACCEPTED ONGOING Final state: COMPLETED DUPLICATED UNKNOWN ABORTED FAILED REJECTED
transferRef
- File transfer reference.
String
- Returns the file transfer status.
SAGApplicationException
- upon error.java.lang.String checkFileStatus() throws SAGApplicationException
In progress: INITIATED ACCEPTED ONGOING Final state: COMPLETED DUPLICATED UNKNOWN ABORTED FAILED REJECTED
String
- Returns the file transfer status.
SAGApplicationException
- upon error.java.lang.String checkFinalFileStatus(java.lang.String transferRef, long interval, int count) throws SAGApplicationException
The final state is one of following: - COMPLETED - DUPLICATED - UNKNOWN - ABORTED - FAILED - REJECTED
transferRef
- File transfer referenceinterval
- Check intervalcount
- Check maximum count
String
- Returns the file transfer status.
SAGApplicationException
- upon error.java.lang.String checkFinalFileStatus(java.lang.String transferRef) throws SAGApplicationException
The final state is one of following: - COMPLETED - DUPLICATED - UNKNOWN - ABORTED - FAILED - REJECTED
transferRef
- File transfer reference
String
- Returns the file transfer status.
SAGApplicationException
- upon error.java.lang.String checkFinalFileStatus() throws SAGApplicationException
The final state is one of following: - COMPLETED - DUPLICATED - UNKNOWN - ABORTED - FAILED - REJECTED
String
- Returns the file transfer status.
SAGApplicationException
- upon error.java.lang.String listFileStatus() throws SAGApplicationException
String
- Returns Sw:EndOfList. TRUE or FALSE to indicate whether the end of the list has been reached.
SAGApplicationException
- upon error.void abortFile(java.lang.String transferRef, java.lang.String transferKey) throws SAGApplicationException
transferRef
- File transfer reference.transferRef
- File transfer key.
SAGApplicationException
- upon error.void abortFile(java.lang.String transferKey) throws SAGApplicationException
transferRef
- File transfer key.
SAGApplicationException
- upon error.java.lang.String computeFileDigest(java.lang.String physicalFileFullName) throws SAGApplicationException
physicalFileFullName
- The file to be computed
String
- Returns the File Digest.
SAGApplicationException
- upon error.com.stc.connector.sagadapter.sagapi.SAGApi.Services.FileActClient#computeFileDigest()
java.lang.String computeFileDigest(java.lang.String physicalFileFullName, java.lang.String transferEP) throws SAGApplicationException
physicalFileFullName
- The file to be computedtransferEP
- The file transfer endpoint.
String
- Returns the File Digest.
SAGApplicationException
- upon error.com.stc.connector.sagadapter.sagapi.SAGApi.Services.FileActClient#computeFileDigest()
boolean isRemoteFileHandlerAlive()
java.lang.String startRemoteFileHandler() throws SAGApplicationException
SAGApplicationException
- upon error.void startRemoteFileHandler(java.lang.String transferEP) throws SAGApplicationException
SAGApplicationException
- upon error.void stopRemoteFileHandler() throws SAGApplicationException
SAGApplicationException
- upon error.void sendError(long token, long errorCode, java.lang.String errorData) throws SAGApplicationException
token
- The token number.errorCode
- The error code, eg. 0 - Local Authentication Error; 1 - No Server Business Response.errorData
- The error data.
SAGApplicationException
- upon error.void sendError(long errorCode, java.lang.String errorData) throws SAGApplicationException
errorCode
- The error code, eg. 0 - Local Authentication Error; 1 - No Server Business Response.errorData
- The error data.
SAGApplicationException
- upon error.void sendResponse(long token) throws SAGApplicationException
token
- The token number along with the transfer.
SAGApplicationException
- upon error.SAGMessage getRequest()
SAGMessage
- Returns the SAG message.
long getToken()
java.lang.String getResponse()
SAGMessage.SAGEnvelope getResponseEnvelope()
java.lang.String getResponseLetter()
|
Sun Adapter for SAG API | |||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |