Package org.axonframework.deadline.annotation

Annotation Interface DeadlineHandler

@Retention(RUNTIME) @Target({METHOD,ANNOTATION_TYPE}) @MessageHandler(messageType=DeadlineMessage.class) public @interface DeadlineHandler
Annotation used to mark handlers which are capable of handling a DeadlineMessage. It is a specialization of MessageHandler where the messageType is set to DeadlineMessage. Hence, any parameter injection that works for event handlers works for deadline handlers as well.
Since:
3.3.0
Author:
Milan Savic, Steven van Beelen
See Also:

  • Optional Element Summary

    Optional Elements
    Modifier and Type
    Optional Element
    Description
    String
    deadlineName
    The name of the deadline this handler listens to.
    Class<?>
    payloadType
    Specifies the type of message payload that can be handled by the member method.

  • Element Details

    • deadlineName

      String deadlineName
      The name of the deadline this handler listens to. Defaults to an empty String, meaning the handler accepts deadlines of any name. A handler declaring a specific name takes precedence over one accepting any name.
      Returns:
      the name of the deadline this handler listens to, or an empty String to accept any deadline
      Default:
      ""

    • payloadType

      Class<?> payloadType
      Specifies the type of message payload that can be handled by the member method. The payload of the message should be assignable to this type. Defaults to any Object.
      Returns:
      the payload type handled by the function annotated with @DeadlineHandler
      Default:
      java.lang.Object.class