de.otto.synapse.annotation.EnableMessageQueueReceiverEndpoint 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.configuration.MessageQueueReceiverEndpointAutoConfiguration;
import org.springframework.context.annotation.Import;

import java.lang.annotation.*;


@Target(ElementType.TYPE)
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Import({MessageQueueReceiverEndpointBeanRegistrar.class, MessageQueueReceiverEndpointAutoConfiguration.class})
@Repeatable(EnableMessageQueueReceiverEndpoints.class)
public @interface EnableMessageQueueReceiverEndpoint {

    /**
     * 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 MessageQueueReceiverEndpoint 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
     * "MessageQueueReceiverEndpoint" is appended. A channel named "my-channel" will therefore result in a bean name
     * "myChannelMessageQueueReceiverEndpoint".
     * 
     *
     * @return bean name
     */
    String name() default "";

}