Package org.axonframework.messaging.annotation

Class AnnotatedMessageHandlingMember<T>

java.lang.Object
org.axonframework.messaging.annotation.AnnotatedMessageHandlingMember<T>
Type Parameters:
T - the target type
All Implemented Interfaces:
MessageHandlingMember<T>
public class AnnotatedMessageHandlingMember<T> extends Object implements MessageHandlingMember<T>
Implementation of a MessageHandlingMember that is used to invoke message handler methods on the target type.
Since:
3.0
Author:
Allard Buijze

  • Constructor Details

    • AnnotatedMessageHandlingMember

      public AnnotatedMessageHandlingMember(Executable executable, Class<? extends Message> messageType, Class<?> explicitPayloadType, ParameterResolverFactory parameterResolverFactory)
      Initializes a new instance that will invoke the given executable (method) on a target to handle a message of the given messageType.
      Parameters:
      executable - the method to invoke on a target
      messageType - the type of message that is expected by the target method
      explicitPayloadType - the expected message payload type
      parameterResolverFactory - factory used to resolve method parameters

  • Method Details

    • payloadType

      public Class<?> payloadType()
      Description copied from interface: MessageHandlingMember
      Returns the payload type of messages that can be processed by this handler.
      Specified by:
      payloadType in interface MessageHandlingMember<T>
      Returns:
      The payload type of messages expected by this handler

    • canHandle

      public boolean canHandle(@Nonnull Message<?> message)
      Description copied from interface: MessageHandlingMember
      Checks if this handler is capable of handling the given message.
      Specified by:
      canHandle in interface MessageHandlingMember<T>
      Parameters:
      message - The message that is to be handled
      Returns:
      true if the handler is capable of handling the message, false otherwise

    • canHandleType

      public boolean canHandleType(@Nonnull Class<?> payloadType)
      Description copied from interface: MessageHandlingMember
      Checks if this handler is capable of handling messages with the given payloadType.
      Specified by:
      canHandleType in interface MessageHandlingMember<T>
      Parameters:
      payloadType - The payloadType of a message that is to be handled
      Returns:
      true if the handler is capable of handling the message with given type, false otherwise

    • canHandleMessageType

      public boolean canHandleMessageType(@Nonnull Class<? extends Message> messageType)
      Description copied from interface: MessageHandlingMember
      Checks if this handlers is capable of handling Message implementations of the given messageType.

      It is recommended to suppress the raw type use validation of the messageType parameter when implementing this method, as usage of this method with a Message generic would required reflection or casting otherwise.

      Specified by:
      canHandleMessageType in interface MessageHandlingMember<T>
      Parameters:
      messageType - the Message's type to check if it can be handled by this handler
      Returns:
      true if this handler can handle the given messageType, false otherwise

    • typeMatches

      protected boolean typeMatches(Message<?> message)
      Checks if this member can handle the type of the given message. This method does not check if the parameter resolvers of this member are compatible with the given message. Use parametersMatch(Message) for that.
      Parameters:
      message - the message to check for
      Returns:
      true if this member can handle the message type. false otherwise

    • parametersMatch

      protected boolean parametersMatch(Message<?> message)
      Checks if the parameter resolvers of this member are compatible with the given message.
      Parameters:
      message - the message to check for
      Returns:
      true if the parameter resolvers can handle this message. false otherwise

    • handle

      public Object handle(@Nonnull Message<?> message, T target) throws Exception
      Description copied from interface: MessageHandlingMember
      Handles the given message by invoking the appropriate method on given target. This may result in an exception if the given target is not capable of handling the message or if an exception is thrown during invocation of the method.
      Specified by:
      handle in interface MessageHandlingMember<T>
      Parameters:
      message - The message to handle
      target - The target to handle the message
      Returns:
      The message handling result in case the invocation was successful
      Throws:
      Exception - when there was a problem that prevented invocation of the method or if an exception was thrown from the invoked method

    • hasAnnotation

      public boolean hasAnnotation(Class<? extends Annotation> annotationType)
      Description copied from interface: MessageHandlingMember
      Checks whether the method of the target entity contains the given annotationType.
      Specified by:
      hasAnnotation in interface MessageHandlingMember<T>
      Parameters:
      annotationType - Annotation to check for on the target method
      Returns:
      true if the annotation is present on the target method, false otherwise

    • annotationAttributes

      public Optional<Map<String,Object>> annotationAttributes(Class<? extends Annotation> annotationType)
      Description copied from interface: MessageHandlingMember
      Get the attributes of an annotation of given annotationType on the method of the target entity. If the annotation is present on the target method an Optional is returned containing the properties mapped by their name. If the annotation is not present an empty Optional is returned.
      Specified by:
      annotationAttributes in interface MessageHandlingMember<T>
      Parameters:
      annotationType - The annotation to check for on the target method
      Returns:
      An optional containing a map of the properties of the annotation, or an empty optional if the annotation is missing on the method

    • attribute

      public <R> Optional<R> attribute(String attributeKey)
      Description copied from interface: MessageHandlingMember
      Retrieve a single attributes for the given attributeKey. If this MessageHandlingMember does not hold a value referencing the attributeKey, an Optional.empty() is returned. Otherwise a non-empty Optional containing the attribute will be provided.

      When using the method, consider checking the HandlerAttributes for a list of common handler attributes.

      Specified by:
      attribute in interface MessageHandlingMember<T>
      Parameters:
      attributeKey - the key to retrieve an attribute for
      Returns:
      a non-empty Optional of the attribute referencing the given attributeKey. Otherwise an Optional.empty() will be returned

    • unwrap

      public <H> Optional<H> unwrap(Class<H> handlerType)
      Description copied from interface: MessageHandlingMember
      Returns the wrapped handler object if its type is an instance of the given handlerType. For instance, if this method is invoked with Executable and the message is handled by a method of the target entity, then this method will return the method handle as a Method.
      Specified by:
      unwrap in interface MessageHandlingMember<T>
      Type Parameters:
      H - The wrapped handler type
      Parameters:
      handlerType - The expected type of the wrapped handler
      Returns:
      An Optional containing the wrapped handler object or an empty Optional if the handler is not an instance of the given handlerType

    • toString

      public String toString()
      Overrides:
      toString in class Object

    • hashCode

      public int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public boolean equals(Object o)
      Overrides:
      equals in class Object