org.springframework.integration.support.management

Class IntegrationManagementConfigurer

java.lang.Object

org.springframework.integration.support.management.IntegrationManagementConfigurer

All Implemented Interfaces:

Aware, BeanNameAware, SmartInitializingSingleton, ApplicationContextAware

public class IntegrationManagementConfigurer
extends Object
implements SmartInitializingSingleton, ApplicationContextAware, BeanNameAware

Configures beans that implement IntegrationManagement. Configures counts, stats, logging for all (or selected) components.

Since:

4.2

Author:

Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field and Description
static String	MANAGEMENT_CONFIGURER_NAME

Constructor Summary

Constructors

Constructor and Description
IntegrationManagementConfigurer()

Method Summary

Modifier and Type	Method and Description
void	afterSingletonsInstantiated()
MessageChannelMetrics	getChannelMetrics(String name)
String[]	getChannelNames()
Boolean	getDefaultCountsEnabled()
Boolean	getDefaultStatsEnabled()
MessageHandlerMetrics	getHandlerMetrics(String name)
String[]	getHandlerNames()
MessageSourceMetrics	getSourceMetrics(String name)
String[]	getSourceNames()
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanName(String name)
void	setDefaultCountsEnabled(Boolean defaultCountsEnabled) Set whether managed components maintain message counts by default.
void	setDefaultLoggingEnabled(boolean defaultLoggingEnabled) Disable all logging in the normal message flow in framework components.
void	setDefaultStatsEnabled(Boolean defaultStatsEnabled) Set whether managed components maintain message statistics by default.
void	setEnabledCountsPatterns(String[] enabledCountsPatterns) Set the array of simple patterns for component names for which message counts will be enabled (defaults to '*').
void	setEnabledStatsPatterns(String[] enabledStatsPatterns) Set the array of simple patterns for component names for which message statistics will be enabled (response times, rates etc), as well as counts (a positive match here overrides enabledCountsPatterns, you can't have statistics without counts).
void	setMetricsFactory(MetricsFactory metricsFactory) Set a metrics factory.
void	setMetricsFactoryBeanName(String metricsFactory) Set a metrics factory bean name.

Methods inherited from class java.lang.Object

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

Field Detail

MANAGEMENT_CONFIGURER_NAME

public static final String MANAGEMENT_CONFIGURER_NAME

See Also:

Constant Field Values

Constructor Detail

IntegrationManagementConfigurer

public IntegrationManagementConfigurer()

Method Detail

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

setMetricsFactory

public void setMetricsFactory(MetricsFactory metricsFactory)

Set a metrics factory. Has a precedence over metricsFactoryBeanName. Defaults to DefaultMetricsFactory.

Parameters:

metricsFactory - the factory.

Since:

4.2

setMetricsFactoryBeanName

public void setMetricsFactoryBeanName(String metricsFactory)

Set a metrics factory bean name. Is used if metricsFactory isn't specified.

Parameters:

metricsFactory - the factory.

Since:

4.2

setEnabledCountsPatterns

public void setEnabledCountsPatterns(String[] enabledCountsPatterns)

Set the array of simple patterns for component names for which message counts will be enabled (defaults to '*'). Enables message counting (`sendCount`, `errorCount`, `receiveCount`) for those components that support counters (channels, message handlers, etc). This is the initial setting only, individual components can have counts enabled/disabled at runtime. May be overridden by an entry in enabledStatsPatterns which is additional functionality over simple counts. If a pattern starts with `!`, counts are disabled for matches. For components that match multiple patterns, the first pattern wins. Disabling counts at runtime also disables stats.

Parameters:

enabledCountsPatterns - the patterns.

setEnabledStatsPatterns

public void setEnabledStatsPatterns(String[] enabledStatsPatterns)

Set the array of simple patterns for component names for which message statistics will be enabled (response times, rates etc), as well as counts (a positive match here overrides enabledCountsPatterns, you can't have statistics without counts). (defaults to '*'). Enables statistics for those components that support statistics (channels - when sending, message handlers, etc). This is the initial setting only, individual components can have stats enabled/disabled at runtime. If a pattern starts with `!`, stats (and counts) are disabled for matches. Note: this means that '!foo' here will disable stats and counts for 'foo' even if counts are enabled for 'foo' in enabledCountsPatterns. For components that match multiple patterns, the first pattern wins. Enabling stats at runtime also enables counts.

Parameters:

enabledStatsPatterns - the patterns.

setDefaultCountsEnabled

public void setDefaultCountsEnabled(Boolean defaultCountsEnabled)

Set whether managed components maintain message counts by default. Defaults to false, unless an Integration MBean Exporter is configured.

Parameters:

defaultCountsEnabled - true to enable.

getDefaultCountsEnabled

public Boolean getDefaultCountsEnabled()

setDefaultStatsEnabled

public void setDefaultStatsEnabled(Boolean defaultStatsEnabled)

Set whether managed components maintain message statistics by default. Defaults to false, unless an Integration MBean Exporter is configured.

Parameters:

defaultStatsEnabled - true to enable.

getDefaultStatsEnabled

public Boolean getDefaultStatsEnabled()

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 logger.isDebuggingEnabled() 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.

afterSingletonsInstantiated

public void afterSingletonsInstantiated()

Specified by:

afterSingletonsInstantiated in interface SmartInitializingSingleton

getChannelNames

public String[] getChannelNames()

getHandlerNames

public String[] getHandlerNames()

getSourceNames

public String[] getSourceNames()

getChannelMetrics

public MessageChannelMetrics getChannelMetrics(String name)

getHandlerMetrics

public MessageHandlerMetrics getHandlerMetrics(String name)

getSourceMetrics

public MessageSourceMetrics getSourceMetrics(String name)