OPROARTS API

パッケージ net.opro.product.odcaw.oproarts.api

OPROARTS Application Program Interface は、日本オプロ株式会社が提供する帳票SaaS「OPROARTS」を利用するための API です。

参照先:
          説明

クラスの概要
AttachedParameter OPROARTSParameter で使用するための、ドキュメントへの添付ファイルに関するパラメータを定義する全てのクラスのスーパークラスです。
MailParameter OPROARTSParameter.setMail(MailParameter) で使用するための、メールに関するパラメータを定義します。
OPROARTSHandler OPROARTS Application Program Interface の中心となるクラスです。
OPROARTSParameter OPROARTSHandler を使用する際の各種パラメータを定義します。
OPROARTSResponseInfo ドキュメント生成指示等を行った結果、OPROARTSサーバーから返却された情報を提供するクラスです。
StreamAttachedParameter OPROARTSParameter で使用するための、ドキュメントへの添付ファイルに関するパラメータを定義します。
TemplateParameter OPROARTSParameter で使用するための、テンプレートに関するパラメータを定義します。
TextAttachedParameter OPROARTSParameter で使用するための、ドキュメントへの添付ファイルに関するパラメータを定義します。
 

例外の概要
OPROARTSAPIConnectionException OPROARTSサーバーとの接続時にエラーが発生した場合にスローされます。
OPROARTSAPIConnectTimeoutException OPROARTSサーバーへの接続を確立する前にタイムアウトが発生した場合にスローされます。
OPROARTSAPIException OPROARTSサーバー の操作時に、API 側でエラーが発生したことを示すためにスローされます。
OPROARTSAPIFileSizeException API が保存したドキュメントのサイズが、OPROARTSサーバー が返却した Content-Length と一致しないことを示すためにスローされます。
OPROARTSAPIReadTimeoutException OPROARTSサーバーからデータを読み取る準備ができる前にタイムアウトが発生した場合にスローされます。
OPROARTSAPISavingException API がドキュメントを保存する際に、エラーが発生したことを示すためにスローされます。
OPROARTSCanceledException OPROARTSサーバー の操作時に、OPROARTSサーバー で処理がキャンセルされたことを示すためにスローされます。
OPROARTSConcurrentRequestException OPROARTSサーバー の操作時に、OPROARTSサーバー で同時処理エラーが発生したことを示すためにスローされます。
OPROARTSException OPROARTSサーバー の操作時に、OPROARTSサーバー でエラーが発生したことを示すためにスローされます。
OPROARTSIllegalRequestException OPROARTSサーバー の操作時に、OPROARTSサーバー でパラメータの整合性に関する問題が見つかった場合にスローされます。
OPROARTSRequestTooLargeException OPROARTSサーバー の操作時に、OPROARTSサーバー でデータサイズ超過エラーが発生したことを示すためにスローされます。
OPROARTSRestrictedException OPROARTSサーバー の操作時に、OPROARTSサーバー で利用可能頁数エラーが発生したことを示すためにスローされます。
OPROARTSTimeoutException OPROARTSサーバー の操作時に、OPROARTSサーバー で処理のタイムアウトが発生したことを示すためにスローされます。
OPROARTSUnAuthorizedException OPROARTSサーバー の操作時に、OPROARTSサーバー で認証エラーが発生したことを示すためにスローされます。
 

パッケージ net.opro.product.odcaw.oproarts.api の説明

OPROARTS Application Program Interface は、日本オプロ株式会社が提供する帳票SaaS「OPROARTS」を利用するための API です。

この API は、OPROARTS の標準インターフェイスである HTTPS でのリクエストを、アプリケーションから容易に行うことを目的としています。
OPROARTSサーバー と HTTPS を用いて通信を行うため、OPROARTS API を利用するアプリケーションと OPROARTSサーバー との間で HTTPS による通信が正しく行なえる環境が必要となります。
通信を行うためにプロクシの設定が必要な場合は、コンストラクタOPROARTSHandler(URL, Proxy) を使用するか、Java 実行環境のシステムプロパティ等を設定してください。

API の中心となるのは、OPROARTSHandler クラスで、アプリケーションはこれを通して OPROARTSサーバー へのリクエストを行います。
OPROARTSHandler には、ドキュメントの保存、メール送信を行うメソッドが用意されています。
これらのメソッドでは、OPROARTSParameter クラスで定義されたパラメータを用いて OPROARTSサーバー へ指示を行います。
アプリケーションは、

  1. OPROARTSParameter でテンプレートやテキストデータなどのパラメータを定義する
  2. OPROARTSHandler で OPROARTSサーバー へのリクエストを行う
という手順で処理を行います。

リクエストを行うメソッドには、以下のものがあります。

OPROARTSHandler.saveDocument
OPR形式またはPDF形式のドキュメントの生成をリクエストし、指定された場所に保存します
OPROARTSHandler.saveDirectPrintDocument
印刷用ドキュメントの生成をリクエストし、指定された場所に保存します
OPROARTSHandler.sendMail
OPR形式またはPDF形式のドキュメントを添付したメールの送信を指示します
例えば、PDFファイルを保存する場合は、以下のようにコーディングします。
   //OPROARTSサーバーのURLを指定します。
   OPROARTSHandler h = new OPROARTSHandler("https://www.oproarts.com/Facade");

   //ドキュメント生成のためのパラメータを構築します。
   OPROARTSParameter p = new OPROARTSParameter(cid, uid, password);
   //テンプレートを指定します。
   TemplateParameter tp = op.addTemplate("sample1");

   //ドキュメントの生成と保存を指示します。
   String savedFilePath = h.saveDocument(p, directoryPath, fileName);


OPRO Japan Co.,Ltd.