Annotation Interface HandleCommand
@Documented
@Retention(RUNTIME)
@Target({METHOD,CONSTRUCTOR})
@HandleMessage(COMMAND)
public @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 ElementsModifier and TypeOptional ElementDescriptionClass<?>[]
Restricts which payload types this handler may be invoked for.boolean
Iftrue
, disables this handler during discovery.boolean
Iftrue
, this handler is considered passive and will not emit a result message.
-
Element Details
-
disabled
boolean disabledIftrue
, disables this handler during discovery.- Default:
false
-
passive
boolean passiveIftrue
, 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<?>[] allowedClassesRestricts which payload types this handler may be invoked for.- Default:
{}
-