OPRO X Server API

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

OPRO X Server Application Program Interface は、CGI・Servlet に次ぐ OPRO X Server の第3のインターフェイスです。

参照:
          説明

インタフェースの概要
CooperateDevice CooperateServer で使用するための、 連携サーバ・サービスで使用するデバイスに関するパラメータを定義する機構を提供するインターフェースです。
CooperateParameter OXSParameter で使用するための、 連携サーバ・サービスを利用するためのパラメータを定義する機構を提供するインターフェースです。
CooperateServer CooperateParameter で使用するための、 連携サーバ・サービスに関するパラメータを定義する機構を提供するインターフェースです。
Response OXSHandler から行った OXS への指示結果に関する処理を行う機構を提供するインターフェイスです
 

クラスの概要
AsyncResponse OXSHandler の非同期処理の戻り値であり、その OXS プロセスの管理を行います。
CooperateDeviceImpl CooperateServer で使用するための、 連携サーバ・サービスで使用するデバイスに関するパラメータを定義する全てのクラスに共通のスーパークラスです。
CooperateParameterImpl OXSParameter で使用するための、 連携サーバ・サービスを利用するためのパラメータを定義する全てのクラスに共通のスーパークラスです。
CooperateServerImpl CooperateParameter で使用するための、 連携サーバ・サービスに関するパラメータを定義する全てのクラスに共通のスーパークラスです。
CreateResponse 推奨されていません。 バージョン 2.2.1 以降は、 OXSHandler.createDocumentOXSHandler.asyncCreate に置き換えられ、 CreateResponse ではなく、AsyncResponse を使用することとなりました。
FaxDevice FaxServer で使用するための、 OXS Fax Edition 又は OXS Fax Service で使用するFAXボード、またはFAXモデムに関するパラメータを定義します。
FaxParameter OXSHandler.asyncFax で使用するための、 OXS Fax Edition 又は OXS Fax Service を利用するためのパラメータを定義します。
FaxServer FaxParameter で使用するための、 OXS Fax Edition 又は OXS Fax Service に関するパラメータを定義します。
MailDevice MailServer で使用するための、 OXS Mail Service で使用するSMTPサーバに関するパラメータを定義します。
MailParameter OXSHandler.asyncMail で使用するための、 OXS Mail Service を利用するためのパラメータを定義します。
MailServer MailParameter で使用するための、OXS Mail Service に関するパラメータを定義します。
OXSHandler OPRO X Server Application Program Interface の中心となるクラスです。
OXSParameter OXSHandler を使用する際の各種パラメータを定義します。
PrintDevice PrintServer で使用するための、 OXS Print Edition 又は OXS Print Service で使用するプリンタに関するパラメータを定義します。
PrintParameter OXSHandler.asyncPrint で使用するための、 OXS Print Edition 又は OXS Print Service を利用するためのパラメータを定義します。
PrintServer PrintParameter で使用するための、 OXS Print Edition 又は OXS Print Service に関するパラメータを定義します。
SyncResponse OXSHandler の同期処理の戻り値であり、その結果を提供します。
TemplateParameter OXSParameter で使用するための、テンプレートに関するパラメータを定義します。
 

例外の概要
OXSAPIException OXS の操作中にOXSでエラーが発生したことを示すためにスローされます。
 

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

OPRO X Server Application Program Interface は、CGI・Servlet に次ぐ OPRO X Server の第3のインターフェイスです。

この API は、OXS とソケットを用いて通信を行います。このため、API と OXS が同一の環境内にある必要はありません。
また、この API は、OXS を操作するものではなく、既存の CGI・Servlet と同様の位置づけで、OXS へのアプリケーションからのリクエストを簡単に行うためのものです。
このため、従来の HTTP によるリクエストと比較して、機能的に勝ることはありません。

これまで、アプリケーションから OXS へリクエストする際には、 java.net.HttpURLConnection 等を用いて、CGI・Servlet へ HTTP リクエストを送信する必要がありました。
この API によって、煩雑なプログラムを作成することなく、OXS へのリクエストを行い、そのレスポンスを得ることができます。
単純なドキュメントのダウンロードであれば、

   //localhost にある、ポート番号6001 の OXS を使用します。
   OXSHandler o = new OXSHandler("localhost", 6001);

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

   //ドキュメントの同期生成を指示します。
   SyncResponse r = o.syncCreate(op); 
   //生成されたドキュメントのストリームを受け取ります。
   InputStream is = r.getDocument();
これだけのコーディングで実現可能です。

API の中心となるのは、OXSHandler クラスで、アプリケーションはこれを通して OXS へのリクエストを行います。
OXSHandler には、実行を指示するメソッド(HTTP リクエストの DO=ex に相当)と、 その他の指示を行うメソッド(HTTP リクエストの DO=sv, DO=sl, DO=pl, DO=rc に相当)が実装されています。

実行を指示するメソッドでは、ドキュメント生成、サーバサイド印刷、FAX送信、メール送信が指示でき、それぞれの同期処理・非同期処理を行うためのメソッドが用意されています。
これらのメソッドは、OXSParameter クラスで定義されたパラメータを用いて OXS へ指示を行い、 同期処理であれば SyncResponse クラスを、 非同期処理であれば AsyncResponse クラスを、 その結果として返します。
アプリケーションは、これらのクラスを用いて、生成されたドキュメントの取得や、OXS の処理状況の取得等を行います。
実行を指示するメソッドには、以下のものがあります。

OXSHandler.syncCreate
ドキュメントの同期生成を指示します
OXSHandler.syncPrint
同期的にドキュメントのサーバサイド印刷を指示します
OXSHandler.syncFax
同期的にドキュメントのFAX送信を指示します
OXSHandler.syncMail
同期的にドキュメントのメール送信を指示します
OXSHandler.asyncCreate
ドキュメントの非同期生成を指示します
OXSHandler.asyncPrint
非同期にドキュメントのサーバサイド印刷を指示します
OXSHandler.asyncFax
非同期にドキュメントのFAX送信を指示します
OXSHandler.asyncMail
非同期にドキュメントのメール送信を指示します

OXS は、OXS の設定ファイルで定義されている、cr_response.html 等を用いて API からの指示に対する返答を行います。
この API は、OXS からの返答は、Shift_JIS でエンコーディングされているものとして解析を行います。
このため、API を使用する際には、cr_response.html 等は Shift_JIS エンコーディングで記述し、 OXS の設定ファイルの <ODDS>/<RESPONSE> の charset 属性には、「Shift_JIS」と設定してください。
OXS のセットアップ時には、cr_response.html 等、<RESPONSE> ともに、Shift_JIS となっています。


OPRO Japan Co.,Ltd.