OPRO X Server Management Service API

net.opro.product.odcaw.api
Class OXSMSAsyncResponse

Object
  extended byAsyncResponse
      extended byOXSMSAsyncResponse
All Implemented Interfaces:
OXSMSResponse, Response

public abstract class OXSMSAsyncResponse
extends AsyncResponse
implements OXSMSResponse

This class is the return value of asynchronous method of OXSMSHandler and manages the process of OXSMS.
It is possible to get the status of the process, to get Request ID, to canel the process, to get the created document and more.

Version:
2.5.0.0
Author:
OPRO Japan Co.,Ltd. R&D Center
See Also:
OXSMSHandler.asyncCreate, OXSMSHandler.asyncPrint, OXSMSHandler.asyncFax, OXSMSHandler.asyncFaxA, OXSMSHandler.asyncFaxI, OXSMSHandler.asyncMail

Method Summary
 boolean containsAdditionalParameter(String name)
          Returns true when specified parameter is contained in parameters which are added by addAdditionalParameter.
 String[] getAdditionalParameter(String name)
          Returns value of specified parameter which is sent to OXSMS, added by addAdditionalParameter.
When specified parameter is not exists, returns null.
 String getAidParameter()
          Returns the request parameter name of Foreign Application ID which is set in OXSMSHandler.setAidParameter.
 String getAidValue()
          Returns Foreign Application ID which is set in OXSMSHandler.setAidValue.
 String getCommentParameter()
          Returns the request parameter name of Comment which is set in OXSMSHandler.setCommentParameter.
 String getCommentValue()
          Returns Comment which is set in OXSMSHandler.setCommentValue.
 InputStream getDocument()
          This is similar to AsyncResponse.getDocument.
 String getOXSAddress()
          Returns IP address of OXS that OXSMS actually uses.
 String getOXSAlias()
          Returns OXS Alias that OXSMS actually uses.
 String getOXSParameter()
          Returns the request parameter name of OXS Alias which is set in OXSMSHandler.setOXSParameter.
 int getOXSPort()
          Returns port number of OXS that OXSMS actually uses.
 String getOXSValue()
          Returns OXS Alias which is set in OXSMSHandler.setOXSValue.
 String getRequestID()
          Returns Request ID newly numbered for the request to OXSMS.
 String getRidParameter()
          Returns the request parameter name of Request ID which is set in OXSMSHandler.setRidParameter.
 String getRidValue()
          Returns Request ID which is set in OXSMSHandler.setRidValue.
 String getTCABParameter()
          Returns the request parameter name of Use Ricoh TrustyCabinet which is set in OXSMSHandler.setTCABParameter.
 boolean getTCABValue()
          Returns a boolean indicating whether or not Ricoh TrustyCabinet should be used.
 String getUidParameter()
          Returns the request parameter name of User ID which is set in OXSMSHandler.setUidParameter.
 String getUidValue()
          Returns User ID which is set in OXSMSHandler.setUidValue.
 
Methods inherited from class AsyncResponse
cancel, getAddress, getCancelUrl, getDocumentUrl, getLastStatus, getLastStatusMessage, getPID, getPort, getResult, getStatus, getStatusMessage, getStatusUrl
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface Response
getAddress, getDocumentUrl, getPort, getResult
 

Method Detail

getRequestID

public String getRequestID()
Description copied from interface: OXSMSResponse
Returns Request ID newly numbered for the request to OXSMS.

Specified by:
getRequestID in interface OXSMSResponse
Returns:
Request ID

getOXSAlias

public String getOXSAlias()
Description copied from interface: OXSMSResponse
Returns OXS Alias that OXSMS actually uses. This is equal to OXS Alias set in setOXSValue.

Specified by:
getOXSAlias in interface OXSMSResponse
Returns:
OXS Alias

getOXSAddress

public String getOXSAddress()
Description copied from interface: OXSMSResponse
Returns IP address of OXS that OXSMS actually uses. This is either of IP address of two or more OXS included in one OXS alias.

Specified by:
getOXSAddress in interface OXSMSResponse
Returns:
IP address of OXS that OXSMS actually uses

getOXSPort

public int getOXSPort()
Description copied from interface: OXSMSResponse
Returns port number of OXS that OXSMS actually uses. This is either of port number of two or more OXS included in one OXS alias.

Specified by:
getOXSPort in interface OXSMSResponse
Returns:
Port number of OXS that OXSMS actually uses

getAidValue

public String getAidValue()
Description copied from interface: OXSMSResponse
Returns Foreign Application ID which is set in OXSMSHandler.setAidValue.

Specified by:
getAidValue in interface OXSMSResponse
Returns:
Foreign Application ID
See Also:
OXSMSHandler.getAidValue

getCommentValue

public String getCommentValue()
Description copied from interface: OXSMSResponse
Returns Comment which is set in OXSMSHandler.setCommentValue.

Specified by:
getCommentValue in interface OXSMSResponse
Returns:
Comment
See Also:
OXSMSHandler.getCommentValue

getOXSValue

public String getOXSValue()
Description copied from interface: OXSMSResponse
Returns OXS Alias which is set in OXSMSHandler.setOXSValue.

Specified by:
getOXSValue in interface OXSMSResponse
Returns:
OXS Alias
See Also:
OXSMSHandler.getOXSValue

getRidValue

public String getRidValue()
Description copied from interface: OXSMSResponse
Returns Request ID which is set in OXSMSHandler.setRidValue.

Specified by:
getRidValue in interface OXSMSResponse
Returns:
Request ID
See Also:
OXSMSHandler.getRidValue

getTCABValue

public boolean getTCABValue()
Description copied from interface: OXSMSResponse
Returns a boolean indicating whether or not Ricoh TrustyCabinet should be used.

Specified by:
getTCABValue in interface OXSMSResponse
Returns:
a boolean indicating whether or not to use Ricoh TrustyCabinet
See Also:
OXSMSHandler.getTCABValue

getUidValue

public String getUidValue()
Description copied from interface: OXSMSResponse
Returns User ID which is set in OXSMSHandler.setUidValue.

Specified by:
getUidValue in interface OXSMSResponse
Returns:
User ID
See Also:
OXSMSHandler.getUidValue

getAidParameter

public String getAidParameter()
Description copied from interface: OXSMSResponse
Returns the request parameter name of Foreign Application ID which is set in OXSMSHandler.setAidParameter.

Specified by:
getAidParameter in interface OXSMSResponse
Returns:
the request parameter name of Foreign Application ID
See Also:
OXSMSHandler.getAidParameter

getCommentParameter

public String getCommentParameter()
Description copied from interface: OXSMSResponse
Returns the request parameter name of Comment which is set in OXSMSHandler.setCommentParameter.

Specified by:
getCommentParameter in interface OXSMSResponse
Returns:
the request parameter name of Comment
See Also:
OXSMSHandler.getCommentParameter

getOXSParameter

public String getOXSParameter()
Description copied from interface: OXSMSResponse
Returns the request parameter name of OXS Alias which is set in OXSMSHandler.setOXSParameter.

Specified by:
getOXSParameter in interface OXSMSResponse
Returns:
the request parameter name of OXS Alias
See Also:
OXSMSHandler.getOXSParameter

getRidParameter

public String getRidParameter()
Description copied from interface: OXSMSResponse
Returns the request parameter name of Request ID which is set in OXSMSHandler.setRidParameter.

Specified by:
getRidParameter in interface OXSMSResponse
Returns:
the request parameter name of Request ID
See Also:
OXSMSHandler.getRidParameter

getTCABParameter

public String getTCABParameter()
Description copied from interface: OXSMSResponse
Returns the request parameter name of Use Ricoh TrustyCabinet which is set in OXSMSHandler.setTCABParameter.

Specified by:
getTCABParameter in interface OXSMSResponse
Returns:
the request parameter name of Use Ricoh TrustyCabinet
See Also:
OXSMSHandler.getTCABParameter

getUidParameter

public String getUidParameter()
Description copied from interface: OXSMSResponse
Returns the request parameter name of User ID which is set in OXSMSHandler.setUidParameter.

Specified by:
getUidParameter in interface OXSMSResponse
Returns:
the request parameter name of User ID
See Also:
OXSMSHandler.getUidParameter

getAdditionalParameter

public String[] getAdditionalParameter(String name)
Description copied from interface: OXSMSResponse
Returns value of specified parameter which is sent to OXSMS, added by addAdditionalParameter.
When specified parameter is not exists, returns null.

Specified by:
getAdditionalParameter in interface OXSMSResponse
Parameters:
name - Name of parameter to get
Returns:
Value of parameter to be got
See Also:
addAdditionalParameter

containsAdditionalParameter

public boolean containsAdditionalParameter(String name)
Description copied from interface: OXSMSResponse
Returns true when specified parameter is contained in parameters which are added by addAdditionalParameter.

Specified by:
containsAdditionalParameter in interface OXSMSResponse
Parameters:
name - Name of parameter to check
Returns:
When parameter is contained in added paramters, returns true
See Also:
addAdditionalParameter

getDocument

public InputStream getDocument()
                                throws IOException
This is similar to AsyncResponse.getDocument.

Specified by:
getDocument in interface Response
Returns:
input stream to receive generated document
Throws:
IOException - if an error occurs during the document receiving

OPRO Japan Co.,Ltd.