Class IntegrationContextUtils

java.lang.Object

org.springframework.integration.context.IntegrationContextUtils

public abstract class IntegrationContextUtils
extends Object

Utility methods for accessing common integration components from the BeanFactory.

Author:

Mark Fisher, Josh Long, Artem Bilan, Gary Russell, Oleg Zhurakousky, Pierre Lakreb

Field Summary

Fields

Modifier and Type	Field	Description
static final String	APPLICATION_RUNNING_CONTROLLER_BEAN_NAME
static final String	ARGUMENT_RESOLVER_MESSAGE_CONVERTER_BEAN_NAME
static final String	AUTO_CREATE_CHANNEL_CANDIDATES_BEAN_NAME
static final String	BASE_PACKAGE
static final String	CHANNEL_INITIALIZER_BEAN_NAME
static final String	CONTROL_BUS_COMMAND_REGISTRY_BEAN_NAME
static final String	CONVERTER_REGISTRAR_BEAN_NAME
static final String	DEFAULT_CONFIGURING_POSTPROCESSOR_BEAN_NAME
static final long	DEFAULT_TIMEOUT	The default timeout for blocking operations like send and receive messages.
static final String	DEFAULT_TIMEOUT_STRING	A string representation for DEFAULT_TIMEOUT, e.g.
static final String	ERROR_CHANNEL_BEAN_NAME
static final String	ERROR_LOGGER_BEAN_NAME
static final String	GLOBAL_CHANNEL_INTERCEPTOR_PROCESSOR_BEAN_NAME
static final String	INTEGRATION_CONFIGURATION_POST_PROCESSOR_BEAN_NAME
static final String	INTEGRATION_DATATYPE_CHANNEL_MESSAGE_CONVERTER_BEAN_NAME
static final String	INTEGRATION_EVALUATION_CONTEXT_BEAN_NAME
static final String	INTEGRATION_FIXED_SUBSCRIBER_CHANNEL_BPP_BEAN_NAME
static final String	INTEGRATION_GLOBAL_PROPERTIES_BEAN_NAME
static final String	INTEGRATION_GRAPH_SERVER_BEAN_NAME
static final String	INTEGRATION_HEADER_CHANNEL_REGISTRY_BEAN_NAME
static final String	INTEGRATION_LIFECYCLE_ROLE_CONTROLLER
static final String	INTEGRATION_MESSAGE_HISTORY_CONFIGURER_BEAN_NAME
static final String	INTEGRATION_SIMPLE_EVALUATION_CONTEXT_BEAN_NAME
static final String	LIST_MESSAGE_HANDLER_FACTORY_BEAN_NAME
static final String	MESSAGE_HANDLER_FACTORY_BEAN_NAME
static final String	MESSAGING_ANNOTATION_POSTPROCESSOR_NAME
static final String	METADATA_STORE_BEAN_NAME
static final String	NULL_CHANNEL_BEAN_NAME
static final String	PUBLISHER_ANNOTATION_POSTPROCESSOR_NAME
static final String	SPEL_PROPERTY_ACCESSOR_REGISTRAR_BEAN_NAME
static final String	TASK_SCHEDULER_BEAN_NAME

Constructor Summary

Constructors

Constructor	Description
IntegrationContextUtils()

Method Summary

Modifier and Type	Method	Description
static BeanDefinition	getBeanDefinition(String name, ConfigurableListableBeanFactory beanFactory)	Return a BeanDefinition with the given name, obtained from the given BeanFactory or one of its parents.
static MessageChannel	getErrorChannel(BeanFactory beanFactory)
static StandardEvaluationContext	getEvaluationContext(BeanFactory beanFactory)
static IntegrationProperties	getIntegrationProperties(BeanFactory beanFactory)
static MetadataStore	getMetadataStore(BeanFactory beanFactory)
static TaskScheduler	getRequiredTaskScheduler(BeanFactory beanFactory)
static SimpleEvaluationContext	getSimpleEvaluationContext(BeanFactory beanFactory)
static TaskScheduler	getTaskScheduler(BeanFactory beanFactory)

Methods inherited from class java.lang.Object

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

Field Details

BASE_PACKAGE

public static final String BASE_PACKAGE

See Also:

• Constant Field Values

TASK_SCHEDULER_BEAN_NAME

public static final String TASK_SCHEDULER_BEAN_NAME

See Also:

• Constant Field Values

ERROR_CHANNEL_BEAN_NAME

public static final String ERROR_CHANNEL_BEAN_NAME

See Also:

• Constant Field Values

NULL_CHANNEL_BEAN_NAME

public static final String NULL_CHANNEL_BEAN_NAME

See Also:

• Constant Field Values

ERROR_LOGGER_BEAN_NAME

public static final String ERROR_LOGGER_BEAN_NAME

See Also:

• Constant Field Values

METADATA_STORE_BEAN_NAME

public static final String METADATA_STORE_BEAN_NAME

See Also:

• Constant Field Values

CONVERTER_REGISTRAR_BEAN_NAME

public static final String CONVERTER_REGISTRAR_BEAN_NAME

See Also:

• Constant Field Values

INTEGRATION_EVALUATION_CONTEXT_BEAN_NAME

public static final String INTEGRATION_EVALUATION_CONTEXT_BEAN_NAME

See Also:

• Constant Field Values

INTEGRATION_SIMPLE_EVALUATION_CONTEXT_BEAN_NAME

public static final String INTEGRATION_SIMPLE_EVALUATION_CONTEXT_BEAN_NAME

See Also:

• Constant Field Values

INTEGRATION_HEADER_CHANNEL_REGISTRY_BEAN_NAME

public static final String INTEGRATION_HEADER_CHANNEL_REGISTRY_BEAN_NAME

See Also:

• Constant Field Values

INTEGRATION_GLOBAL_PROPERTIES_BEAN_NAME

public static final String INTEGRATION_GLOBAL_PROPERTIES_BEAN_NAME

See Also:

• Constant Field Values

CHANNEL_INITIALIZER_BEAN_NAME

public static final String CHANNEL_INITIALIZER_BEAN_NAME

See Also:

• Constant Field Values

AUTO_CREATE_CHANNEL_CANDIDATES_BEAN_NAME

public static final String AUTO_CREATE_CHANNEL_CANDIDATES_BEAN_NAME

See Also:

• Constant Field Values

DEFAULT_CONFIGURING_POSTPROCESSOR_BEAN_NAME

public static final String DEFAULT_CONFIGURING_POSTPROCESSOR_BEAN_NAME

See Also:

• Constant Field Values

MESSAGING_ANNOTATION_POSTPROCESSOR_NAME

public static final String MESSAGING_ANNOTATION_POSTPROCESSOR_NAME

See Also:

• Constant Field Values

PUBLISHER_ANNOTATION_POSTPROCESSOR_NAME

public static final String PUBLISHER_ANNOTATION_POSTPROCESSOR_NAME

See Also:

• Constant Field Values

INTEGRATION_CONFIGURATION_POST_PROCESSOR_BEAN_NAME

public static final String INTEGRATION_CONFIGURATION_POST_PROCESSOR_BEAN_NAME

See Also:

• Constant Field Values

INTEGRATION_MESSAGE_HISTORY_CONFIGURER_BEAN_NAME

public static final String INTEGRATION_MESSAGE_HISTORY_CONFIGURER_BEAN_NAME

See Also:

• Constant Field Values

INTEGRATION_DATATYPE_CHANNEL_MESSAGE_CONVERTER_BEAN_NAME

public static final String INTEGRATION_DATATYPE_CHANNEL_MESSAGE_CONVERTER_BEAN_NAME

See Also:

• Constant Field Values

INTEGRATION_FIXED_SUBSCRIBER_CHANNEL_BPP_BEAN_NAME

public static final String INTEGRATION_FIXED_SUBSCRIBER_CHANNEL_BPP_BEAN_NAME

See Also:

• Constant Field Values

GLOBAL_CHANNEL_INTERCEPTOR_PROCESSOR_BEAN_NAME

public static final String GLOBAL_CHANNEL_INTERCEPTOR_PROCESSOR_BEAN_NAME

See Also:

• Constant Field Values

INTEGRATION_LIFECYCLE_ROLE_CONTROLLER

public static final String INTEGRATION_LIFECYCLE_ROLE_CONTROLLER

See Also:

• Constant Field Values

INTEGRATION_GRAPH_SERVER_BEAN_NAME

public static final String INTEGRATION_GRAPH_SERVER_BEAN_NAME

See Also:

• Constant Field Values

SPEL_PROPERTY_ACCESSOR_REGISTRAR_BEAN_NAME

public static final String SPEL_PROPERTY_ACCESSOR_REGISTRAR_BEAN_NAME

See Also:

• Constant Field Values

ARGUMENT_RESOLVER_MESSAGE_CONVERTER_BEAN_NAME

public static final String ARGUMENT_RESOLVER_MESSAGE_CONVERTER_BEAN_NAME

See Also:

• Constant Field Values

MESSAGE_HANDLER_FACTORY_BEAN_NAME

public static final String MESSAGE_HANDLER_FACTORY_BEAN_NAME

See Also:

• Constant Field Values

LIST_MESSAGE_HANDLER_FACTORY_BEAN_NAME

public static final String LIST_MESSAGE_HANDLER_FACTORY_BEAN_NAME

See Also:

• Constant Field Values

CONTROL_BUS_COMMAND_REGISTRY_BEAN_NAME

public static final String CONTROL_BUS_COMMAND_REGISTRY_BEAN_NAME

See Also:

• Constant Field Values

APPLICATION_RUNNING_CONTROLLER_BEAN_NAME

public static final String APPLICATION_RUNNING_CONTROLLER_BEAN_NAME

See Also:

• Constant Field Values

DEFAULT_TIMEOUT

public static final long DEFAULT_TIMEOUT

The default timeout for blocking operations like send and receive messages.

Since:

6.1

See Also:

• Constant Field Values

DEFAULT_TIMEOUT_STRING

public static final String DEFAULT_TIMEOUT_STRING

A string representation for DEFAULT_TIMEOUT, e.g. for annotation attributes.

Since:

6.1

See Also:

• Constant Field Values

Constructor Details

IntegrationContextUtils

public IntegrationContextUtils()

Method Details

getMetadataStore

public static MetadataStore getMetadataStore(BeanFactory beanFactory)

Parameters:

beanFactory - BeanFactory for lookup, must not be null.

Returns:

The MetadataStore bean whose name is "metadataStore".

getErrorChannel

public static MessageChannel getErrorChannel(BeanFactory beanFactory)

Parameters:

beanFactory - BeanFactory for lookup, must not be null.

Returns:

The MessageChannel bean whose name is "errorChannel".

getTaskScheduler

public static TaskScheduler getTaskScheduler(BeanFactory beanFactory)

Parameters:

beanFactory - BeanFactory for lookup, must not be null.

Returns:

The TaskScheduler bean whose name is "taskScheduler" if available.

getRequiredTaskScheduler

public static TaskScheduler getRequiredTaskScheduler(BeanFactory beanFactory)

Parameters:

beanFactory - BeanFactory for lookup, must not be null.

Returns:

The TaskScheduler bean whose name is "taskScheduler".

Throws:

IllegalStateException - if no such bean is available

getEvaluationContext

public static StandardEvaluationContext getEvaluationContext(BeanFactory beanFactory)

Parameters:

beanFactory - BeanFactory for lookup, must not be null.

Returns:

the instance of StandardEvaluationContext bean whose name is "integrationEvaluationContext".

getSimpleEvaluationContext

public static SimpleEvaluationContext getSimpleEvaluationContext(BeanFactory beanFactory)

Parameters:

beanFactory - BeanFactory for lookup, must not be null.

Returns:

the instance of SimpleEvaluationContext bean whose name is "integrationSimpleEvaluationContext".

Since:

4.3.15

getIntegrationProperties

public static IntegrationProperties getIntegrationProperties(BeanFactory beanFactory)

Parameters:

beanFactory - The bean factory.

Returns:

the global INTEGRATION_GLOBAL_PROPERTIES_BEAN_NAME bean from provided #beanFactory, which represents the merged properties values from all 'META-INF/spring.integration.properties'. Or user-defined IntegrationProperties bean. May return only IntegrationProperties.defaults() if there is no INTEGRATION_GLOBAL_PROPERTIES_BEAN_NAME bean in the provided #beanFactory or provided #beanFactory is null.

getBeanDefinition

public static BeanDefinition getBeanDefinition(String name,
 ConfigurableListableBeanFactory beanFactory)

Return a BeanDefinition with the given name, obtained from the given BeanFactory or one of its parents.

Parameters:

name - the bean name to return

beanFactory - the ConfigurableListableBeanFactory to travers.

Returns:

the BeanDefinition for a given name

Throws:

NoSuchBeanDefinitionException - if a BeanDefinition is not found

Since:

5.1.10