Class IntegrationManagementConfigurer

java.lang.Object

org.springframework.integration.config.IntegrationManagementConfigurer

All Implemented Interfaces:

EventListener, Aware, BeanNameAware, BeanPostProcessor, SmartInitializingSingleton, ApplicationContextAware, ApplicationListener<ContextClosedEvent>

public class IntegrationManagementConfigurer
extends Object
implements SmartInitializingSingleton, ApplicationContextAware, BeanNameAware, BeanPostProcessor, ApplicationListener<ContextClosedEvent>

Configures beans that implement IntegrationManagement. Configures logging, MetricsCaptor and ObservationRegistry for all (or selected) components.

Since:

4.2

Author:

Gary Russell, Artem Bilan, Meherzad Lahewala, Jonathan Pearlin

Field Summary

Fields

Modifier and Type	Field	Description
static final String	MANAGEMENT_CONFIGURER_NAME	Bean name of the configurer.

Constructor Summary

Constructors

Constructor	Description
IntegrationManagementConfigurer()

Method Summary

Modifier and Type	Method	Description
void	afterSingletonsInstantiated()
void	onApplicationEvent(ContextClosedEvent event)
Object	postProcessAfterInitialization(Object bean, String name)
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanName(String name)
void	setDefaultLoggingEnabled(boolean defaultLoggingEnabled)	Disable all logging in the normal message flow in framework components.
void	setMetricsCaptor(MetricsCaptor metricsCaptor)
void	setObservationPatterns(String... observationPatterns)	Set simple patterns for component names matching which has to be instrumented with a ObservationRegistry.
void	setObservationRegistry(io.micrometer.observation.ObservationRegistry observationRegistry)	Set an ObservationRegistry to populate to the IntegrationManagement components in the application context.

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.ApplicationListener

supportsAsyncExecution

Methods inherited from interface org.springframework.beans.factory.config.BeanPostProcessor

postProcessBeforeInitialization

Field Details

MANAGEMENT_CONFIGURER_NAME

public static final String MANAGEMENT_CONFIGURER_NAME

Bean name of the configurer.

See Also:

• Constant Field Values

Constructor Details

IntegrationManagementConfigurer

public IntegrationManagementConfigurer()

Method Details

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

setDefaultLoggingEnabled

public void setDefaultLoggingEnabled(boolean defaultLoggingEnabled)

Disable all logging in the normal message flow in framework components. When 'false', such logging will be skipped, regardless of logging level. When 'true', the logging is controlled as normal by the logging subsystem log level configuration.

Exception logging (debug or otherwise) is not affected by this setting.

It has been found that in high-volume messaging environments, calls to methods such as Log.isDebugEnabled() can be quite expensive and account for an inordinate amount of CPU time.

Set this to 'false' to disable logging by default in all framework components that implement IntegrationManagement (channels, message handlers etc.) This turns off logging such as "PreSend on channel", "Received message" etc.

After the context is initialized, individual components can have their setting changed by invoking IntegrationManagement.setLoggingEnabled(boolean).

Parameters:

defaultLoggingEnabled - defaults to true.

setMetricsCaptor

public void setMetricsCaptor(@Nullable
 MetricsCaptor metricsCaptor)

setObservationRegistry

public void setObservationRegistry(@Nullable
 io.micrometer.observation.ObservationRegistry observationRegistry)

Set an ObservationRegistry to populate to the IntegrationManagement components in the application context.

Parameters:

observationRegistry - the ObservationRegistry to use.

Since:

6.0

setObservationPatterns

public void setObservationPatterns(String... observationPatterns)

Set simple patterns for component names matching which has to be instrumented with a ObservationRegistry.

Parameters:

observationPatterns - the simple patterns to use.

Since:

6.0

See Also:

• PatternMatchUtils.smartMatch(String, String...)

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

postProcessAfterInitialization

public Object postProcessAfterInitialization(Object bean,
 String name)
                                      throws BeansException

Specified by:

postProcessAfterInitialization in interface BeanPostProcessor

Throws:

BeansException

onApplicationEvent

public void onApplicationEvent(ContextClosedEvent event)

Specified by:

onApplicationEvent in interface ApplicationListener<ContextClosedEvent>