アプリケーションビューコントロール用の基本インタフェースです。

構文

public interface ApplicationViewControl extends Control

備考

このインタフェースのメソッドは、アプリケーションビューコントロールのインスタンスを含む任意の Web サービスによって呼び出すことができます。

メンバー

コンストラクタ

なし。

メソッド

public void beginLocalTransaction() throws Exception

このコントロール上でローカルトランザクションを開始します。これにより、基底のアプリケーションビューインスタンス上でローカルトランザクションが開始されます。このメソッドの呼び出しと commitLocalTransaction() または rollbackLocalTransaction() の呼び出しの間に、このコントロールインスタンスによって行われたすべての処理は、1 つの単位としてそれぞれ、コミットされるか、またはロールバックされます。

このコントロールのアプリケーションビューによって使用される基底のアダプタがローカルトランザクションをサポートしていない場合は、例外が送出されます。

public void commitLocalTransaction() throws Exception

このコントロールのアクティブなローカルトランザクションをコミットします。beginLocalTransaction() の最後の呼び出し以降、行われたすべての処理は、EIS の永続的な状態にコミットされます。

public void disableEventDelivery() throws Exception

このコントロールがイベント通知を配信しなくなることを示します。イベント配信が有効でないときに、このメソッドを呼び出しても効果はありません。

public void enableEventDelivery() throws Exception

このコントロールインスタンスによって、そのコンテナ JWS インスタンスへのイベント通知が行われることを示します。含まれる JWS は会話形式でなければなりません。イベントは、MODE_ALLOW_DUPS 受信モードを使用して配信されます。イベント配信が既に有効なときに、このメソッドを呼び出しても効果はありません。

public void enableEventDelivery(String receiveMode) throws Exception

このコントロールインスタンスによるコンテナ JWS インスタンスへのイベント通知が、指定された受信モードで行われることを示します。含まれる JWS は会話形式でなければなりません。イベント配信が既に有効なときに、このメソッドを呼び出しても効果はありません。

receiveMode は、すべてのイベントが受信されるモードを指定します。以下で定義される MODE_XXX フィールドのいずれかでなければなりません。

public String getEventReceiveMode()

enableEventDelivery() の最後の呼び出しで指定された受信モードを返します。イベント配信が有効でない場合は null を返します。返されるモードは、以下で定義される MODE_XXX フィールドのいずれかです。

public void importJar(String jarFileName, boolean overwrite, boolean deploy, List errors, PrintWriter out, boolean quiet) throws Exception

以前にエクスポートされたアプリケーションビュー JAR ファイルをインポートします。このファイルには、アプリケーションビュー、接続ファクトリ、フォルダ、およびスキーマの定義が含まれます。

jarFileName: インポートされる jar への絶対パス、またはシステムクラスパスで jar を検索するための適切なリソース名のいずれか（例 : samples/appview/Sample1.jar）。このメソッドは、jarFileName をまずパスとして解釈し、そのファイルが存在しない場合にクラスパスでのファイルの検索を試みます。

overwrite: インポートされるオブジェクトによって、リポジトリ内に既に存在するオブジェクトが上書きされるかどうかを示すフラグです。

deploy: インポートされるデプロイ可能なオブジェクトが、インポート後自動的にデプロイされるかどうかを示すフラグです。

errors: インポート終了時のエラーリストです。発生した致命的でないエラーが含まれます。致命的なエラーは、このメソッドによって送出される例外で報告されます。

out: すべてのメッセージが書き込まれる PrintWriter インスタンスです。null の場合は、メッセージは何も書き込まれません。

quiet: メッセージをほとんど表示せずにインポートが処理されるかどうかを示すフラグです。

インポート時に致命的なエラーが発生した場合には、例外が送出されます。

public String importJar(String jarFileName) throws Exception

以前にエクスポートされたアプリケーションビュー JAR ファイルを、標準のオプションを使用してインポートします。このメソッドは、jar にあるオブジェクトと同名の既存のオブジェクトを上書きし、デプロイ可能なオブジェクトをデプロイし、System.out に処理の概略を出力します。致命的でないエラーが発生した場合、このメソッドはエラーの概略を System.out に出力します。

jarFileName : インポートされる jar への絶対パス、またはシステムクラスパス上で jar を検索するための適切なリソース名のいずれか（例 : samples/appview/Sample1.jar）。このメソッドは、jarFileName をまずパスとして解釈し、そのファイルが存在しない場合にクラスパスでのファイルの検索を試みます。

致命的でないエラーなど、インポート処理に関する説明を示す文字列を返します。

インポート時に致命的なエラーが発生した場合には、例外が送出されます。

public boolean isEventDeliveryEnabled()

イベント配信が有効な場合に true を返し、それ以外の場合は false を返します。enableEventDelivery() を呼び出してから disableEventDelivery() を呼び出すまで、true になります。

public void rollbackLocalTransaction() throws Exception

このコントロールのアクティブなローカルトランザクションをロールバックします。beginLocalTransaction() の最後の呼び出し以降、行われたすべての処理は破棄されます。

フィールド

static public final String MODE_ALLOW_DUPS

特定のイベントを複数回受信してもよい場合に、このモードを使用します。通常はシステムシャットダウンやシステム障害が発生した場合にのみ複数回受信する可能性があり、通常の処理中には発生しません。このモードはデフォルトであり、最高のパフォーマンスを実現します。

static public final String MODE_ONCE_AND_ONLY_ONCE

すべてのイベントを受信し、システム障害が発生したときでも各イベントの受信は 1 回だけにする場合に、このモードを使用します。このモードは、MODE_ALLOW_DUPS を使用する場合に比べて若干パフォーマンスが低下します。

イベント

public void onEvent(Object event) throws Exception;

onEvent イベントは、アプリケーションビューイベントが受信されると生成されます。このメソッドはプライベートメソッドであり、JWS クライアントでは使用できません。

event: EIS でのイベントを表すイベントオブジェクトです。

public void onAsyncServiceResponse(Object asr) throws Exception;

onAsyncServiceResponse イベントは、アプリケーションビュー非同期応答が受信されると生成されます。このメソッドはプライベートメソッドであり、JWS クライアントでは使用できません。

event: 非同期サービス呼び出しからの応答を表す非同期応答オブジェクトです。

public void onAsyncServiceError(String requestID, String errorMessage) throws Exception

onAsyncServiceError イベントは、アプリケーションビュー非同期要求がエラーで終了すると生成されます。

requestID: この要求が送信されたときに返される識別子です。

errorMessage: 発生したエラーのテキストです。