Annotation Type JmsListener

@Target({METHOD,ANNOTATION_TYPE})
@Retention(RUNTIME)
@Documented
@Repeatable(JmsListeners.class)
@MessageMapping
public @interface JmsListener

Annotation that marks a method to be the target of a JMS message listener on the specified destination(). The containerFactory() identifies the JmsListenerContainerFactory to use to build the JMS listener container. If not set, a default container factory is assumed to be available with a bean name of jmsListenerContainerFactory unless an explicit default has been provided through configuration.

Consider setting up a custom DefaultJmsListenerContainerFactory bean. For production purposes, you'll typically fine-tune timeouts and recovery settings. Most importantly, the default 'AUTO_ACKNOWLEDGE' mode does not provide reliability guarantees, so make sure to use transacted sessions in case of reliability needs.

Processing of @JmsListener annotations is performed by registering a JmsListenerAnnotationBeanPostProcessor. This can be done manually or, more conveniently, through the <jms:annotation-driven/> element or @EnableJms annotation.

Annotated JMS listener methods are allowed to have flexible signatures similar to what MessageMapping provides:

• Session to get access to the JMS session
• Message or one of its subclasses to get access to the raw JMS message
• Message to use Spring's messaging abstraction counterpart
• @Payload-annotated method arguments, including support for validation
• @Header-annotated method arguments to extract specific header values, including standard JMS headers defined by JmsHeaders
• @Headers-annotated method argument that must also be assignable to Map for obtaining access to all headers
• MessageHeaders arguments for obtaining access to all headers
• MessageHeaderAccessor or JmsMessageHeaderAccessor for convenient access to all method arguments

Annotated methods may have a non-void return type. When they do, the result of the method invocation is sent as a JMS reply to the destination defined by the JMSReplyTO header of the incoming message. If this header is not set, a default destination can be provided by adding @SendTo to the method declaration.

This annotation may be used as a meta-annotation to create custom composed annotations with attribute overrides.