OPRO X Server Management Service API

net.opro.product.odcaw.api
Class OXSMSHandler

Object
  extended byOXSHandler
      extended byOXSMSHandler

public class OXSMSHandler
extends OXSHandler

This is the main class of OPRO X Server Management Service Application Program Interface.
This class requests document generation etc. using OXSMS.
This class can be used as substitution of OXSHandler of OPRO X Server Application Program Interface.
You can request OXSMS by almost the same interface as OXSHandler.
And, the following interfaces only for OPRO X Server Management Service are added.

acquireDocument
Acquires document that is stored by OXSMS which this OXSMSHandler refers to.
deleteLog
deleteLogs
Delets log that is stored by OXSMS which this OXSMSHandler refers to.
getLog
getLogByApplicationID
Acquires log that is stored by OXSMS which this OXSMSHandler refers to.
set*Parameter
get*Parameter
Sets or gets request parameter name that send to OXSMS.
set*Value
get*Value
Sets or gets request value that send to OXSMS.
*AdditionalParameter
Sets or gets additional request parameters that send to OXSMS.

Version:
2.5.0.0
Author:
OPRO Japan Co.,Ltd. R&D Center

Field Summary
 
Fields inherited from class OXSHandler
FORMAT_HTML, FORMAT_OPR, FORMAT_OXR, FORMAT_PDF, FORMAT_XDW, STATUS_CANCEL, STATUS_COMPLETE, STATUS_ERROR, STATUS_GENERATED, STATUS_GENERATING
 
Constructor Summary
OXSMSHandler(String url)
          Constructs a OXSMSHandler which handles OXSMS using specified URL.
 
Method Summary
 OXSMSAcquireResponse acquireDocument()
          Acquires document that is stored by OXSMS which this OXSMSHandler refers to.
Before calling this method, it is necessary to set Request ID (if omitting User ID is not allowed by setting of OXSMS, it is necessary to set User ID).
User ID, Foreign Application ID and Comment are also sent to OXSMS.
The returning value is an instance of OXSMSAcquireResponse.
 void addAdditionalParameter(String name, String value)
          Adds undefined parameters to send to OXSMS.
This provides method to send parameters not defined to OXSMS, when OXSMS which this OXSMSHandler refers to is customized OXSMS.
 AsyncResponse asyncCreate(OXSParameter Parameter)
          This is similar to OXSHandler.asyncCreate.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.
 AsyncResponse asyncFax(OXSParameter Parameter)
          This is similar to OXSHandler.asyncFax.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.
 AsyncResponse asyncFaxA(OXSParameter Parameter)
          This is similar to OXSHandler.asyncFaxA.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.
 AsyncResponse asyncFaxI(OXSParameter Parameter)
          This is similar to OXSHandler.asyncFaxI.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.
 AsyncResponse asyncMail(OXSParameter Parameter)
          This is similar to OXSHandler.asyncMail.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.
 AsyncResponse asyncPrint(OXSParameter Parameter)
          This is similar to OXSHandler.asyncPrint.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.
 AsyncResponse asyncPXC(OXSParameter Parameter)
          This is similar to asyncPrint, but PrintXchange is used when printing.
 void clearAdditionalParameter()
          Deletes all parameters which is added by addAdditionalParameter.
 boolean containsAdditionalParameter(String name)
          Returns true when specified parameter is contained in parameters which are added by addAdditionalParameter.
 void deleteLog(String id, String password)
          Deletes log that is stored by OXSMS which this OXSMSHandler refers to using Request ID.
Before calling this method, it is necessary to set Request ID.
 void deleteLogs(String[] requestIds, String id, String password)
          Deletes logs that is stored by OXSMS which this OXSMSHandler refers to using specified Request ID.
Request ID is exceptionally specified in this method at the call.
 String[] getAdditionalParameter(String name)
          Returns value of specified parameter which is added by addAdditionalParameter.
When specified parameter is not exists, returns null.
 String getAddress()
          Returns the URL of OXSMS servlet which this OXSMSHandler refers to.
This URL is passed to the constructor.
 String getAidParameter()
          Returns the request parameter name of Foreign Application ID which is set in setAidParameter.
 String getAidValue()
          Returns Foreign Application ID which is set in setAidValue.
 String getCommentParameter()
          Returns the request parameter name of Comment which is set in setCommentParameter.
 String getCommentValue()
          Returns Comment which is set in setCommentValue.
 OXSMSLogResponse getLog()
          Acquires log that is stored by OXSMS which this OXSMSHandler refers to using Request ID.
Before calling this method, it is necessary to set Request ID.
User ID is also sent to OXSMS.
The returning value is an instance of OXSMSLogResponse.
 OXSMSLogResponse getLogByApplicationID()
          Acquires log that is stored by OXSMS which this OXSMSHandler refers to using Foreign Application ID.
Before calling this method, it is necessary to set Foreign Application ID.
User ID is also sent to OXSMS.
The returning value is an instance of OXSMSLogResponse.
 String getOXSMSVersion()
          Returns the version number of OXSMS which this OXSMSHandler refers to.
 String getOXSParameter()
          Returns the request parameter name of OXS Alias which is set in setOXSParameter.
 String getOXSValue()
          Returns OXS Alias which is set in setOXSValue.
 int getPort()
          Returns always zero.
 String getRidParameter()
          Returns the request parameter name of Request ID which is set in setRidParameter.
 String getRidValue()
          Returns Request ID which is set in setRidValue.
 String getTCABParameter()
          Returns the request parameter name of Use Ricoh TrustyCabinet which is set in 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 setUidParameter.
 String getUidValue()
          Returns User ID which is set in setUidValue.
 String[] removeAdditionalParameter(String name)
          Deletes specified parameter which is added by addAdditionalParameter.
When specified parameter is not exists, returns null.
 void setAidParameter(String value)
          Sets the request parameter name of Foreign Application ID sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.
 void setAidValue(String value)
          Sets Foreign Application ID.
 void setCommentParameter(String value)
          Sets the request parameter name of Comment sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.
 void setCommentValue(String value)
          Sets Comment.
 void setOXSParameter(String value)
          Sets the request parameter name of OXS Alias sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.
 void setOXSValue(String value)
          Sets OXS Alias.
If this is not specified, the alias configured as default in OXSMS will be used.
 void setRidParameter(String value)
          Sets the request parameter name of Request ID sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.
 void setRidValue(String value)
          Sets Request ID.
 void setTCABParameter(String value)
          Sets the request parameter name of Use Ricoh TrustyCabinet sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.
 void setTCABValue(boolean value)
          Sets whether Ricoh TrustyCabinet should be used.
 void setUidParameter(String value)
          Sets the request parameter name of User ID sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.
 void setUidValue(String value)
          Sets User ID.
 SyncResponse syncCreate(OXSParameter Parameter)
          This is similar to OXSHandler.syncCreate.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.
 SyncResponse syncFax(OXSParameter Parameter, long PollingInterval)
          This is similar to OXSHandler.syncFax.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.
 SyncResponse syncFaxA(OXSParameter Parameter, long PollingInterval)
          This is similar to OXSHandler.syncFaxA.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.
 SyncResponse syncFaxI(OXSParameter Parameter, long PollingInterval)
          This is similar to OXSHandler.syncFaxI.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.
 SyncResponse syncMail(OXSParameter Parameter, long PollingInterval)
          This is similar to OXSHandler.syncMail.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.
 SyncResponse syncPrint(OXSParameter Parameter, long PollingInterval)
          This is similar to OXSHandler.syncPrint.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.
 SyncResponse syncPXC(OXSParameter Parameter, long PollingInterval)
          This is similar to syncPrint, but PrintXchange is used when printing.
 
Methods inherited from class OXSHandler
createDocument, getCreateQueryString, getDocument, getDocumentQueryString, getFaxDevices, getFaxQueryString, getFaxServers, getMailDevices, getMailQueryString, getMailServers, getOXSVersion, getPrintDevices, getPrintQueryString, getPrintServers, isAlive, reconnectDatabase
 
Methods inherited from class Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

OXSMSHandler

public OXSMSHandler(String url)
             throws MalformedURLException
Constructs a OXSMSHandler which handles OXSMS using specified URL. Connection with OXSMS is not made in this stage.

Parameters:
url - the URL of OXSMS servlet which this OXSMSHandler refers to
Throws:
MalformedURLException - if url is malformed
See Also:
getAddress
Method Detail

setRidValue

public void setRidValue(String value)
Sets Request ID.

Parameters:
value - Request ID
See Also:
setRidParameter

getRidValue

public String getRidValue()
Returns Request ID which is set in setRidValue.

Returns:
Request ID

setUidValue

public void setUidValue(String value)
Sets User ID.

Parameters:
value - User ID
See Also:
setUidParameter

getUidValue

public String getUidValue()
Returns User ID which is set in setUidValue.

Returns:
User ID

setAidValue

public void setAidValue(String value)
Sets Foreign Application ID.

Parameters:
value - Foreign Application ID
See Also:
setAidParameter

getAidValue

public String getAidValue()
Returns Foreign Application ID which is set in setAidValue.

Returns:
Foreign Application ID

setOXSValue

public void setOXSValue(String value)
Sets OXS Alias.
If this is not specified, the alias configured as default in OXSMS will be used.

Parameters:
value - OXS Alias
See Also:
setOXSParameter

getOXSValue

public String getOXSValue()
Returns OXS Alias which is set in setOXSValue.

Returns:
OXS Alias

setCommentValue

public void setCommentValue(String value)
Sets Comment.

Parameters:
value - Comment
See Also:
setCommentParameter

getCommentValue

public String getCommentValue()
Returns Comment which is set in setCommentValue.

Returns:
Comment

setTCABValue

public void setTCABValue(boolean value)
Sets whether Ricoh TrustyCabinet should be used.

Parameters:
value - a boolean indicating whether or not to use Ricoh TrustyCabinet
See Also:
setTCABParameter

getTCABValue

public boolean getTCABValue()
Returns a boolean indicating whether or not Ricoh TrustyCabinet should be used.

Returns:
a boolean indicating whether or not to use Ricoh TrustyCabinet

setRidParameter

public void setRidParameter(String value)
Sets the request parameter name of Request ID sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.

Parameters:
value - the request parameter name of Request ID
See Also:
setRidValue

getRidParameter

public String getRidParameter()
Returns the request parameter name of Request ID which is set in setRidParameter.

Returns:
the request parameter name of Request ID

setUidParameter

public void setUidParameter(String value)
Sets the request parameter name of User ID sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.

Parameters:
value - the request parameter name of User ID
See Also:
setUidValue

getUidParameter

public String getUidParameter()
Returns the request parameter name of User ID which is set in setUidParameter.

Returns:
the request parameter name of User ID

setAidParameter

public void setAidParameter(String value)
Sets the request parameter name of Foreign Application ID sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.

Parameters:
value - the request parameter name of Foreign Application ID
See Also:
setAidValue

getAidParameter

public String getAidParameter()
Returns the request parameter name of Foreign Application ID which is set in setAidParameter.

Returns:
the request parameter name of Foreign Application ID

setOXSParameter

public void setOXSParameter(String value)
Sets the request parameter name of OXS Alias sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.

Parameters:
value - the request parameter name of OXS Alias
See Also:
setOXSValue

getOXSParameter

public String getOXSParameter()
Returns the request parameter name of OXS Alias which is set in setOXSParameter.

Returns:
the request parameter name of OXS Alias

setCommentParameter

public void setCommentParameter(String value)
Sets the request parameter name of Comment sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.

Parameters:
value - the request parameter name of Comment
See Also:
setCommentValue

getCommentParameter

public String getCommentParameter()
Returns the request parameter name of Comment which is set in setCommentParameter.

Returns:
the request parameter name of Comment

setTCABParameter

public void setTCABParameter(String value)
Sets the request parameter name of Use Ricoh TrustyCabinet sent to OXSMS.
It is necessary to specify the same value as the setting of OXSMS.

Parameters:
value - the request parameter name of Use Ricoh TrustyCabinet
See Also:
setTCABValue

getTCABParameter

public String getTCABParameter()
Returns the request parameter name of Use Ricoh TrustyCabinet which is set in setTCABParameter.

Returns:
the request parameter name of Use Ricoh TrustyCabinet

acquireDocument

public OXSMSAcquireResponse acquireDocument()
                                     throws IOException,
                                            OXSAPIException
Acquires document that is stored by OXSMS which this OXSMSHandler refers to.
Before calling this method, it is necessary to set Request ID (if omitting User ID is not allowed by setting of OXSMS, it is necessary to set User ID).
User ID, Foreign Application ID and Comment are also sent to OXSMS.
The returning value is an instance of OXSMSAcquireResponse. And this is used for getting document.

This is equivalent to
DO=ex&OP=dl&RID=requestid&...&ES=oxsms
in HTTP request.

Returns:
an instance of OXSMSAcquireResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS
See Also:
setRidValue, setUidValue, setAidValue, setCommentValue

deleteLog

public void deleteLog(String id,
                      String password)
               throws IOException,
                      OXSAPIException
Deletes log that is stored by OXSMS which this OXSMSHandler refers to using Request ID.
Before calling this method, it is necessary to set Request ID.

This is equivalent to
DO=rm&RID=requestid&AI=id&AP=password&ES=oxsms
in HTTP request.

Parameters:
id - ID of High Permission Administrator
password - Password of High Permission Administrator
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS
See Also:
setRidValue, deleteLogs

deleteLogs

public void deleteLogs(String[] requestIds,
                       String id,
                       String password)
                throws IOException,
                       OXSAPIException
Deletes logs that is stored by OXSMS which this OXSMSHandler refers to using specified Request ID.
Request ID is exceptionally specified in this method at the call. Request ID which is set in setRidValue is not used.

This is equivalent to
DO=rm&RID=requestid1[&RID=requestid2...]&AI=id&AP=password&ES=oxsms
in HTTP request.

Parameters:
requestIds - array of Request ID for deletion of logs
id - ID of High Permission Administrator
password - Password of High Permission Administrator
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS
See Also:
deleteLog

getLog

public OXSMSLogResponse getLog()
                        throws IOException,
                               OXSAPIException
Acquires log that is stored by OXSMS which this OXSMSHandler refers to using Request ID.
Before calling this method, it is necessary to set Request ID.
User ID is also sent to OXSMS.
The returning value is an instance of OXSMSLogResponse. And this is used for getting contents of log.

This is equivalent to
DO=st&RID=requestid&ES=oxsms
in HTTP request.

OXSMS uses JSP file which is specified in setting of "Log Response" for response.

Returns:
an instance of OXSMSLogResponse which shows contents of log
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS
See Also:
OXSMSLogResponse, setRidValue, setUidValue, getLogByApplicationID

getLogByApplicationID

public OXSMSLogResponse getLogByApplicationID()
                                       throws IOException,
                                              OXSAPIException
Acquires log that is stored by OXSMS which this OXSMSHandler refers to using Foreign Application ID.
Before calling this method, it is necessary to set Foreign Application ID.
User ID is also sent to OXSMS.
The returning value is an instance of OXSMSLogResponse. And this is used for getting contents of log.

This is equivalent to
DO=st&AID=applicationid&ES=oxsms
in HTTP request.

OXSMS uses JSP file which is specified in setting of "Log Response" for response.

Returns:
an instance of OXSMSLogResponse which shows contents of log
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS
See Also:
OXSMSLogResponse, setAidValue, setUidValue, getLog

getAddress

public String getAddress()
Returns the URL of OXSMS servlet which this OXSMSHandler refers to.
This URL is passed to the constructor.

Returns:
the URL of OXSMS servlet which this OXSMSHandler refers to
See Also:
OXSMSHandler

getPort

public int getPort()
Returns always zero.

Returns:
always zero

syncCreate

public SyncResponse syncCreate(OXSParameter Parameter)
                                                   throws IOException,
                                                          OXSAPIException
This is similar to OXSHandler.syncCreate.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
Returns:
an instance of SyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
OXSMSSyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, asyncCreate

syncPrint

public SyncResponse syncPrint(OXSParameter Parameter,
                              long PollingInterval)
                                                  throws IOException,
                                                         OXSAPIException
This is similar to OXSHandler.syncPrint.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
PollingInterval - the surveillance interval of the processing of OXS (ms)
Returns:
an instance of SyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
OXSMSSyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, asyncPrint

syncPXC

public SyncResponse syncPXC(OXSParameter Parameter,
                            long PollingInterval)
                                                throws IOException,
                                                       OXSAPIException
This is similar to syncPrint, but PrintXchange is used when printing.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
PollingInterval - the surveillance interval of the processing of OXS (ms)
Returns:
an instance of SyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
syncPrint, OXSMSSyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, asyncPrint

syncFax

public SyncResponse syncFax(OXSParameter Parameter,
                            long PollingInterval)
                                                throws IOException,
                                                       OXSAPIException
This is similar to OXSHandler.syncFax.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
PollingInterval - the surveillance interval of the processing of OXS (ms)
Returns:
an instance of SyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
OXSMSSyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, asyncFax

syncMail

public SyncResponse syncMail(OXSParameter Parameter,
                             long PollingInterval)
                                                 throws IOException,
                                                        OXSAPIException
This is similar to OXSHandler.syncMail.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
PollingInterval - the surveillance interval of the processing of OXS (ms)
Returns:
an instance of SyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
OXSMSSyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, asyncMail

asyncCreate

public AsyncResponse asyncCreate(OXSParameter Parameter)
                                                     throws IOException,
                                                            OXSAPIException
This is similar to OXSHandler.asyncCreate.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
Returns:
an instance of AsyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
OXSMSAsyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, syncCreate

asyncPrint

public AsyncResponse asyncPrint(OXSParameter Parameter)
                                                    throws IOException,
                                                           OXSAPIException
This is similar to OXSHandler.asyncPrint.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
Returns:
an instance of AsyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
OXSMSAsyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, syncPrint

asyncPXC

public AsyncResponse asyncPXC(OXSParameter Parameter)
                                                  throws IOException,
                                                         OXSAPIException
This is similar to asyncPrint, but PrintXchange is used when printing.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
Returns:
an instance of AsyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
asyncPrint, OXSMSAsyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, syncPrint

asyncFax

public AsyncResponse asyncFax(OXSParameter Parameter)
                                                  throws IOException,
                                                         OXSAPIException
This is similar to OXSHandler.asyncFax.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
Returns:
an instance of AsyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
OXSMSAsyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, syncFax

asyncMail

public AsyncResponse asyncMail(OXSParameter Parameter)
                                                   throws IOException,
                                                          OXSAPIException
This is similar to OXSHandler.asyncMail.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
Returns:
an instance of AsyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
See Also:
OXSMSAsyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, syncMail

syncFaxA

public SyncResponse syncFaxA(OXSParameter Parameter,
                             long PollingInterval)
                                                 throws IOException,
                                                        OXSAPIException
This is similar to OXSHandler.syncFaxA.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
PollingInterval - the surveillance interval of the processing of OXS (ms)
Returns:
an instance of SyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
Since:
2.6.0.0
See Also:
OXSMSSyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, asyncFaxA

syncFaxI

public SyncResponse syncFaxI(OXSParameter Parameter,
                             long PollingInterval)
                                                 throws IOException,
                                                        OXSAPIException
This is similar to OXSHandler.syncFaxI.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
PollingInterval - the surveillance interval of the processing of OXS (ms)
Returns:
an instance of SyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
Since:
2.6.0.0
See Also:
OXSMSSyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, asyncFaxI

asyncFaxA

public AsyncResponse asyncFaxA(OXSParameter Parameter)
                                                   throws IOException,
                                                          OXSAPIException
This is similar to OXSHandler.asyncFaxA.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
Returns:
an instance of AsyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
Since:
2.6.0.0
See Also:
OXSMSAsyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, syncFaxA

asyncFaxI

public AsyncResponse asyncFaxI(OXSParameter Parameter)
                                                   throws IOException,
                                                          OXSAPIException
This is similar to OXSHandler.asyncFaxI.
User ID, Foreign Application ID, OXS Alias, Comment and Use Ricoh TrustyCabinet are also sent to OXSMS.
By casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID can be obtained.

Parameters:
Parameter - an instance of OXSParameter which shows request contents
Returns:
an instance of AsyncResponse which shows request result
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS or OXS
Since:
2.6.0.0
See Also:
OXSMSAsyncResponse, setUidValue, setAidValue, setOXSValue, setCommentValue, setTCABValue, syncFaxI

getOXSMSVersion

public String getOXSMSVersion()
                                 throws IOException,
                                        OXSAPIException
Returns the version number of OXSMS which this OXSMSHandler refers to.

This is equivalent to
DO=sv&ES=oxsms
in HTTP request.

Returns:
the version number of OXSMS which this OXSMSHandler refers to
Throws:
IOException - if an error occurs during the connection with OXSMS
OXSAPIException - if an error occurs in OXSMS
Since:
2006.07.14

addAdditionalParameter

public void addAdditionalParameter(String name,
                                   String value)
Adds undefined parameters to send to OXSMS.
This provides method to send parameters not defined to OXSMS, when OXSMS which this OXSMSHandler refers to is customized OXSMS.

Added parameter will be sent as
name=value
to OXSMS.

Even if parameter is already added, it is not overwritten. It is treated as different parameter.

Parameters:
name - Name of parameter to add
value - Value of parameter to add
Since:
2006.08.01
See Also:
OXSMSHandler

removeAdditionalParameter

public String[] removeAdditionalParameter(String name)
Deletes specified parameter which is added by addAdditionalParameter.
When specified parameter is not exists, returns null.

Parameters:
name - Name of parameter to delete
Returns:
Value of parameter to be deleted
Since:
2006.08.01
See Also:
addAdditionalParameter

getAdditionalParameter

public String[] getAdditionalParameter(String name)
Returns value of specified parameter which is added by addAdditionalParameter.
When specified parameter is not exists, returns null.

Parameters:
name - Name of parameter to get
Returns:
Value of specified parameter
Since:
2006.08.01
See Also:
addAdditionalParameter

containsAdditionalParameter

public boolean containsAdditionalParameter(String name)
Returns true when specified parameter is contained in parameters which are added by addAdditionalParameter.

Parameters:
name - Name of parameter to check
Returns:
When parameter is contained in added paramters, returns true
Since:
2006.08.01
See Also:
addAdditionalParameter

clearAdditionalParameter

public void clearAdditionalParameter()
Deletes all parameters which is added by addAdditionalParameter.

Since:
2006.08.01
See Also:
addAdditionalParameter

OPRO Japan Co.,Ltd.