Annotation Type AsyncCommand


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

    Required Elements 
    Modifier and Type Required Element Description
    java.lang.String name
    非同期実行Commandの定義名を指定します。
  • Optional Element Summary

    Optional Elements 
    Modifier and Type Optional Element Description
    CommandConfig[] command
    非同期実行するCommandを設定します。 compositeCommandが設定されている場合は、compositeCommandの設定が優先されます。 複数のCommandConnfigが設定された場合は、単純に順番に実行します。 また、Command実行結果は最後のCommandの結果が返却されます。
    CompositeCommandConfig compositeCommand
    複合Commandを利用する場合の設定です。
    java.lang.String description
    概要説明文を指定します。
    java.lang.String displayName
    表示名を指定します。
    ExceptionHandlingMode exceptionHandlingMode
    非同期処理実行時の例外発生時の処理方式を指定します。 未指定(デフォルト)の場合、ExceptionHandlingMode.RESTARTとなります。
    java.lang.String groupingKeyAttributeName
    非同期処理実行時のgroupingKeyを利用する場合の、attribute名を指定します。
    java.lang.String id
    当該定義のidです。 通常は未指定のまま(未指定の場合、メタデータのパスがidとなる)です。
    boolean overwritable
    ローカルテナントで上書き可能か否かを指定します。 デフォルトはtrueです。
    java.lang.String queue
    非同期実行する際のキュー名を指定します。 未指定(デフォルト)の場合は、デフォルトキューを利用します。
  • Element Details

    • name

      java.lang.String name
      非同期実行Commandの定義名を指定します。
      Returns:
    • id

      java.lang.String id
      当該定義のidです。 通常は未指定のまま(未指定の場合、メタデータのパスがidとなる)です。
      Returns:
      Default:
      "##default"
    • displayName

      java.lang.String displayName
      表示名を指定します。
      Returns:
      Default:
      "##default"
    • description

      java.lang.String description
      概要説明文を指定します。
      Returns:
      Default:
      "##default"
    • overwritable

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

      java.lang.String queue
      非同期実行する際のキュー名を指定します。 未指定(デフォルト)の場合は、デフォルトキューを利用します。
      Returns:
      Default:
      "##default"
    • groupingKeyAttributeName

      java.lang.String groupingKeyAttributeName
      非同期処理実行時のgroupingKeyを利用する場合の、attribute名を指定します。
      Returns:
      Default:
      "##default"
    • exceptionHandlingMode

      ExceptionHandlingMode exceptionHandlingMode
      非同期処理実行時の例外発生時の処理方式を指定します。 未指定(デフォルト)の場合、ExceptionHandlingMode.RESTARTとなります。
      Returns:
      Default:
      org.iplass.mtp.async.ExceptionHandlingMode.RESTART
    • command

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

      CompositeCommandConfig compositeCommand
      複合Commandを利用する場合の設定です。
      Returns:
      Default:
      @org.iplass.mtp.command.annotation.CompositeCommandConfig