com.microsoft.azure.spring.messaging.annotation

Annotation Type AzureMessageListener

@Target(value={METHOD,ANNOTATION_TYPE})
 @Retention(value=RUNTIME)
 @Documented
 @MessageMapping
 @Repeatable(value=AzureMessageListeners.class)
public @interface AzureMessageListener

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

Processing of @AzureMessageListener annotations is performed by registering a AzureListenerAnnotationBeanPostProcessor. This can be done through the @EnableAzureMessaging annotation.

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

• 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 Azure headers defined by
• @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 access to all method arguments

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

Author:

Warren Zhu

See Also:

EnableAzureMessaging, AzureListenerAnnotationBeanPostProcessor

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
String	destination The destination name for this listener, resolved through the container-wide DestinationResolver strategy.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
String	concurrency The concurrency limits for the listener, if any.
String	containerFactory The bean name of the ListenerContainerFactory to use to create the message listener container responsible for serving this endpoint.
String	group The name for the durable group, if any.
String	id The unique identifier of the container managing this endpoint.

Element Detail

destination

public abstract String destination

The destination name for this listener, resolved through the container-wide DestinationResolver strategy.

id

public abstract String id

The unique identifier of the container managing this endpoint.

If none is specified, an auto-generated one is provided.

Default:

""

containerFactory

public abstract String containerFactory

The bean name of the ListenerContainerFactory to use to create the message listener container responsible for serving this endpoint.

If not specified, the default container factory is used, if any.

Default:

""

group

public abstract String group

The name for the durable group, if any.

Default:

""

concurrency

public abstract String concurrency

The concurrency limits for the listener, if any. Overrides the value defined by the container factory used to create the listener container.

The concurrency limits can be a "lower-upper" String — for example, "5-10" — or a simple upper limit String — for example, "10", in which case the lower limit will be 1.

Note that the underlying container may or may not support all features. For instance, it may not be able to scale, in which case only the upper limit is used.

Default:

""