Package de.otto.synapse.annotation

Annotation Type EnableMessageLogReceiverEndpoint

@Target(TYPE)
@Retention(RUNTIME)
@Documented
@Import({MessageLogReceiverEndpointBeanRegistrar.class,MessageLogReceiverEndpointAutoConfiguration.class})
@Repeatable(EnableMessageLogReceiverEndpoints.class)
public @interface EnableMessageLogReceiverEndpoint

Required Element Summary

Required Elements

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

Optional Element Summary

Optional Elements

Modifier and Type	Optional Element	Description
java.lang.String	name	The name of the registered MessageLogReceiverEndpoint bean.
java.lang.Class<? extends MessageLog>	selector	Selector used to select one of possibly multiple available MessageLogReceiverEndpointFactory instances used to create the MessageLogReceiverEndpoint.
java.lang.String	startFrom	Specifies where to start reading from the message log.

Element Detail

channelName

java.lang.String channelName

The name of the message-log channel.

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

Returns:

channel name

name

java.lang.String name

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

Returns:

bean name

Default:

""

startFrom

java.lang.String startFrom

Specifies where to start reading from the message log.

Possible Values:

• HORIZON (default): Start reading from the oldest available message
• LATEST: Start reading from the latest message

Returns:

LATEST or HORIZON

Default:

"HORIZON"

selector

java.lang.Class<? extends MessageLog> selector

Selector used to select one of possibly multiple available MessageLogReceiverEndpointFactory instances used to create the MessageLogReceiverEndpoint.

Example: the KafkaMessageLogReceiverEndpointFactory matches both MessageLog.class and Kafka.class. The following usage of the annotation is selecting the KafkaMessageLogReceiverEndpointFactory using the more specific Kafka selector:

 @Configuration
 @EnableMessageLogReceiverEndpoint(
      channelName = "some-log",
      selector = Kafka.class)
 class MyExampleConfiguration {
 }
 

Returns:

MessageLog selector class

Default:

de.otto.synapse.channel.selector.MessageLog.class