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

注釈インタフェース AsyncCommand

@Repeatable(AsyncCommands.class) @Retention(RUNTIME) @Target(TYPE) public @interface AsyncCommand
非同期実行Commandの定義です。

  • 要素の詳細

    • id

      String id
      当該定義のidです。 通常は未指定のまま（未指定の場合、メタデータのパスがidとなる）です。
      戻り値:
      デフォルト:
      "##default"

    • name

      String name
      非同期実行Commandの定義名を指定します。
      戻り値:

    • displayName

      String displayName
      表示名を指定します。
      戻り値:
      デフォルト:
      "##default"

    • description

      String description
      概要説明文を指定します。
      戻り値:
      デフォルト:
      "##default"

    • overwritable

      boolean overwritable
      ローカルテナントで上書き可能か否かを指定します。 デフォルトはtrueです。
      戻り値:
      デフォルト:
      true

    • queue

      String queue
      非同期実行する際のキュー名を指定します。 未指定（デフォルト）の場合は、デフォルトキューを利用します。
      戻り値:
      デフォルト:
      "##default"

    • groupingKeyAttributeName

      String groupingKeyAttributeName
      非同期処理実行時のgroupingKeyを利用する場合の、attribute名を指定します。
      戻り値:
      デフォルト:
      "##default"

    • exceptionHandlingMode

      ExceptionHandlingMode exceptionHandlingMode
      非同期処理実行時の例外発生時の処理方式を指定します。 未指定（デフォルト）の場合、ExceptionHandlingMode.RESTARTとなります。
      戻り値:
      デフォルト:
      RESTART

    • command

      CommandConfig[] command
      非同期実行するCommandを設定します。 compositeCommandが設定されている場合は、compositeCommandの設定が優先されます。 複数のCommandConnfigが設定された場合は、単純に順番に実行します。 また、Command実行結果は最後のCommandの結果が返却されます。
      戻り値:
      デフォルト:
      {@org.iplass.mtp.command.annotation.CommandConfig}

    • compositeCommand

      CompositeCommandConfig compositeCommand
      複合Commandを利用する場合の設定です。
      戻り値:
      デフォルト:
      @org.iplass.mtp.command.annotation.CompositeCommandConfig