Class BaseRabbitListenerContainerFactory<C extends MessageListenerContainer>

java.lang.Object

org.springframework.amqp.rabbit.config.BaseRabbitListenerContainerFactory<C>

Type Parameters:

C - the container type that the factory creates.

All Implemented Interfaces:

RabbitListenerContainerFactory<C>, Aware, BeanNameAware, ApplicationContextAware

Direct Known Subclasses:

AbstractRabbitListenerContainerFactory, RabbitAmqpListenerContainerFactory, StreamRabbitListenerContainerFactory

public abstract class BaseRabbitListenerContainerFactory<C extends MessageListenerContainer>
extends Object
implements RabbitListenerContainerFactory<C>, ApplicationContextAware

Base abstract class for listener container factories.

Since:

2.4

Author:

Gary Russell, Ngoc Nhan, Artem Bilan

Constructor Summary

Constructors

Constructor	Description
BaseRabbitListenerContainerFactory()

Method Summary

Modifier and Type	Method	Description
protected void	applyCommonOverrides(@Nullable RabbitListenerEndpoint endpoint, C instance)
abstract C	createListenerContainer(@Nullable RabbitListenerEndpoint endpoint)	Create a MessageListenerContainer for the given RabbitListenerEndpoint.
Advice @Nullable []	getAdviceChain()
protected ApplicationContext	getApplicationContext()
@Nullable String	getBeanName()	Return a bean name of the component or null if not a bean.
protected @Nullable Boolean	getDefaultRequeueRejected()	Return the defaultRequeueRejected.
protected @Nullable Boolean	getMicrometerEnabled()
protected @Nullable Boolean	getObservationEnabled()
void	setAdviceChain(Advice @Nullable ... adviceChain)
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanName(String name)
void	setBeforeSendReplyPostProcessors(MessagePostProcessor... postProcessors)	Set post processors that will be applied before sending replies; added to each message listener adapter.
void	setDefaultRequeueRejected(Boolean requeueRejected)
void	setMicrometerEnabled(boolean micrometerEnabled)	Set to false to disable micrometer listener timers.
void	setObservationEnabled(boolean observationEnabled)	Enable observation via micrometer; disables basic Micrometer timers enabled by setMicrometerEnabled(boolean).
void	setReplyPostProcessorProvider(Function<@Nullable String, @Nullable ReplyPostProcessor> replyPostProcessorProvider)	Set a function to provide a reply post processor; it will be used if there is no replyPostProcessor on the rabbit listener annotation.
void	setReplyRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)	Set a RecoveryCallback to invoke when retries are exhausted.
void	setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)	Set a RetryTemplate to use when sending replies; added to each message listener adapter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.springframework.amqp.rabbit.listener.RabbitListenerContainerFactory

createListenerContainer

Constructor Details

BaseRabbitListenerContainerFactory

public BaseRabbitListenerContainerFactory()

Method Details

createListenerContainer

public abstract C createListenerContainer(@Nullable RabbitListenerEndpoint endpoint)

Description copied from interface: RabbitListenerContainerFactory

Create a MessageListenerContainer for the given RabbitListenerEndpoint.

Specified by:

createListenerContainer in interface RabbitListenerContainerFactory<C extends MessageListenerContainer>

Parameters:

endpoint - the endpoint to configure.

Returns:

the created container.

setDefaultRequeueRejected

public void setDefaultRequeueRejected(Boolean requeueRejected)

Parameters:

requeueRejected - true to reject by default.

See Also:

• AbstractMessageListenerContainer.setDefaultRequeueRejected(boolean)

getDefaultRequeueRejected

protected @Nullable Boolean getDefaultRequeueRejected()

Return the defaultRequeueRejected.

Returns:

the defaultRequeueRejected.

setBeforeSendReplyPostProcessors

public void setBeforeSendReplyPostProcessors(MessagePostProcessor... postProcessors)

Set post processors that will be applied before sending replies; added to each message listener adapter.

Parameters:

postProcessors - the post processors.

See Also:

• AbstractAdaptableMessageListener.setBeforeSendReplyPostProcessors(MessagePostProcessor...)

setRetryTemplate

public void setRetryTemplate(org.springframework.retry.support.RetryTemplate retryTemplate)

Set a RetryTemplate to use when sending replies; added to each message listener adapter.

Parameters:

retryTemplate - the template.

See Also:

• setReplyRecoveryCallback(RecoveryCallback)
• AbstractAdaptableMessageListener.setRetryTemplate(RetryTemplate)

setReplyRecoveryCallback

public void setReplyRecoveryCallback(org.springframework.retry.RecoveryCallback<?> recoveryCallback)

Set a RecoveryCallback to invoke when retries are exhausted. Added to each message listener adapter. Only used if a retryTemplate is provided.

Parameters:

recoveryCallback - the recovery callback.

See Also:

• setRetryTemplate(RetryTemplate)
• AbstractAdaptableMessageListener.setRecoveryCallback(RecoveryCallback)

setReplyPostProcessorProvider

public void setReplyPostProcessorProvider(Function<@Nullable String, @Nullable ReplyPostProcessor> replyPostProcessorProvider)

Set a function to provide a reply post processor; it will be used if there is no replyPostProcessor on the rabbit listener annotation. The input parameter is the listener id.

Parameters:

replyPostProcessorProvider - the post processor.

Since:

3.0

applyCommonOverrides

protected void applyCommonOverrides(@Nullable RabbitListenerEndpoint endpoint,
 C instance)

getAdviceChain

public Advice @Nullable [] getAdviceChain()

Returns:

the advice chain that was set. Defaults to null.

Since:

1.7.4

setAdviceChain

public void setAdviceChain(Advice @Nullable ... adviceChain)

Parameters:

adviceChain - the advice chain to set.

See Also:

• AbstractMessageListenerContainer.setAdviceChain(org.aopalliance.aop.Advice...)

setMicrometerEnabled

public void setMicrometerEnabled(boolean micrometerEnabled)

Set to false to disable micrometer listener timers. When true, ignored if setObservationEnabled(boolean) is set to true.

Parameters:

micrometerEnabled - false to disable.

Since:

3.0

See Also:

• setObservationEnabled(boolean)

getMicrometerEnabled

protected @Nullable Boolean getMicrometerEnabled()

setObservationEnabled

public void setObservationEnabled(boolean observationEnabled)

Enable observation via micrometer; disables basic Micrometer timers enabled by setMicrometerEnabled(boolean).

Parameters:

observationEnabled - true to enable.

Since:

3.0

See Also:

• setMicrometerEnabled(boolean)

getObservationEnabled

protected @Nullable Boolean getObservationEnabled()

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

getApplicationContext

protected ApplicationContext getApplicationContext()

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

Specified by:

setBeanName in interface RabbitListenerContainerFactory<C extends MessageListenerContainer>

getBeanName

public @Nullable String getBeanName()

Description copied from interface: RabbitListenerContainerFactory

Return a bean name of the component or null if not a bean.

Specified by:

getBeanName in interface RabbitListenerContainerFactory<C extends MessageListenerContainer>

Returns:

the bean name.