パッケージ org.iplass.mtp.command

インタフェース CommandInvoker

  • すべてのスーパーインタフェース:
    Manager

    public interface CommandInvoker
    extends Manager
    Commandをコード中より呼び出す際に利用するインタフェースです。 CommandInvokerを利用してCommandを呼び出す場合と、直接Commandのexecuteを呼び出す場合の違いは、 CommandInterceptorの処理(トランザクション制御など)が実行されるか否かです。
    • メソッドの概要

      修飾子とタイプ メソッド 説明
      java.lang.String execute​(java.lang.String cmdName, RequestContext request)
      指定のcmdNameのCommandのインスタンスを指定のrequestで呼び出します。
      java.lang.String execute​(java.lang.String cmdName, RequestContext request, TransactionOption transactionOption)
      指定のcmdNameのCommandのインスタンスを指定のrequest、transactionOptionで呼び出します。
      java.lang.String execute​(Command cmd, RequestContext request)
      指定のcmdを指定のrequestで呼び出します。
      java.lang.String execute​(Command cmd, RequestContext request, TransactionOption transactionOption)
      指定のcmdを指定のrequest、transactionOptionで呼び出します。
      long executeAsync​(java.lang.String asyncCmdName, AsyncRequestContext request)
      指定のasyncCmdNameで定義される非同期Commandを指定のrequestで実行します。
      long executeAsync​(java.lang.String asyncCmdName, AsyncRequestContext request, ResultHandler resultHandler)
      指定のasyncCmdNameで定義される非同期Commandを指定のrequestで実行します。
      Command getCommandInstance​(java.lang.String cmdName)
      指定のcmdNameのCommandの新規インスタンスを取得します。
    • メソッドの詳細

      • execute

        java.lang.String execute​(java.lang.String cmdName,
                                 RequestContext request)
        指定のcmdNameのCommandのインスタンスを指定のrequestで呼び出します。
        パラメータ:
        cmdName - Command定義の名前(CommandDefinitionで定義した際の名前、CommandClassアノテーションで指定したname)
        request - RequestContextのインスタンス
        戻り値:
        Commandが返却する結果ステータス
      • execute

        java.lang.String execute​(java.lang.String cmdName,
                                 RequestContext request,
                                 TransactionOption transactionOption)
        指定のcmdNameのCommandのインスタンスを指定のrequest、transactionOptionで呼び出します。
        パラメータ:
        cmdName - Command定義の名前(CommandDefinitionで定義した際の名前、CommandClassアノテーションで指定したname)
        request - RequestContextのインスタンス
        transactionOption - トランザクション制御設定
        戻り値:
        Commandが返却する結果ステータス
      • execute

        java.lang.String execute​(Command cmd,
                                 RequestContext request)
        指定のcmdを指定のrequestで呼び出します。
        パラメータ:
        cmd - Commandのインスタンス
        request - RequestContextのインスタンス
        戻り値:
        Commandが返却する結果ステータス
      • execute

        java.lang.String execute​(Command cmd,
                                 RequestContext request,
                                 TransactionOption transactionOption)
        指定のcmdを指定のrequest、transactionOptionで呼び出します。
        パラメータ:
        cmd - Commandのインスタンス
        request - RequestContextのインスタンス
        transactionOption - トランザクション制御設定
        戻り値:
        Commandが返却する結果ステータス
      • getCommandInstance

        Command getCommandInstance​(java.lang.String cmdName)
        指定のcmdNameのCommandの新規インスタンスを取得します。 指定したCommandをexecute(Command, RequestContext)で実行することが可能です。 呼び出し前にCommandの初期化処理(メンバ変数の値の設定)を行うことが可能です。
        パラメータ:
        cmdName - Command定義の名前(CommandDefinitionで定義した際の名前、CommandClassアノテーションで指定したname)
        戻り値:
        Commandが返却する結果ステータス
      • executeAsync

        long executeAsync​(java.lang.String asyncCmdName,
                          AsyncRequestContext request)
        指定のasyncCmdNameで定義される非同期Commandを指定のrequestで実行します。 非同期Commandは、AsyncTaskManager経由で実行されます。
        パラメータ:
        asyncCmdName - AsyncCommand定義の名前(AsyncCommandDefinitionで定義した際の名前、AsyncCommandアノテーションで指定したname)
        request - 非同期Commandへのrequest
        戻り値:
        非同期タスクのタスクID
        関連項目:
        AsyncTaskManager
      • executeAsync

        long executeAsync​(java.lang.String asyncCmdName,
                          AsyncRequestContext request,
                          ResultHandler resultHandler)
        指定のasyncCmdNameで定義される非同期Commandを指定のrequestで実行します。 非同期Commandは、AsyncTaskManager経由で実行されます。 resultHandlerにて、Commandの実行ステータスによる処理を設定することが可能です。 ResultHandlerの標準提供の実装として、WriteToEntityHandlerがあります。
        パラメータ:
        asyncCmdName - AsyncCommand定義の名前(AsyncCommandDefinitionで定義した際の名前、AsyncCommandアノテーションで指定したname)
        request - 非同期Commandへのrequest
        resultHandler - ResultHandlerのインスタンス(Serializbleの必要あり)
        戻り値:
         非同期タスクのタスクID
        関連項目:
        AsyncTaskManager