Package org.springframework.amqp.rabbit.listener

Class ObservableListenerContainer

java.lang.Object

org.springframework.amqp.rabbit.connection.RabbitAccessor

org.springframework.amqp.rabbit.listener.ObservableListenerContainer

All Implemented Interfaces:

MessageListenerContainer, Aware, BeanNameAware, DisposableBean, InitializingBean, ApplicationContextAware, Lifecycle, Phased, SmartLifecycle

Direct Known Subclasses:

AbstractMessageListenerContainer, StreamListenerContainer

public abstract class ObservableListenerContainer
extends RabbitAccessor
implements MessageListenerContainer, ApplicationContextAware, BeanNameAware, DisposableBean

Since:

3.0.5

Author:

Gary Russell

Field Summary

Fields inherited from class org.springframework.amqp.rabbit.connection.RabbitAccessor

logger

Fields inherited from interface org.springframework.context.SmartLifecycle

DEFAULT_PHASE

Constructor Summary

Constructors

Constructor	Description
ObservableListenerContainer()

Method Summary

Modifier and Type	Method	Description
protected void	checkMicrometer()
protected void	checkObservation()
void	destroy()
protected final ApplicationContext	getApplicationContext()
protected final String	getBeanName()
String	getListenerId()	The 'id' attribute of the listener.
protected MicrometerHolder	getMicrometerHolder()
final void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanName(String beanName)
void	setListenerId(String listenerId)	Set the listener id.
void	setMicrometerEnabled(boolean micrometerEnabled)	Set to false to disable micrometer listener timers.
void	setMicrometerTags(Map<String,String> tags)	Set additional tags for the Micrometer listener timers.
void	setObservationEnabled(boolean observationEnabled)	Enable observation via micrometer; disables basic Micrometer timers enabled by setMicrometerEnabled(boolean).

Methods inherited from class org.springframework.amqp.rabbit.connection.RabbitAccessor

afterPropertiesSet, convertRabbitAccessException, createConnection, getChannel, getConnection, getConnectionFactory, getObservationRegistry, getTransactionalResourceHolder, isChannelTransacted, obtainObservationRegistry, setChannelTransacted, setConnectionFactory

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.context.Lifecycle

isRunning, start, stop

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

afterPropertiesSet, getMessageListener, isConsumerBatchEnabled, lazyLoad, setAutoStartup, setQueueNames, setupMessageListener

Methods inherited from interface org.springframework.context.SmartLifecycle

getPhase, isAutoStartup, stop

Constructor Details

ObservableListenerContainer

public ObservableListenerContainer()

Method Details

getApplicationContext

@Nullable
protected final ApplicationContext getApplicationContext()

setApplicationContext

public final void setApplicationContext(ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface ApplicationContextAware

getMicrometerHolder

protected MicrometerHolder getMicrometerHolder()

setMicrometerTags

public void setMicrometerTags(Map<String,String> tags)

Set additional tags for the Micrometer listener timers.

Parameters:

tags - the tags.

Since:

2.2

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:

2.2

See Also:

• setObservationEnabled(boolean)

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)

checkMicrometer

protected void checkMicrometer()

checkObservation

protected void checkObservation()

setBeanName

public void setBeanName(String beanName)

Specified by:

setBeanName in interface BeanNameAware

getBeanName

@Nullable
protected final String getBeanName()

Returns:

The bean name that this listener container has been assigned in its containing bean factory, if any.

getListenerId

public String getListenerId()

The 'id' attribute of the listener.

Returns:

the id (or the container bean name if no id set).

setListenerId

public void setListenerId(String listenerId)

Description copied from interface: MessageListenerContainer

Set the listener id.

Specified by:

setListenerId in interface MessageListenerContainer

Parameters:

listenerId - the id.

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean