Package net.opro.product.odcaw.oproarts.api

OPROARTS Application Program Interface is API for which the reporting SaaS "OPROARTS" presented by OPRO Japan can be used.

See:
Description

Class Summary

AttachedParameter	This is a super class of all classes that defines parameters about attached file of document.
MailParameter	This class defines the mail parameters which is used in OPROARTSParameter.setMail(MailParameter).
OPROARTSHandler	This is the main class of OPROARTS Application Program Interface.
OPROARTSParameter	This class defines various parameters to use OPROARTSHandler.
OPROARTSResponseInfo	This class provides the information returned from OPROARTS server, after requesting document generation etc.
StreamAttachedParameter	This class defines parameters about attached file of document.
TemplateParameter	This class defines the parameter about Template.
TextAttachedParameter	This class defines parameters about attached file of document.

Exception Summary

OPROARTSAPIConnectionException	Signals that an error occurs during connecting or communicating to OPROARTS server.
OPROARTSAPIConnectTimeoutException	Signals that a timeout expires before the connection to OPROARTS server can be established.
OPROARTSAPIException	Signals that an error occurs in API-side during operating OPROARTS server.
OPROARTSAPIReadTimeoutException	Signals that a timeout expires before there is data available for read from OPROARTS server.
OPROARTSAPISavingException	Signals that an error occurs during saving document by API.
OPROARTSConcurrentRequestException	Signals that another processing is running in OPROARTS server during operating OPROARTS server.
OPROARTSException	Signals that an error occurs in OPROARTS server during operating OPROARTS server.
OPROARTSIllegalRequestException	Signals that the problem of the content of the parameter is found in OPROARTS server during operating OPROARTS server.
OPROARTSRequestTooLargeException	Signals that data size excess error occurs in OPROARTS server during operating OPROARTS server.
OPROARTSRestrictedException	Signals that the number of pages that can be used is exceeded in OPROARTS server during operating OPROARTS server.
OPROARTSUnAuthorizedException	Signals that an authorization error occurs in OPROARTS server during operating OPROARTS server.

Package net.opro.product.odcaw.oproarts.api Description

OPROARTS Application Program Interface is API for which the reporting SaaS "OPROARTS" presented by OPRO Japan can be used.

This API has aimed to request easily using HTTPS which is a standard interface of OPROARTS, from the application.
Since communication with OPROARTS server uses HTTPS protocol, the environment which can communicate correctly by HTTPS between the OPROARTS server and the application that uses OPROARTS API is necessary.
When specification of proxy is needed, please use OPROARTSHandler(URL, Proxy) constructor or please set Java system properties etc.

OPROARTSHandler class is the main class of API. Application requests to OPROARTS server through this class.
In OPROARTSHandler, there are methods to save document and to send mail.
These methods use the parameter which is defined by OPROARTSParameter to request to OPROARTS server.
Application processes in the following order.

1. Defines parameters about template or text data using OPROARTSParameter
2. Requests to OPROARTS server using OPROARTSHandler

Methods to request are the following.

OPROARTSHandler.saveDocument

Requests to generate document whose format is OPR or PDF, and saves it to specified place.

OPROARTSHandler.saveDirectPrintDocument

Requests to generate document to print, and saves it to specified place.

OPROARTSHandler.sendMail

Requests to send mail to which the document is attached.

For example, to save PDF, it is realizable by coding as the following.

   //specifies URL of OPROARTS server
   OPROARTSHandler h = new OPROARTSHandler("https://www.oproarts.com/Facade");

   //creates parameters to generate document.
   OPROARTSParameter p = new OPROARTSParameter(cid, uid, password);
   //specifies the template.
   TemplateParameter tp = op.addTemplate("sample1");

   //requests generation of document and saving
   String savedFilePath = h.saveDocument(p, directoryPath, fileName);