OPRO X Server API

net.opro.product.odcaw.api
クラス OXSHandler

Object
  拡張net.opro.product.odcaw.api.OXSHandler

public class OXSHandler
extends Object

OPRO X Server Application Program Interface の中心となるクラスです。
ドキュメント生成指示等を行います。

ドキュメント生成指示等を行うには、OXSParameter で各パラメータを設定し、 syncCreatesyncPrintsyncFaxsyncMail
asyncCreateasyncPrintasyncFaxasyncMail を行います。

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

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 となっています。

バージョン:
2.2.1.0

フィールドの概要
static int FORMAT_HTML
          HTML形式を表します
static int FORMAT_OPR
          OPR形式を表します
static int FORMAT_OXR
          OXR形式を表します
static int FORMAT_PDF
          PDF形式を表します
static int STATUS_CANCEL
          ステータスがキャンセル済みであることを表します。
static int STATUS_COMPLETE
          ステータスが処理完了であることを表します。
static int STATUS_ERROR
          ステータスがエラーであることを表します。
static int STATUS_GENERATED
          ステータスがドキュメント生成完了であることを表します。
static int STATUS_GENERATING
          ステータスがドキュメント生成中であることを表します。
 
コンストラクタの概要
OXSHandler(String Address, int Port)
          指定されたアドレス、ポート番号の OXS を操作する OXSHandler を構築します。
 
メソッドの概要
 AsyncResponse asyncCreate(OXSParameter Parameter)
          この OXSHandler が参照する OXS に、ドキュメントの非同期生成を指示します。
 AsyncResponse asyncFax(OXSParameter Parameter)
          この OXSHandler が参照する OXS に、非同期にドキュメントのFAX送信を指示します。
 AsyncResponse asyncMail(OXSParameter Parameter)
          この OXSHandler が参照する OXS に、非同期にドキュメントのメール送信を指示します。
 AsyncResponse asyncPrint(OXSParameter Parameter)
          この OXSHandler が参照する OXS に、非同期にドキュメントのサーバサイド印刷を指示します。
 CreateResponse createDocument(OXSParameter Parameter)
          推奨されていません。 バージョン 2.2.1 以降は、asyncCreate に置き換えられました。
 String getAddress()
          この OXSHandler が参照する OXS のアドレスを返します。
static String getCreateQueryString(OXSParameter Parameter)
          HTTP でドキュメントの非同期生成指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。
 InputStream getDocument(OXSParameter Parameter)
          推奨されていません。 バージョン 2.2.1 以降は、syncCreate に置き換えられました。
static String getDocumentQueryString(OXSParameter Parameter)
          HTTP でドキュメントの同期生成指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。
 String[] getFaxDevices(String ServerName)
          指定した OXS Fax Edition 又は OXS Fax Service で使用可能なFAXモデムまたはFAXボード名を返します。
static String getFaxQueryString(OXSParameter Parameter)
          HTTP でドキュメントのFAX送信指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。
 String[] getFaxServers()
          この OXSHandler が参照する OXS で使用可能な OXS Fax Edition 又は OXS Fax Service 名を返します。
 String[] getMailDevices(String ServerName)
          指定した OXS Mail Service で使用可能なSMTPを返します。
static String getMailQueryString(OXSParameter Parameter)
          HTTP でドキュメントのメール送信指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。
 String[] getMailServers()
          この OXSHandler が参照する OXS で使用可能な OXS Mail Service 名を返します。
 String getOXSVersion()
          この OXSHandler が参照する OXS のバージョンを返します。
 int getPort()
          この OXSHandler が参照する OXS のポート番号を返します。
 String[] getPrintDevices(String ServerName)
          指定した OXS Print Edition 又は OXS Print Service で使用可能なプリンタ名を返します。
static String getPrintQueryString(OXSParameter Parameter)
          HTTP でドキュメントのサーバサイド印刷指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。
 String[] getPrintServers()
          この OXSHandler が参照する OXS で使用可能な Print Edition(Print Service)名を返します。
 void reconnectDatabase()
          この OXSHandler が参照する OXS に、データベースへの再接続を試みる指示を行います。
 SyncResponse syncCreate(OXSParameter Parameter)
          この OXSHandler が参照する OXS に、ドキュメントの同期生成を指示します。
 SyncResponse syncFax(OXSParameter Parameter, long PollingInterval)
          この OXSHandler が参照する OXS に、同期的にドキュメントのFAX送信を指示します。
 SyncResponse syncMail(OXSParameter Parameter, long PollingInterval)
          この OXSHandler が参照する OXS に、同期的にドキュメントのメール送信を指示します。
 SyncResponse syncPrint(OXSParameter Parameter, long PollingInterval)
          この OXSHandler が参照する OXS に、同期的にドキュメントのサーバサイド印刷を指示します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

フィールドの詳細

STATUS_GENERATING

public static final int STATUS_GENERATING
ステータスがドキュメント生成中であることを表します。

関連項目:
定数フィールド値

STATUS_COMPLETE

public static final int STATUS_COMPLETE
ステータスが処理完了であることを表します。

関連項目:
定数フィールド値

STATUS_ERROR

public static final int STATUS_ERROR
ステータスがエラーであることを表します。

関連項目:
定数フィールド値

STATUS_CANCEL

public static final int STATUS_CANCEL
ステータスがキャンセル済みであることを表します。

関連項目:
定数フィールド値

STATUS_GENERATED

public static final int STATUS_GENERATED
ステータスがドキュメント生成完了であることを表します。

導入されたバージョン:
2.2.1.0
関連項目:
定数フィールド値

FORMAT_OPR

public static final int FORMAT_OPR
OPR形式を表します

関連項目:
定数フィールド値

FORMAT_OXR

public static final int FORMAT_OXR
OXR形式を表します

関連項目:
定数フィールド値

FORMAT_PDF

public static final int FORMAT_PDF
PDF形式を表します

関連項目:
定数フィールド値

FORMAT_HTML

public static final int FORMAT_HTML
HTML形式を表します

関連項目:
定数フィールド値
コンストラクタの詳細

OXSHandler

public OXSHandler(String Address,
                  int Port)
指定されたアドレス、ポート番号の OXS を操作する OXSHandler を構築します。OXS への接続は、この段階では行われません。

パラメータ:
Address - この OXSHandler が参照する OXS のアドレス
Port - この OXSHandler が参照する OXS のポート番号(OXS の設定ファイルで指定したもの)
関連項目:
getAddress, getPort
メソッドの詳細

getAddress

public String getAddress()
この OXSHandler が参照する OXS のアドレスを返します。
OXS のアドレスはコンストラクタに渡されたものです。

戻り値:
この OXSHandler が参照する OXS のアドレス
関連項目:
OXSHandler

getPort

public int getPort()
この OXSHandler が参照する OXS のポート番号を返します。
OXS のポート番号はコンストラクタに渡されたものです。

戻り値:
この OXSHandler が参照するOXSのポート番号
関連項目:
OXSHandler

getOXSVersion

public String getOXSVersion()
                               throws IOException
この OXSHandler が参照する OXS のバージョンを返します。

HTTP によるリクエストの、
DO=sv&ES=odcaw
に相当します。

戻り値:
この OXSHandler が参照する OXS のバージョン
例外:
IOException - OXS との接続中に入出力エラーが発生した場合

getPrintServers

public String[] getPrintServers()
                                   throws IOException,
                                          OXSAPIException
この OXSHandler が参照する OXS で使用可能な Print Edition(Print Service)名を返します。
返される値は、OXS の設定ファイルの <ODDS>/<OIPS_INFO>/<URLS> で指定した name 属性です。
各 OXS Print Edition 又は OXS Print Service の動作状態は関係しません。

HTTP によるリクエストの、
DO=sl&OP=pr&ES=odds
に相当します。

戻り値:
この OXSHandler が参照する OXS で使用可能な OXS Print Edition 又は OXS Print Service 名
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0

getFaxServers

public String[] getFaxServers()
                                 throws IOException,
                                        OXSAPIException
この OXSHandler が参照する OXS で使用可能な OXS Fax Edition 又は OXS Fax Service 名を返します。
返される値は、OXS の設定ファイルの <ODDS>/<OIFS_INFO>/<URLS> で指定した name 属性です。
各 OXS Fax Edition 又は OXS Fax Service の動作状態は関係しません。

HTTP によるリクエストの、
DO=sl&OP=fx&ES=odds
に相当します。

戻り値:
この OXSHandler が参照する OXS で使用可能な OXS Fax Edition 又は OXS Fax Service 名
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0

getMailServers

public String[] getMailServers()
                                  throws IOException,
                                         OXSAPIException
この OXSHandler が参照する OXS で使用可能な OXS Mail Service 名を返します。
返される値は、OXS の設定ファイルの <ODDS>/<ODMS_INFO>/<URLS> で指定した name 属性です。
各 OXS Mail Service の動作状態は関係しません。

HTTP によるリクエストの、
DO=sl&OP=ml&ES=odds
に相当します。

戻り値:
この OXSHandler が参照する OXS で使用可能な OXS Mail Service 名
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0

getPrintDevices

public String[] getPrintDevices(String ServerName)
                                   throws IOException,
                                          OXSAPIException
指定した OXS Print Edition 又は OXS Print Service で使用可能なプリンタ名を返します。

HTTP によるリクエストの、
DO=pl&OP=pr&TS0=ServerName&ES=odds
に相当します。

パラメータ:
ServerName - getPrintServers で取得した、OXS Print Edition 又は OXS Print Service 名
戻り値:
指定した OXS Print Edition 又は OXS Print Service が管理する、使用可能なプリンタ名
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0

getFaxDevices

public String[] getFaxDevices(String ServerName)
                                 throws IOException,
                                        OXSAPIException
指定した OXS Fax Edition 又は OXS Fax Service で使用可能なFAXモデムまたはFAXボード名を返します。

HTTP によるリクエストの、
DO=pl&OP=fx&TS0=ServerName&ES=odds
に相当します。

パラメータ:
ServerName - getFaxServers で取得した、OXS Fax Edition 又は OXS Fax Service 名
戻り値:
指定した OXS Fax Edition 又は OXS Fax Service が管理する、使用可能なFAXボードまたはFAXモデム名
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0

getMailDevices

public String[] getMailDevices(String ServerName)
                                  throws IOException,
                                         OXSAPIException
指定した OXS Mail Service で使用可能なSMTPを返します。
返される値は、OXS の設定ファイルの <OMPS>/<ODMS>/<SMTP>/<SERVER>/<HOST> で指定したものです。

HTTP によるリクエストの、
DO=pl&OP=ml&TS0=ServerName&ES=odds
に相当します。

パラメータ:
ServerName - getMailServers で取得した、OXS Mail Service 名
戻り値:
指定した OXS Mail Service が管理する、SMTP サーバ名
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0

reconnectDatabase

public void reconnectDatabase()
                       throws IOException,
                              OXSAPIException
この OXSHandler が参照する OXS に、データベースへの再接続を試みる指示を行います。
OXS は、起動時に接続したデータベース接続のうち、使用できなくなっているものを検出し、再接続を試みます。

HTTP によるリクエストの、
DO=rc&ES=odcs
に相当します。

例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0

getDocument

public InputStream getDocument(OXSParameter Parameter)
                                throws IOException,
                                       OXSAPIException
推奨されていません。 バージョン 2.2.1 以降は、syncCreate に置き換えられました。

この OXSHandler が参照する OXS に、ドキュメントの生成を指示し、生成されたドキュメントを受け取る入力ストリームを返します。

HTTP によるリクエストの、
DO=ex&OP=dl&...&ES=odds
に相当します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
生成されたドキュメントを受け取る入力ストリーム
例外:
IOException - OXS との接続中、または生成されたドキュメントの取得中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
関連項目:
OXSParameter

createDocument

public CreateResponse createDocument(OXSParameter Parameter)
                              throws IOException,
                                     OXSAPIException
推奨されていません。 バージョン 2.2.1 以降は、asyncCreate に置き換えられました。

この OXSHandler が参照する OXS に、ドキュメントの非同期生成を指示します。
指示結果は CreateResponse インスタンスとして返され、ステータスの取得や生成されたドキュメントの取得には、これを用います。

このメソッドが正しく動作するためには、OXS の cr_response.html、cr_status.html に、下記の値をMETAタグとして記述する必要があります。
[OXS_PID], [OXS_DOCUMENT_URL], [OXS_CANCEL_URL], [OXS_STATUS_URL], [OXS_STATUS]

HTTP によるリクエストの、
DO=ex&OP=cr&...&ES=odds
に相当します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
指示結果を示す CreateResponse インスタンス
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
関連項目:
OXSParameter, CreateResponse

syncCreate

public SyncResponse syncCreate(OXSParameter Parameter)
                        throws IOException,
                               OXSAPIException
この OXSHandler が参照する OXS に、ドキュメントの同期生成を指示します。
OXS の処理が完了するまで制御は戻りません。
指示結果は SyncResponse インスタンスとして返され、処理結果の取得や生成されたドキュメントの取得には、これを用います。

HTTP によるリクエストの、
DO=ex&OP=dl&...&ES=odds
に相当します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
指示結果を示す SyncResponse インスタンス
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0
関連項目:
OXSParameter, SyncResponse

syncPrint

public SyncResponse syncPrint(OXSParameter Parameter,
                              long PollingInterval)
                       throws IOException,
                              OXSAPIException
この OXSHandler が参照する OXS に、同期的にドキュメントのサーバサイド印刷を指示します。
OXS の処理が完了するまで制御は戻りません。
このメソッドが正しく動作するためには、引数 Parameter である OXSParameter インスタンスに、正しく PrintParameter が設定されている必要があります。
引数 PollingInterval 間隔で非同期サーバサイド印刷を監視し、終了した段階で処理を戻します。PollingInterval を短くすると、監視の精度は向上しますが、OXS に対する負荷が大きくなります。
指示結果は SyncResponse インスタンスとして返され、処理結果の取得や生成されたドキュメントの取得には、これを用います。

このメソッドが正しく動作するためには、OXS の pr_response.html に、下記の値をMETAタグとして記述する必要があります。
[OXS_PID], [OXS_DOCUMENT_URL], [OXS_CANCEL_URL], [OXS_STATUS_URL], [OXS_STATUS]

HTTP によるリクエストの、
DO=ex&OP=pr&...&ES=odds
に相当します。

使用する OXS Print Edition 又は OXS Print Service が、OXS の設定ファイルで type="local" と定義されている場合は、 1ページ単位で生成・印刷を行うため、 SyncResponse.getDocumentUrl が示すドキュメント、 SyncResponse.getDocument で取得するドキュメントは、OXR形式から1ページ目だけを抜粋した XML です。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
PollingInterval - OXS の処理状況の監視間隔(ms)
戻り値:
指示結果を示す SyncResponse インスタンス
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0
関連項目:
asyncPrint, OXSParameter, OXSParameter.setPrint, PrintParameter, SyncResponse

syncFax

public SyncResponse syncFax(OXSParameter Parameter,
                            long PollingInterval)
                     throws IOException,
                            OXSAPIException
この OXSHandler が参照する OXS に、同期的にドキュメントのFAX送信を指示します。
OXS の処理が完了するまで制御は戻りません。
このメソッドが正しく動作するためには、引数 Parameter である OXSParameter インスタンスに、正しく FaxParameter が設定されている必要があります。
引数 PollingInterval 間隔で非同期FAX送信を監視し、終了した段階で処理を戻します。PollingInterval を短くすると、監視の精度は向上しますが、OXS に対する負荷が大きくなります。
指示結果は SyncResponse インスタンスとして返され、処理結果の取得や生成されたドキュメントの取得には、これを用います。

このメソッドが正しく動作するためには、OXS の fx_response.html に、下記の値をMETAタグとして記述する必要があります。
[OXS_PID], [OXS_DOCUMENT_URL], [OXS_CANCEL_URL], [OXS_STATUS_URL], [OXS_STATUS]

HTTP によるリクエストの、
DO=ex&OP=fx&...&ES=odds
に相当します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
PollingInterval - OXS の処理状況の監視間隔(ms)
戻り値:
指示結果を示す SyncResponse インスタンス
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0
関連項目:
asyncFax, OXSParameter, OXSParameter.setFax, FaxParameter, SyncResponse

syncMail

public SyncResponse syncMail(OXSParameter Parameter,
                             long PollingInterval)
                      throws IOException,
                             OXSAPIException
この OXSHandler が参照する OXS に、同期的にドキュメントのメール送信を指示します。
OXS の処理が完了するまで制御は戻りません。
このメソッドが正しく動作するためには、引数 Parameter である OXSParameter インスタンスに、正しく MailParameter が設定されている必要があります。
引数 PollingInterval 間隔で非同期メール送信を監視し、終了した段階で処理を戻します。PollingInterval を短くすると、監視の精度は向上しますが、OXS に対する負荷が大きくなります。
指示結果は SyncResponse インスタンスとして返され、処理結果の取得や生成されたドキュメントの取得には、これを用います。

このメソッドが正しく動作するためには、OXS の ml_response.html に、下記の値をMETAタグとして記述する必要があります。
[OXS_PID], [OXS_DOCUMENT_URL], [OXS_CANCEL_URL], [OXS_STATUS_URL], [OXS_STATUS]

HTTP によるリクエストの、
DO=ex&OP=ml&...&ES=odds
に相当します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
PollingInterval - OXS の処理状況の監視間隔(ms)
戻り値:
指示結果を示す SyncResponse インスタンス
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0
関連項目:
asyncMail, OXSParameter, OXSParameter.setMail, MailParameter, SyncResponse

asyncCreate

public AsyncResponse asyncCreate(OXSParameter Parameter)
                          throws IOException,
                                 OXSAPIException
この OXSHandler が参照する OXS に、ドキュメントの非同期生成を指示します。
指示結果は AsyncResponse インスタンスとして返され、ステータスの取得や生成されたドキュメントの取得には、これを用います。

このメソッドが正しく動作するためには、OXS の cr_response.html、cr_status.html に、下記の値をMETAタグとして記述する必要があります。
[OXS_PID], [OXS_DOCUMENT_URL], [OXS_CANCEL_URL], [OXS_STATUS_URL], [OXS_STATUS]

HTTP によるリクエストの、
DO=ex&OP=cr&...&ES=odds
に相当します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
指示結果を示す AsyncResponse インスタンス
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0
関連項目:
OXSParameter, AsyncResponse

asyncPrint

public AsyncResponse asyncPrint(OXSParameter Parameter)
                         throws IOException,
                                OXSAPIException
この OXSHandler が参照する OXS に、非同期にドキュメントのサーバサイド印刷を指示します。
このメソッドが正しく動作するためには、引数 Parameter である OXSParameter インスタンスに、正しく PrintParameter が設定されている必要があります。
指示結果は AsyncResponse インスタンスとして返され、ステータスの取得や生成されたドキュメントの取得には、これを用います。

このメソッドが正しく動作するためには、OXS の pr_response.html に、下記の値をMETAタグとして記述する必要があります。
[OXS_PID], [OXS_DOCUMENT_URL], [OXS_CANCEL_URL], [OXS_STATUS_URL], [OXS_STATUS]

HTTP によるリクエストの、
DO=ex&OP=pr&...&ES=odds
に相当します。

使用する OXS Print Edition 又は OXS Print Service が、OXS の設定ファイルで type="local" と定義されている場合は、 1ページ単位で生成・印刷を行うため、 AsyncResponse.getDocumentUrl が示すドキュメント、 AsyncResponse.getDocument で取得するドキュメントは、OXR形式から1ページ目だけを抜粋した XML です。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
指示結果を示す AsyncResponse インスタンス
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0
関連項目:
OXSParameter, OXSParameter.setPrint, PrintParameter, AsyncResponse

asyncFax

public AsyncResponse asyncFax(OXSParameter Parameter)
                       throws IOException,
                              OXSAPIException
この OXSHandler が参照する OXS に、非同期にドキュメントのFAX送信を指示します。
このメソッドが正しく動作するためには、引数 Parameter である OXSParameter インスタンスに、正しく FaxParameter が設定されている必要があります。
指示結果は AsyncResponse インスタンスとして返され、ステータスの取得や生成されたドキュメントの取得には、これを用います。

このメソッドが正しく動作するためには、OXS の fx_response.html に、下記の値をMETAタグとして記述する必要があります。
[OXS_PID], [OXS_DOCUMENT_URL], [OXS_CANCEL_URL], [OXS_STATUS_URL], [OXS_STATUS]

HTTP によるリクエストの、
DO=ex&OP=fx&...&ES=odds
に相当します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
指示結果を示す AsyncResponse インスタンス
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0
関連項目:
OXSParameter, OXSParameter.setFax, FaxParameter, AsyncResponse

asyncMail

public AsyncResponse asyncMail(OXSParameter Parameter)
                        throws IOException,
                               OXSAPIException
この OXSHandler が参照する OXS に、非同期にドキュメントのメール送信を指示します。
このメソッドが正しく動作するためには、引数 Parameter である OXSParameter インスタンスに、正しく MailParameter が設定されている必要があります。
指示結果は AsyncResponse インスタンスとして返され、ステータスの取得や生成されたドキュメントの取得には、これを用います。

このメソッドが正しく動作するためには、OXS の ml_response.html に、下記の値をMETAタグとして記述する必要があります。
[OXS_PID], [OXS_DOCUMENT_URL], [OXS_CANCEL_URL], [OXS_STATUS_URL], [OXS_STATUS]

HTTP によるリクエストの、
DO=ex&OP=ml&...&ES=odds
に相当します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
指示結果を示す AsyncResponse インスタンス
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - OXS でエラーが発生した場合
導入されたバージョン:
2.2.1.0
関連項目:
OXSParameter, OXSParameter.setMail, MailParameter, AsyncResponse

getDocumentQueryString

public static String getDocumentQueryString(OXSParameter Parameter)
                                               throws IOException
HTTP でドキュメントの同期生成指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
引数 HTTP でドキュメントの同期生成指示を行う際に使用可能なクエリストリング
例外:
IOException - クエリストリング生成中に入出力エラーが発生した場合
導入されたバージョン:
2.2.1.0

getCreateQueryString

public static String getCreateQueryString(OXSParameter Parameter)
                                             throws IOException
HTTP でドキュメントの非同期生成指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
HTTP でドキュメントの非同期生成指示を行う際に使用可能なクエリストリング
例外:
IOException - クエリストリング生成中に入出力エラーが発生した場合
導入されたバージョン:
2.2.1.0

getPrintQueryString

public static String getPrintQueryString(OXSParameter Parameter)
                                            throws IOException
HTTP でドキュメントのサーバサイド印刷指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
HTTP でドキュメントのサーバサイド印刷指示を行う際に使用可能なクエリストリング
例外:
IOException - クエリストリング生成中に入出力エラーが発生した場合
導入されたバージョン:
2.2.1.0

getFaxQueryString

public static String getFaxQueryString(OXSParameter Parameter)
                                          throws IOException
HTTP でドキュメントのFAX送信指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
HTTP でドキュメントのFAX送信指示を行う際に使用可能なクエリストリング
例外:
IOException - クエリストリング生成中に入出力エラーが発生した場合
導入されたバージョン:
2.2.1.0

getMailQueryString

public static String getMailQueryString(OXSParameter Parameter)
                                           throws IOException
HTTP でドキュメントのメール送信指示を行う際に使用可能な、引数 Parameter に応じたクエリストリングを返します。

パラメータ:
Parameter - 指示内容を示す OXSParameter インスタンス
戻り値:
HTTP でドキュメントのメール送信指示を行う際に使用可能なクエリストリング
例外:
IOException - クエリストリング生成中に入出力エラーが発生した場合
導入されたバージョン:
2.2.1.0

OPRO Japan Co.,Ltd.