OPRO X Server API

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

Object
  拡張net.opro.product.odcaw.api.AsyncResponse
すべての実装インタフェース:
Response
直系の既知のサブクラス:
net.opro.product.odcaw.api.AsyncCreateResponse

public abstract class AsyncResponse
extends Object
implements Response

OXSHandler の非同期処理の戻り値であり、その OXS プロセスの管理を行います。
指示後の処理状況の取得、処理のキャンセル、生成されたドキュメントの取得等が可能です。

導入されたバージョン:
2.2.1.0
関連項目:
OXSHandler.asyncCreate, OXSHandler.asyncPrint, OXSHandler.asyncFax, OXSHandler.asyncMail

メソッドの概要
 boolean cancel()
          この AsyncResponse が管理する、OXS プロセスをキャンセルします。
 String getAddress()
          この Response が参照する OXS のアドレスを返します。
 String getCancelUrl()
          この AsyncResponse が管理する OXS プロセスをキャンセルするための URL を返します。
 InputStream getDocument()
          生成されたドキュメントを受け取る入力ストリームを返します。
ドキュメントは getDocumentUrl に存在し、このメソッドは getDocumentUrl からドキュメントを受け取るための入力ストリームを返します。

OXS の設定ファイルで出力ファイルを削除するように定義されている場合、生成完了後に定義された時間以上経過したドキュメントは削除されます。
getDocumentUrl は、既に削除されている場合も、削除前のドキュメントのURLを返します。
既に削除されている場合、IOException がスローされます。
このメソッドを正しく使用するためには、出力ファイルの削除時間を充分な長さに設定しておく必要があります。

このメソッドを安全に使用するには、getStatus 等を用いてドキュメントの生成状況を確認し、生成完了直後に使用する必要があります。
 String getDocumentUrl()
          生成される(生成された)ドキュメントのURLを返します。

OXS の設定ファイルで出力ファイルを削除するように定義されている場合、生成完了後に定義された時間以上経過したドキュメントは削除されます。
このメソッドは、既に削除されている場合も、削除前のドキュメントのURLを返します。

ドキュメントの生成が完了していない場合でも、取得可能です。
 int getLastStatus()
          最後に取得した処理状況を返します。
 String getLastStatusMessage()
          最後に取得した処理状況を示す文字列を返します。
 String getPID()
          この AsyncResponse が管理する OXS プロセスのプロセス番号を返します。
 int getPort()
          この Response が参照する OXS のポート番号を返します。
 int getResult()
          OXS の処理が完了した際の処理結果を返します。
 int getStatus()
          最新の処理状況を返します。
 String getStatusMessage()
          最新の処理状況を示す文字列を返します。
 String getStatusUrl()
          この AsyncResponse が管理する OXS プロセスのステータスを取得するための URL を返します。
 
クラス Object から継承したメソッド
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

メソッドの詳細

getAddress

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

定義:
インタフェース Response 内の getAddress
戻り値:
この Response が参照する OXS のアドレス
関連項目:
OXSHandler

getPort

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

定義:
インタフェース Response 内の getPort
戻り値:
この Response が参照する OXS のポート番号
関連項目:
OXSHandler

getDocumentUrl

public String getDocumentUrl()
生成される(生成された)ドキュメントのURLを返します。

OXS の設定ファイルで出力ファイルを削除するように定義されている場合、生成完了後に定義された時間以上経過したドキュメントは削除されます。
このメソッドは、既に削除されている場合も、削除前のドキュメントのURLを返します。

ドキュメントの生成が完了していない場合でも、取得可能です。

定義:
インタフェース Response 内の getDocumentUrl
戻り値:
生成される(生成された)ドキュメントのURL
関連項目:
getDocument, getStatus

getDocument

public InputStream getDocument()
                                throws IOException
生成されたドキュメントを受け取る入力ストリームを返します。
ドキュメントは getDocumentUrl に存在し、このメソッドは getDocumentUrl からドキュメントを受け取るための入力ストリームを返します。

OXS の設定ファイルで出力ファイルを削除するように定義されている場合、生成完了後に定義された時間以上経過したドキュメントは削除されます。
getDocumentUrl は、既に削除されている場合も、削除前のドキュメントのURLを返します。
既に削除されている場合、IOException がスローされます。
このメソッドを正しく使用するためには、出力ファイルの削除時間を充分な長さに設定しておく必要があります。

このメソッドを安全に使用するには、getStatus 等を用いてドキュメントの生成状況を確認し、生成完了直後に使用する必要があります。

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

定義:
インタフェース Response 内の getDocument
戻り値:
生成されたドキュメントを受け取る入力ストリーム
例外:
IOException - 生成されたドキュメントの取得中に入出力エラーが発生した場合
関連項目:
getDocumentUrl, getStatus

getResult

public int getResult()
              throws IOException,
                     OXSAPIException
インタフェース Response の記述:
OXS の処理が完了した際の処理結果を返します。
処理が終了していない場合は、OXSHandler.STATUS_GENERATING を返します。

定義:
インタフェース Response 内の getResult
戻り値:
処理結果。 OXSHandler.STATUS_GENERATINGOXSHandler.STATUS_COMPLETEOXSHandler.STATUS_ERROROXSHandler.STATUS_CANCEL のいずれか。
例外:
OXSAPIException - OXS でエラーが発生した場合
IOException - OXS の処理結果の取得中に入出力エラーが発生した場合
関連項目:
OXSHandler.STATUS_COMPLETE, OXSHandler.STATUS_ERROR, OXSHandler.STATUS_CANCEL

getPID

public String getPID()
この AsyncResponse が管理する OXS プロセスのプロセス番号を返します。

戻り値:
この AsyncResponse が管理する OXS のプロセス番号

getStatusUrl

public String getStatusUrl()
この AsyncResponse が管理する OXS プロセスのステータスを取得するための URL を返します。

戻り値:
この AsyncResponse が管理する OXS プロセスのステータスを取得するための URL

getCancelUrl

public String getCancelUrl()
この AsyncResponse が管理する OXS プロセスをキャンセルするための URL を返します。

戻り値:
この AsyncResponse が管理する OXS プロセスをキャンセルするための URL

getStatusMessage

public String getStatusMessage()
                                  throws IOException,
                                         OXSAPIException
最新の処理状況を示す文字列を返します。

戻り値:
最新の処理状況を示す文字列
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - 処理状況を取得するための情報の取得に失敗した場合。 または、処理状況の取得中にOXSでエラーが発生した場合
関連項目:
getLastStatusMessage

getLastStatusMessage

public String getLastStatusMessage()
最後に取得した処理状況を示す文字列を返します。
通常は、getStatusMessage で更新されますが、 OXSHandler によってこの AsyncResponse が作成された直後、cancel でも更新されます。

戻り値:
最後に取得した処理状況を示す文字列
関連項目:
getStatusMessage

getStatus

public int getStatus()
              throws IOException,
                     OXSAPIException
最新の処理状況を返します。

戻り値:
最新の処理状況。 OXSHandler.STATUS_GENERATINGOXSHandler.STATUS_GENERATEDOXSHandler.STATUS_COMPLETEOXSHandler.STATUS_ERROROXSHandler.STATUS_CANCEL のいずれか。
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - 処理状況を取得するための情報の取得に失敗した場合。 または、処理状況の取得中にOXSでエラーが発生した場合
関連項目:
getStatusMessage, getLastStatus, OXSHandler.STATUS_GENERATING, OXSHandler.STATUS_GENERATED, OXSHandler.STATUS_COMPLETE, OXSHandler.STATUS_ERROR, OXSHandler.STATUS_CANCEL

getLastStatus

public int getLastStatus()
最後に取得した処理状況を返します。
通常は、getStatusMessage で更新されますが、 OXSHandler によってこの AsyncResponse が作成された直後等にも更新されます。

戻り値:
最後に取得した処理状況。 OXSHandler.STATUS_GENERATINGOXSHandler.STATUS_GENERATEDOXSHandler.STATUS_COMPLETEOXSHandler.STATUS_ERROROXSHandler.STATUS_CANCEL のいずれか。
関連項目:
getLastStatusMessage, getStatus, OXSHandler.STATUS_GENERATING, OXSHandler.STATUS_GENERATED, OXSHandler.STATUS_COMPLETE, OXSHandler.STATUS_ERROR, OXSHandler.STATUS_CANCEL

cancel

public boolean cancel()
               throws IOException,
                      OXSAPIException
この AsyncResponse が管理する、OXS プロセスをキャンセルします。
キャンセルできるのは、ドキュメント生成中(getStatus の戻り値が OXSHandler.STATUS_GENERATING の場合)に限られます。

OXSHandler.asyncPrint の戻り値である場合、使用する OXS Print Edition 又は OXS Print Service が、 OXS の設定ファイルで type="local" と定義されている場合は、1ページ単位で生成・印刷を行うため、 ドキュメント生成中であってもキャンセルできない場合があります。

戻り値:
キャンセルに成功した場合、true
例外:
IOException - OXS との接続中に入出力エラーが発生した場合
OXSAPIException - キャンセルするための情報の取得に失敗した場合。 または、キャンセル中にOXSでエラーが発生した場合
関連項目:
getStatus, OXSHandler.STATUS_GENERATING

OPRO Japan Co.,Ltd.