Package org.springframework.integration.context

Class IntegrationObjectSupport

java.lang.Object

org.springframework.integration.context.IntegrationObjectSupport

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, InitializingBean, ApplicationContextAware, ComponentSourceAware, ExpressionCapable, NamedComponent

Direct Known Subclasses:

AbstractConnectionFactory, AbstractEndpoint, AbstractHandleMessageAdvice, AbstractMailReceiver, AbstractMessageChannel, AbstractRequestHandlerAdvice, AbstractTransformer, CodecMessageConverter, DefaultHeaderChannelRegistry, ExpressionEvaluatingTransactionSynchronizationProcessor, HeaderEnricher, HeaderFilter, MessageHandlerSupport

public abstract class IntegrationObjectSupport
extends Object
implements ComponentSourceAware, NamedComponent, ApplicationContextAware, BeanFactoryAware, InitializingBean, ExpressionCapable

A base class that provides convenient access to the bean factory as well as TaskScheduler and ConversionService instances.

This is intended to be used as a base class for internal framework components whereas code built upon the integration framework should not require tight coupling with the context but rather rely on standard dependency injection.

Author:

Mark Fisher, Oleg Zhurakousky, Josh Long, Stefan Ferstl, Gary Russell, Artem Bilan

Field Summary

Fields

Modifier and Type	Field	Description
protected static final ExpressionParser	EXPRESSION_PARSER
protected final LogAccessor	logger

Constructor Summary

Constructors

Constructor	Description
IntegrationObjectSupport()

Method Summary

Modifier and Type	Method	Description
final void	afterPropertiesSet()
static <T> T	extractTypeIfPossible(Object targetObject, Class<T> expectedType)
static UUID	generateId()
protected ApplicationContext	getApplicationContext()
String	getApplicationContextId()	Returns the ApplicationContext.getId() if the ApplicationContext is available.
String	getBeanDescription()
protected BeanFactory	getBeanFactory()
String	getBeanName()	Return the bean name populated by the BeanNameAware.setBeanName(String).
protected DestinationResolver<MessageChannel>	getChannelResolver()
String	getComponentDescription()	Return a human-readable description of this bean.
String	getComponentName()	Will return the name of this component identified by componentName field.
Object	getComponentSource()	Return the configuration source Object for this bean (maybe null).
String	getComponentType()	Subclasses may implement this method to provide component type information.
ConversionService	getConversionService()
Expression	getExpression()	Return the primary SpEL expression if this component is expression-based.
protected IntegrationProperties	getIntegrationProperties()
protected MessageBuilderFactory	getMessageBuilderFactory()
protected TaskScheduler	getTaskScheduler()
protected boolean	isInitialized()	Return the status of this component if it has been initialized already.
protected void	onInit()	Subclasses may implement this for initialization logic.
void	setApplicationContext(ApplicationContext applicationContext)
void	setBeanFactory(BeanFactory beanFactory)
final void	setBeanName(String beanName)
void	setChannelResolver(DestinationResolver<MessageChannel> channelResolver)	Specify the DestinationResolver strategy to use.
void	setComponentDescription(String description)	Set a human-readable description of this bean.
void	setComponentName(String componentName)	Sets the name of this component.
void	setComponentSource(Object source)	Set a configuration source Object for this bean definition.
void	setConversionService(ConversionService conversionService)
void	setMessageBuilderFactory(MessageBuilderFactory messageBuilderFactory)
final void	setPrimaryExpression(Expression expression)	For expression-based components, set the primary expression.
void	setTaskScheduler(TaskScheduler taskScheduler)	Configure a TaskScheduler for those components which logic relies on the scheduled tasks.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

EXPRESSION_PARSER

protected static final ExpressionParser EXPRESSION_PARSER

logger

protected final LogAccessor logger

Constructor Details

IntegrationObjectSupport

public IntegrationObjectSupport()

Method Details

setBeanName

public final void setBeanName(@Nullable
 String beanName)

Specified by:

setBeanName in interface BeanNameAware

getBeanName

public String getBeanName()

Description copied from interface: ComponentSourceAware

Return the bean name populated by the BeanNameAware.setBeanName(String).

Specified by:

getBeanName in interface ComponentSourceAware

Specified by:

getBeanName in interface NamedComponent

Returns:

the bean name.

getComponentName

public String getComponentName()

Will return the name of this component identified by componentName field. If componentName was not set this method will default to the 'beanName' of this component;

Specified by:

getComponentName in interface NamedComponent

setComponentName

public void setComponentName(String componentName)

Sets the name of this component.

Parameters:

componentName - The component name.

getComponentType

public String getComponentType()

Subclasses may implement this method to provide component type information.

Specified by:

getComponentType in interface NamedComponent

setComponentSource

public void setComponentSource(Object source)

Description copied from interface: ComponentSourceAware

Set a configuration source Object for this bean definition. For normal BeanDefinition this is supplied by application context automatically. Could be useful when bean is registered at runtime via SingletonBeanRegistry.registerSingleton(String, Object)

Specified by:

setComponentSource in interface ComponentSourceAware

Parameters:

source - the configuration source

getComponentSource

@Nullable
public Object getComponentSource()

Description copied from interface: ComponentSourceAware

Return the configuration source Object for this bean (maybe null). Usually (if not set explicitly) a BeanMetadataElement.getSource().

Specified by:

getComponentSource in interface ComponentSourceAware

Returns:

the configuration source for the bean (if any).

setComponentDescription

public void setComponentDescription(String description)

Description copied from interface: ComponentSourceAware

Set a human-readable description of this bean. For normal bean definition a BeanDefinition.getDescription() is used.

Specified by:

setComponentDescription in interface ComponentSourceAware

Parameters:

description - the bean description

getComponentDescription

@Nullable
public String getComponentDescription()

Description copied from interface: ComponentSourceAware

Return a human-readable description of this bean. Usually (if not set explicitly) a BeanDefinition.getDescription().

Specified by:

getComponentDescription in interface ComponentSourceAware

Returns:

the bean description (if any).

getBeanDescription

public String getBeanDescription()

setBeanFactory

public void setBeanFactory(BeanFactory beanFactory)

Specified by:

setBeanFactory in interface BeanFactoryAware

setApplicationContext

public void setApplicationContext(ApplicationContext applicationContext)
                           throws BeansException

Specified by:

setApplicationContext in interface ApplicationContextAware

Throws:

BeansException

setChannelResolver

public void setChannelResolver(DestinationResolver<MessageChannel> channelResolver)

Specify the DestinationResolver strategy to use. The default is a BeanFactoryChannelResolver.

Parameters:

channelResolver - The channel resolver.

getExpression

public Expression getExpression()

Description copied from interface: ExpressionCapable

Return the primary SpEL expression if this component is expression-based.

Specified by:

getExpression in interface ExpressionCapable

Returns:

the expression as a String.

setPrimaryExpression

public final void setPrimaryExpression(Expression expression)

For expression-based components, set the primary expression.

Parameters:

expression - the expression.

Since:

4.3

afterPropertiesSet

public final void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface InitializingBean

onInit

protected void onInit()

Subclasses may implement this for initialization logic.

isInitialized

protected boolean isInitialized()

Return the status of this component if it has been initialized already.

Returns:

the flag if this component has been initialized already.

getBeanFactory

protected BeanFactory getBeanFactory()

setTaskScheduler

public void setTaskScheduler(TaskScheduler taskScheduler)

Configure a TaskScheduler for those components which logic relies on the scheduled tasks. If not provided, falls back to the global taskScheduler bean in the application context, provided by the Spring Integration infrastructure.

Parameters:

taskScheduler - the TaskScheduler to use.

Since:

5.1.3

See Also:

• getTaskScheduler()

getTaskScheduler

protected TaskScheduler getTaskScheduler()

getChannelResolver

protected DestinationResolver<MessageChannel> getChannelResolver()

getConversionService

public ConversionService getConversionService()

setConversionService

public void setConversionService(ConversionService conversionService)

getApplicationContextId

public String getApplicationContextId()

Returns the ApplicationContext.getId() if the ApplicationContext is available.

Returns:

The id, or null if there is no application context.

getApplicationContext

protected ApplicationContext getApplicationContext()

Returns:

the applicationContext

getIntegrationProperties

protected IntegrationProperties getIntegrationProperties()

Returns:

The global integration properties.

See Also:

• IntegrationContextUtils.getIntegrationProperties(BeanFactory)

getMessageBuilderFactory

protected MessageBuilderFactory getMessageBuilderFactory()

setMessageBuilderFactory

public void setMessageBuilderFactory(MessageBuilderFactory messageBuilderFactory)

toString

public String toString()

Overrides:

toString in class Object

extractTypeIfPossible

@Nullable
public static <T> T extractTypeIfPossible(@Nullable
 Object targetObject,
 Class<T> expectedType)

generateId

public static UUID generateId()