Annotation Interface HandleCommand


Marks a method or constructor as a handler for command messages (MessageType.COMMAND).

Command handlers typically represent intent to perform an action or change state. They often return a result, which is published to the result log unless marked passive.

This annotation is a concrete specialization of HandleMessage for commands.

See Also:
  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    Class<?>[]
    Restricts which payload types this handler may be invoked for.
    boolean
    If true, disables this handler during discovery.
    boolean
    If true, this handler is considered passive and will not emit a result message.
  • Element Details

    • disabled

      boolean disabled
      If true, disables this handler during discovery.
      Default:
      false
    • passive

      boolean passive
      If true, this handler is considered passive and will not emit a result message. Useful when the handler is for side effects only.
      Default:
      false
    • allowedClasses

      Class<?>[] allowedClasses
      Restricts which payload types this handler may be invoked for.
      Default:
      {}