de.otto.synapse.annotation.EnableMessageSenderEndpoint Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of synapse-core Show documentation

A library used at otto.de to implement Spring Boot based event-sourcing microservices.

There is a newer version: 0.33.1

package de.otto.synapse.annotation;

import de.otto.synapse.channel.selector.MessageQueue;
import de.otto.synapse.channel.selector.Selector;
import de.otto.synapse.configuration.SynapseAutoConfiguration;
import de.otto.synapse.translator.MessageFormat;
import org.springframework.context.annotation.Import;

import java.lang.annotation.*;


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

    /**
     * The name of the message queue.
     * 
     * Resolving placeholders like "${my.channel.name}" is supported for this property.
     * 
     *
     * @return channel name
     */
    String channelName();

    /**
     * The name of the registered {@link de.otto.synapse.endpoint.sender.MessageSenderEndpoint} bean.
     * 
     * If {@code #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".
     * 
     *
     * @return bean name
     */
    String name() default "";

    /**
     * The {@link MessageFormat} for the message to be sent.
     * Default: V1
     *
     * @return message format
     */
    MessageFormat messageFormat() default MessageFormat.V1;

    /**
     * Selector used to select one of possibly multiple available
     * {@link de.otto.synapse.endpoint.sender.MessageSenderEndpointFactory} instances.
     *
     * 
     * Example: the SqsMessageSenderEndpointFactory matches both {@link MessageQueue MessageQueue.class}
     * and Sqs.class. The following usage of the annotation is selecting the SqsMessageSenderEndpointFactory
     * using the more specific SQS selector class:
     * 
     * 
     * {@literal @}Configuration
     * {@literal @}EnableMessageSenderEndpoint(
     *      channelName = "some-sqs-queue",
     *      selector = Sqs.class)
     * class MyExampleConfiguration {
     * }
     * 
     *
     * @return Selector class
     */
    Class selector();

}