Interface AmqpListenerEndpoint
- All Known Implementing Classes:
AbstractAmqpListenerEndpoint,SimpleAmqpListenerEndpoint
public interface AmqpListenerEndpoint
The configuration model to represent a
MessageListener
with properties for target AmqpMessageListenerContainer
to be registered as a bean in the application context.- Since:
- 4.1
- Author:
- Artem Bilan
- See Also:
-
Method Summary
Modifier and TypeMethodDescriptionString[]Return the AMQP addresses to listen to.Advice @Nullable []The advice chain for the target listener container bean.@Nullable BooleanOverride theautoAcceptproperty in theAmqpMessageListenerContainerFactory.@Nullable BooleanOverride of the defaultautoStartupproperty from theAmqpMessageListenerContainerFactory.@Nullable IntegerReturn the concurrency (consumers per AMQP address) for the target listener container bean.@Nullable DurationThe graceful shutdown period for the target listener container bean.@Nullable StringgetId()Return the id of the target listener container bean.@Nullable IntegerThe initial number of credits to grant to the AMQP receiver.Return the message listener to be used in the target listener container bean.@Nullable DurationThereceiveTimeoutfor the target listener container bean.@Nullable ExecutorGet the task executor for the target listener container bean.
-
Method Details
-
getMessageListener
MessageListener getMessageListener()Return the message listener to be used in the target listener container bean.- Returns:
- the message listener.
-
getAddresses
-
getId
@Nullable String getId()Return the id of the target listener container bean. TODO: If not provided, theAmqpMessageListenerContainerFactorymakes a decision about generated bean name.- Returns:
- the id
-
getConcurrency
@Nullable Integer getConcurrency()Return the concurrency (consumers per AMQP address) for the target listener container bean. TheAmqpMessageListenerContainerFactoryconfiguration is used by default.- Returns:
- the concurrency
-
getAutoStartup
@Nullable Boolean getAutoStartup()Override of the defaultautoStartupproperty from theAmqpMessageListenerContainerFactory.- Returns:
- the autoStartup.
-
getTaskExecutor
@Nullable Executor getTaskExecutor()Get the task executor for the target listener container bean. Overrides any executor set on theAmqpMessageListenerContainerFactory.- Returns:
- the executor.
-
getAutoAccept
@Nullable Boolean getAutoAccept()Override theautoAcceptproperty in theAmqpMessageListenerContainerFactory.- Returns:
- true if auto-accept is enabled.
-
getInitialCredits
@Nullable Integer getInitialCredits()The initial number of credits to grant to the AMQP receiver. Override theinitialCreditsproperty in theAmqpMessageListenerContainerFactory.- Returns:
- number of initial credits
-
getReceiveTimeout
@Nullable Duration getReceiveTimeout()ThereceiveTimeoutfor the target listener container bean.- Returns:
- the timeout for receiving messages.
-
getGracefulShutdownPeriod
@Nullable Duration getGracefulShutdownPeriod()The graceful shutdown period for the target listener container bean.- Returns:
- the graceful shutdown period.
-
getAdviceChain
Advice @Nullable [] getAdviceChain()The advice chain for the target listener container bean.- Returns:
- the advice chain.
-