de.otto.synapse.annotation

Annotation Type EnableMessageSenderEndpoint

@Target(value=TYPE)
 @Retention(value=RUNTIME)
 @Documented
 @Import(value={MessageSenderEndpointBeanRegistrar.class,SynapseAutoConfiguration.class})
 @Repeatable(value=EnableMessageSenderEndpoints.class)
public @interface EnableMessageSenderEndpoint

Required Element Summary

Required Elements

Modifier and Type	Required Element and Description
java.lang.String	channelName The name of the message queue.
java.lang.Class<? extends Selector>	selector Selector used to select one of possibly multiple available MessageSenderEndpointFactory instances.

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element and Description
MessageFormat	messageFormat The MessageFormat for the message to be sent.
java.lang.String	name The name of the registered MessageSenderEndpoint 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:

channel name

selector

public abstract java.lang.Class<? extends Selector> selector

Selector used to select one of possibly multiple available MessageSenderEndpointFactory instances.

Example: the SqsMessageSenderEndpointFactory matches both MessageQueue.class and Sqs.class. The following usage of the annotation is selecting the SqsMessageSenderEndpointFactory using the more specific SQS selector class:

  @Configuration
  @EnableMessageSenderEndpoint(
      channelName = "some-sqs-queue",
      selector = Sqs.class)
 class MyExampleConfiguration {
 }
 

Returns:

Selector class

name

public abstract java.lang.String name

The name of the registered MessageSenderEndpoint 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 "MessageQueueSenderEndpoint" is appended. A channel named "my-channel" will therefore result in a bean name "myChannelMessageQueueSenderEndpoint".

Returns:

bean name

Default:

""

messageFormat

public abstract MessageFormat messageFormat

The MessageFormat for the message to be sent. Default: V1

Returns:

message format

Default:

de.otto.synapse.translator.MessageFormat.V1