de.otto.synapse.annotation.messagequeue

Annotation Type EnableMessageQueueReceiverEndpoint

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Import(value=MessageQueueReceiverEndpointBeanRegistrar.class)
 @Repeatable(value=EnableMessageQueueReceiverEndpoints.class)
public @interface EnableMessageQueueReceiverEndpoint

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	channelName The name of the message queue.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
java.lang.String	messageQueueReceiverEndpoint The name of the MessageLogReceiverEndpoint bean that is used to create the MessageQueueReceiverEndpoint bean.
java.lang.String	name The name of the registered EventSource bean.

Element Detail

channelName

public abstract java.lang.String channelName

The name of the message queue.

Resolving placeholders like "${my.channel.name}" is supported for this property.

Returns:

stream name

name

public abstract java.lang.String name

The name of the registered EventSource bean.

If #name is not set, the name of the bean is derived from the name of the message channel. The name is constructed by tranforming hyphenated variable naming convention, e.g., "my-channel" into the Spring bean naming convention, e.g., "myChannel". After this conversion, the string "EventSource" is appended. A channel named "my-channel" will therefore result in a bean name "myChannelEventSource".

Returns:

bean name

Default:

""

messageQueueReceiverEndpoint

public abstract java.lang.String messageQueueReceiverEndpoint

The name of the MessageLogReceiverEndpoint bean that is used to create the MessageQueueReceiverEndpoint bean.

If messageLogReceiverEndpoint is not set, the name of the bean is derived from the name of the message channel. The name is constructed by tranforming hyphenated variable naming convention, e.g., "my-channel" into the Spring bean naming convention, e.g., "myChannel". After this conversion, the string "MessageLogReceiverEndpoint" is appended. A channel named "my-channel" will therefore result in a bean name "myChannelMessageLogReceiverEndpoint".

The MessageQueueReceiverEndpointBeanRegistrar is responsible for creating the EventSources specified by this annotation. The bean name, either specified or derived from the channelName, will be used by the MessageQueueReceiverEndpointBeanRegistrar as the name of the registered message log bean. If a bean having this name already exists, a BeanCreationException will be thrown during startup.

Returns:

bean name of the MessageQueueReceiverEndpoint

Default:

""