OPRO X Server Management Service API

Package net.opro.product.odcaw.api

OPRO X Server Management Service Application Program Interface is API for which OPRO X Server Management Service can be used in almost the same interface as OPRO X Server Application Program Interface.
Please refer to the document of OXS API for the one not described here.

See:
          Description

Interface Summary
OXSMSResponse A interface which provides a mechanism to operate about the result of the directions to OXSMS from OXSMSHandler.
 

Class Summary
OXSMSAcquireResponse This class is the return value of OXSMSHandler.acquireDocument and provides the result.
It is possible to get the Request ID, document, its content-type and more.
OXSMSAsyncResponse 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.
OXSMSHandler This is the main class of OPRO X Server Management Service Application Program Interface.
This class requests document generation etc.
OXSMSLogResponse This class is the return value of OXSMSHandler.getLog, OXSMSHandler.getLogByApplicationID and provides the result.
OXSMSSyncResponse This class is the return value of synchronous method of OXSMSHandler and provides the result.
It is possible to get the processing result, Request ID, created document and more.
 

Package net.opro.product.odcaw.api Description

OPRO X Server Management Service Application Program Interface is API for which OPRO X Server Management Service can be used in almost the same interface as OPRO X Server Application Program Interface.
Please refer to the document of OXS API for the one not described here.

Since this API uses HTTP to communicate with OXSMS, API and OXSMS do not need to be in the same environment.
This API is not for manipulating OXSMS like OXS API. This is for providing easier method to request to OXSMS from application.
As compared with the conventional HTTP request, it does not excel functionally.

OXSMS API is able not only to use OXSMS by the interface similar to OXS API, but also using the original function of OXSMS is implemented.

OXSMSHandler which is substitution of OXSHandler is implemented the following methods to specify original request parameter of OXSMS.

setRidValue
Sets Request ID
setUidValue
Sets User ID
setAidValue
Sets Foreign Application ID
setOXSValue
Sets OXS Alias
setCommentValue
Sets Comment
setTCABValue
Sets whether Ricoh TrustyCabinet should be used
addAdditionalParameter
Adds undefined parameters
These parameters are sent to OXSMS if necessary.

And, acquireDocument to acquire document that OXSMS preserves,
getLog and getLogByApplicationID to acquire log that OXSMS preserves also implemented.

Synchronous method such as syncCreate returns instance of SyncResponse class as well as OXS API. By casting the returning value to OXSMSResponse or OXSMSSyncResponse, Request ID of OXSMS can be obtained.
Asynchronous method such as asyncCreate are also similar, by casting the returning value to OXSMSResponse or OXSMSAsyncResponse, Request ID of OXSMS can be obtained.

This API needs OPRO X Server Application Program Interface.


OPRO Japan Co.,Ltd.