io.micronaut.jms.annotations

Annotation Type Topic

@Documented
 @Retention(value=RUNTIME)
 @Target(value=METHOD)
 @Executable(processOnStartup=true)
 @MessageMapping
public @interface Topic

Annotation to bind a Topic to a method for receiving or sending a Message.

Usage:

 @JMSListener("myConnectionFactory")
 public class Listener {
      @Topic("my-topic")
      public <T> void handle(@Body T body, @Header(JMSHeaders.JMS_MESSAGE_ID) String messageID) {
          // do some logic with body and messageID
      }

      @Topic("my-topic-2")
      public <T> void handle(@Body T body, @Header("X-Arbitrary-Header") String arbitraryHeader) {
          // do some logic with body and arbitraryHeader
      }
 }
 

Since:

1.0.0

Author:

Elliott Pope

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	value The name of the topic to target.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
int	acknowledgeMode
java.lang.String	executor The name of an ExecutorService in the bean context to execute tasks on when receiving a Message as part of a JMSListener.
java.lang.String	serializer The name of a Serializer in the bean context to use to serialize an object into a Message when sending.
boolean	transacted Whether message receipt is transacted.

Element Detail

value

@AliasFor(annotation=io.micronaut.messaging.annotation.MessageMapping.class,
          member="value")
public abstract java.lang.String value

The name of the topic to target.

Returns:

the name

executor

public abstract java.lang.String executor

The name of an ExecutorService in the bean context to execute tasks on when receiving a Message as part of a JMSListener. The executor can be maintained by Micronaut using the io.micronaut.scheduling.executor.UserExecutorConfiguration.

Returns:

the executor service name

Default:

""

serializer

public abstract java.lang.String serializer

The name of a Serializer in the bean context to use to serialize an object into a Message when sending. If not specified, defaults to DefaultSerializerDeserializer.

Returns:

the serializer bean name

Default:

""

acknowledgeMode

public abstract int acknowledgeMode

Returns:

the acknowledge mode for the JMSListenerContainer.

See Also:

Session

Default:

1

transacted

public abstract boolean transacted

Whether message receipt is transacted. The broker must support transacted sessions.

Returns:

true if transacted

See Also:

Session

Default:

false