パッケージ jakarta.resource.cci

インターフェース Interaction

  • public interface Interaction
    jakarta.resource.cci.Interaction は、コンポーネントが EIS 機能を実行できるようにします。インタラクションインスタンスは、EIS インスタンスと対話する次の方法をサポートします。
    • 入力レコード、出力レコード、InteractionSpec を受け取る execute メソッド。このメソッドは、InteractionSpec で表される EIS 関数を実行し、出力レコードを更新します
    • 入力レコードと InteractionSpec を受け取る execute メソッド。このメソッド実装は、InteractionSpec で表される EIS 関数を実行し、出力レコードを戻り値として生成します。

    インタラクションインスタンスは接続から作成され、接続インスタンスとの関連付けを維持するために必要です。close メソッドは、インタラクションのリソースアダプターによって維持されているすべてのリソースを解放します。インタラクションインスタンスを閉じても、関連する接続インスタンスは閉じないでください。

    導入:
    0.8
    バージョン:
    0.8
    作成者:
    Rahul Sharma
    関連事項:
    ResultSetSE

    • メソッドのサマリー

      すべてのメソッド   インスタンスメソッド   抽象メソッド  
      修飾子と型 メソッド 説明
      voidclearWarnings()
      このインタラクションインスタンスによって報告されたすべての警告をクリアします。
      voidclose()
      現在のインタラクションを閉じ、リソースアダプターによってこのインスタンス用に保持されているすべてのリソースを解放します。
      Recordexecute​(InteractionSpec ispec, Record input)
      InteractionSpec で表されるインタラクションを実行します。
      booleanexecute​(InteractionSpec ispec, Record input, Record output)
      InteractionSpec で表されるインタラクションを実行します。
      ConnectiongetConnection()
      インタラクションに関連付けられた接続を取得します。
      ResourceWarninggetWarnings()
      このインタラクションインスタンスに関連付けられた警告のチェーンから最初の ResourceWarning を取得します。

    • メソッドの詳細

      • close

        void close()
    throws ResourceException
        現在のインタラクションを閉じ、リソースアダプターによってこのインスタンス用に保持されているすべてのリソースを解放します。インタラクションインスタンスを閉じても、関連する接続インスタンスは閉じません。保持されているリソースを解放するために、Interaction インスタンスを明示的に閉じることをお勧めします。
        例外:
        ResourceException - インタラクションインスタンスを閉じることができませんでした。すでに閉じられているインタラクションで close を呼び出すと、この例外もスローされます。

      • getConnection

        Connection getConnection()
        インタラクションに関連付けられた接続を取得します。
        戻り値:
        インタラクションに関連付けられた接続インスタンス

      • execute

        boolean execute​(InteractionSpec ispec,
                Record input,
                Record output)
         throws ResourceException
        InteractionSpec で表されるインタラクションを実行します。この形式の呼び出しは、入力レコードを受け取り、出力レコードを更新します。
        パラメーター:
        ispec - ターゲット EIS データ / 汎用モジュールを表す InteractionSpec
        input - 入力レコード
        output - 出力レコード
        戻り値:
        EIS 関数の実行が成功し、出力レコードが更新された場合は true。それ以外の場合は false
        例外:
        ResourceException - 実行操作が失敗した場合の例外。エラーケースの例は次のとおりです。
        • リソースアダプター内部、EIS 固有、通信エラー
        • InteractionSpec、入力または出力レコード構造の指定が無効です
        • 入力または出力レコードの使用エラー
        • このインタラクションに関連付けられている無効な接続
        NotSupportedException - 操作がサポートされていません

      • execute

        Record execute​(InteractionSpec ispec,
               Record input)
        throws ResourceException
        InteractionSpec で表されるインタラクションを実行します。この形式の呼び出しは、インタラクションの実行が成功した場合、入力レコードを受け取り、出力レコードを返します。
        パラメーター:
        ispec - ターゲット EIS データ / 汎用モジュールを表す InteractionSpec
        input - 入力レコード
        戻り値:
        出力 EIS 関数の実行が成功したかどうかを記録します。それ以外の場合は null
        例外:
        ResourceException - 実行操作が失敗した場合の例外。エラーケースの例は次のとおりです。
        • リソースアダプター内部、EIS 固有、通信エラー
        • InteractionSpec または入力レコード構造の指定が無効です
        • 入力レコードの使用または出力レコードの作成のエラー
        • このインタラクションに関連付けられている無効な接続
        NotSupportedException - 操作がサポートされていません

      • getWarnings

        ResourceWarning getWarnings()
                     throws ResourceException
        このインタラクションインスタンスに関連付けられた警告のチェーンから最初の ResourceWarning を取得します。
        戻り値:
        警告チェーンの上部にある ResourceWarning
        例外:
        ResourceException - インタラクションに関連付けられた ResourceWarnings の取得に失敗しました

      • clearWarnings

        void clearWarnings()
            throws ResourceException
        この Interaction インスタンスによって報告されたすべての警告をクリアします。このメソッドを呼び出した後、この Interaction に対して新しい警告が報告されるまで、メソッド getWarnings は null を返します。
        例外:
        ResourceException - インタラクションに関連付けられた ResourceWarnings のクリアに失敗しました