Package org.axonframework.messaging.core.annotation

Annotation Interface Message

@Internal
@Retention(RUNTIME)
@Target(ANNOTATION_TYPE)
public @interface Message

Meta-annotation used to have a common grounds for the name() and version() for more specific Message annotation.

Furthermore, allows for annotation scanning on a more generic level than per message type.

Since:

5.0.0

Author:

Steven van Beelen

Required Element Summary

Required Elements

Modifier and Type	Required Element	Description
Class<? extends Message>	messageType	The type of Message this annotation applies to.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
String	name	The business or domain name of the annotated message.
String	namespace	The namespace or (bounded) context of the annotated message.
String	version	The version of the annotated message.

Element Details

namespace

String namespace

The namespace or (bounded) context of the annotated message.

Will typically be mapped to the QualifiedName.namespace(). Whenever this attribute is defined, the name() will become the QualifiedName.localName(). Together they would form the QualifiedName.name().

Returns:

The namespace or (bounded) context of the annotated message.

Default:

""

name

String name

The business or domain name of the annotated message.

Will typically be mapped to a QualifiedName(String) and inserted into a MessageType. By using the String-based constructor of the QualifiedName, this field will represent the combination of the QualifiedName.localName() and QualifiedName.namespace().

If the namespace() has also been specified, this attribute will reflect the QualifiedName.localName() only.

Returns:

The business or domain name of the annotated message.

Default:

""

version

String version

The version of the annotated message.

Will typically be mapped to the MessageType.version(). Defaults to MessageType.DEFAULT_VERSION.

Returns:

The version of the annotated message.

Default:

"0.0.1"

messageType

Class<? extends Message> messageType

The type of Message this annotation applies to.

Returns:

The type of Message this annotation applies to.