Class IntegrationObjectSupport
java.lang.Object
org.springframework.integration.context.IntegrationObjectSupport
- All Implemented Interfaces:
org.springframework.beans.factory.Aware
,org.springframework.beans.factory.BeanFactoryAware
,org.springframework.beans.factory.BeanNameAware
,org.springframework.beans.factory.InitializingBean
,org.springframework.context.ApplicationContextAware
,ExpressionCapable
,NamedComponent
- Direct Known Subclasses:
AbstractEndpoint
,AbstractHandleMessageAdvice
,AbstractMessageChannel
,AbstractRequestHandlerAdvice
,AbstractTransformer
,CodecMessageConverter
,DefaultHeaderChannelRegistry
,ExpressionEvaluatingTransactionSynchronizationProcessor
,HeaderEnricher
,HeaderFilter
,MessageHandlerSupport
public abstract class IntegrationObjectSupport
extends Object
implements org.springframework.beans.factory.BeanNameAware, NamedComponent, org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.BeanFactoryAware, org.springframework.beans.factory.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.
-
Field Summary
Modifier and TypeFieldDescriptionprotected static final org.springframework.expression.ExpressionParser
protected final org.springframework.core.log.LogAccessor
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal void
static <T> T
extractTypeIfPossible
(Object targetObject, Class<T> expectedType) static UUID
protected org.springframework.context.ApplicationContext
Returns theApplicationContext.getId()
if theApplicationContext
is available.protected org.springframework.beans.factory.BeanFactory
protected org.springframework.messaging.core.DestinationResolver<org.springframework.messaging.MessageChannel>
Will return the name of this component identified bycomponentName
field.Subclasses may implement this method to provide component type information.org.springframework.core.convert.ConversionService
org.springframework.expression.Expression
Return the primary SpEL expression if this component is expression-based.protected IntegrationProperties
protected <T> T
getIntegrationProperty
(String key, Class<T> tClass) Deprecated.protected MessageBuilderFactory
protected org.springframework.scheduling.TaskScheduler
protected boolean
Return the status of this component if it has been initialized already.protected void
onInit()
Subclasses may implement this for initialization logic.void
setApplicationContext
(org.springframework.context.ApplicationContext applicationContext) void
setBeanFactory
(org.springframework.beans.factory.BeanFactory beanFactory) final void
setBeanName
(String beanName) void
setChannelResolver
(org.springframework.messaging.core.DestinationResolver<org.springframework.messaging.MessageChannel> channelResolver) Specify theDestinationResolver
strategy to use.void
setComponentName
(String componentName) Sets the name of this component.protected void
setConversionService
(org.springframework.core.convert.ConversionService conversionService) void
setMessageBuilderFactory
(MessageBuilderFactory messageBuilderFactory) final void
setPrimaryExpression
(org.springframework.expression.Expression expression) For expression-based components, set the primary expression.void
setTaskScheduler
(org.springframework.scheduling.TaskScheduler taskScheduler) Configure aTaskScheduler
for those components which logic relies on the scheduled tasks.toString()
-
Field Details
-
EXPRESSION_PARSER
protected static final org.springframework.expression.ExpressionParser EXPRESSION_PARSER -
logger
protected final org.springframework.core.log.LogAccessor logger
-
-
Constructor Details
-
IntegrationObjectSupport
public IntegrationObjectSupport()
-
-
Method Details
-
setBeanName
- Specified by:
setBeanName
in interfaceorg.springframework.beans.factory.BeanNameAware
-
getBeanName
- Specified by:
getBeanName
in interfaceNamedComponent
-
getComponentName
Will return the name of this component identified bycomponentName
field. IfcomponentName
was not set this method will default to the 'beanName' of this component;- Specified by:
getComponentName
in interfaceNamedComponent
-
setComponentName
Sets the name of this component.- Parameters:
componentName
- The component name.
-
getComponentType
Subclasses may implement this method to provide component type information.- Specified by:
getComponentType
in interfaceNamedComponent
-
getBeanDescription
-
setBeanFactory
public void setBeanFactory(org.springframework.beans.factory.BeanFactory beanFactory) - Specified by:
setBeanFactory
in interfaceorg.springframework.beans.factory.BeanFactoryAware
-
setApplicationContext
public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext) throws org.springframework.beans.BeansException - Specified by:
setApplicationContext
in interfaceorg.springframework.context.ApplicationContextAware
- Throws:
org.springframework.beans.BeansException
-
setChannelResolver
public void setChannelResolver(org.springframework.messaging.core.DestinationResolver<org.springframework.messaging.MessageChannel> channelResolver) Specify theDestinationResolver
strategy to use. The default is a BeanFactoryChannelResolver.- Parameters:
channelResolver
- The channel resolver.
-
getExpression
public org.springframework.expression.Expression getExpression()Description copied from interface:ExpressionCapable
Return the primary SpEL expression if this component is expression-based.- Specified by:
getExpression
in interfaceExpressionCapable
- Returns:
- the expression as a String.
-
setPrimaryExpression
public final void setPrimaryExpression(org.springframework.expression.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 interfaceorg.springframework.beans.factory.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 org.springframework.beans.factory.BeanFactory getBeanFactory() -
setTaskScheduler
public void setTaskScheduler(org.springframework.scheduling.TaskScheduler taskScheduler) Configure aTaskScheduler
for those components which logic relies on the scheduled tasks. If not provided, falls back to the globaltaskScheduler
bean in the application context, provided by the Spring Integration infrastructure.- Parameters:
taskScheduler
- theTaskScheduler
to use.- Since:
- 5.1.3
- See Also:
-
getTaskScheduler
protected org.springframework.scheduling.TaskScheduler getTaskScheduler() -
getChannelResolver
protected org.springframework.messaging.core.DestinationResolver<org.springframework.messaging.MessageChannel> getChannelResolver() -
getConversionService
public org.springframework.core.convert.ConversionService getConversionService() -
setConversionService
protected void setConversionService(org.springframework.core.convert.ConversionService conversionService) -
getApplicationContextId
Returns theApplicationContext.getId()
if theApplicationContext
is available.- Returns:
- The id, or null if there is no application context.
-
getApplicationContext
protected org.springframework.context.ApplicationContext getApplicationContext()- Returns:
- the applicationContext
-
getIntegrationProperties
- Returns:
- The global integration properties.
- See Also:
-
getMessageBuilderFactory
-
setMessageBuilderFactory
-
getIntegrationProperty
Deprecated.in favor ofgetIntegrationProperties()
- Type Parameters:
T
- The expected type of the property.- Parameters:
key
- Integration property.tClass
- the class to convert a value of Integration property.- Returns:
- the value of the Integration property converted to the provide type.
-
toString
-
extractTypeIfPossible
-
generateId
-
getIntegrationProperties()