Class AbstractMessageSource<T>

java.lang.Object

org.springframework.integration.util.AbstractExpressionEvaluator

org.springframework.integration.endpoint.AbstractMessageSource<T>

Type Parameters:

T - The payload type.

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, MessageSource<T>, IntegrationPattern, NamedComponent, IntegrationInboundManagement, IntegrationManagement

Direct Known Subclasses:

AbstractFetchLimitingMessageSource, AbstractMongoDbMessageSource, AmqpMessageSource, AttributePollingMessageSource, ByteStreamReadingMessageSource, CharacterStreamReadingMessageSource, ExpressionEvaluatingMessageSource, FeedEntryMessageSource, FileReadingMessageSource, HazelcastDistributedSQLMessageSource, JdbcPollingChannelAdapter, JmsDestinationPollingSource, JpaPollingChannelAdapter, KafkaMessageSource, MailReceivingMessageSource, MBeanTreePollingMessageSource, MessageProcessorMessageSource, MethodInvokingMessageSource, R2dbcMessageSource, RedisStoreMessageSource, ResourceRetrievingMessageSource, ScriptExecutingMessageSource, StoredProcPollingChannelAdapter

@IntegrationManagedResource
public abstract class AbstractMessageSource<T>
extends AbstractExpressionEvaluator
implements MessageSource<T>, IntegrationInboundManagement, NamedComponent, BeanNameAware

Abstract message source.

Since:

2.0

Author:

Mark Fisher, Oleg Zhurakousky, Gary Russell, Artem Bilan

Nested Class Summary

Nested classes/interfaces inherited from interface org.springframework.integration.support.management.IntegrationManagement

IntegrationManagement.ManagementOverrides

Field Summary

Fields inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

EXPRESSION_PARSER, logger

Fields inherited from interface org.springframework.integration.support.management.IntegrationManagement

METER_PREFIX, RECEIVE_COUNTER_NAME, SEND_TIMER_NAME

Constructor Summary

Constructors

Constructor	Description
AbstractMessageSource()

Method Summary

Modifier and Type	Method	Description
protected Message<T>	buildMessage(Object result)
void	destroy()
protected abstract Object	doReceive()	Subclasses must implement this method.
String	getBeanName()
String	getComponentName()
String	getManagedName()
String	getManagedType()
IntegrationManagement.ManagementOverrides	getOverrides()	Return the overrides.
boolean	isLoggingEnabled()	Return whether logging is enabled.
final Message<T>	receive()	Retrieve the next available message from this source.
void	registerMetricsCaptor(MetricsCaptor metricsCaptorToSet)	Inject a MetricsCaptor.
void	setBeanName(String name)
void	setHeaderExpressions(Map<String,Expression> headerExpressions)
void	setLoggingEnabled(boolean loggingEnabled)	Enable logging or not.
void	setManagedName(String managedName)
void	setManagedType(String managedType)

Methods inherited from class org.springframework.integration.util.AbstractExpressionEvaluator

afterPropertiesSet, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, evaluateExpression, getBeanFactory, getEvaluationContext, getEvaluationContext, getMessageBuilderFactory, onInit, setBeanFactory, setConversionService, setSimpleEvaluationContext

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.springframework.integration.support.management.IntegrationManagement

getThisAs, isObserved, registerObservationRegistry

Methods inherited from interface org.springframework.integration.core.MessageSource

getIntegrationPatternType

Methods inherited from interface org.springframework.integration.support.context.NamedComponent

getComponentType

Constructor Details

AbstractMessageSource

public AbstractMessageSource()

Method Details

setHeaderExpressions

public void setHeaderExpressions(@Nullable
 Map<String,Expression> headerExpressions)

registerMetricsCaptor

public void registerMetricsCaptor(MetricsCaptor metricsCaptorToSet)

Description copied from interface: IntegrationManagement

Inject a MetricsCaptor. Ignored if ObservationRegistry is provided.

Specified by:

registerMetricsCaptor in interface IntegrationManagement

Parameters:

metricsCaptorToSet - the captor.

See Also:

• IntegrationManagement.registerObservationRegistry(ObservationRegistry)

setBeanName

public void setBeanName(String name)

Specified by:

setBeanName in interface BeanNameAware

getBeanName

public String getBeanName()

Specified by:

getBeanName in interface NamedComponent

setManagedType

public void setManagedType(String managedType)

Specified by:

setManagedType in interface IntegrationManagement

getManagedType

public String getManagedType()

Specified by:

getManagedType in interface IntegrationManagement

setManagedName

public void setManagedName(String managedName)

Specified by:

setManagedName in interface IntegrationManagement

getManagedName

public String getManagedName()

Specified by:

getManagedName in interface IntegrationManagement

getComponentName

public String getComponentName()

Specified by:

getComponentName in interface NamedComponent

isLoggingEnabled

public boolean isLoggingEnabled()

Description copied from interface: IntegrationManagement

Return whether logging is enabled.

Specified by:

isLoggingEnabled in interface IntegrationManagement

Returns:

true if enabled.

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)

Description copied from interface: IntegrationManagement

Enable logging or not.

Specified by:

setLoggingEnabled in interface IntegrationManagement

Parameters:

loggingEnabled - false to disable.

getOverrides

public IntegrationManagement.ManagementOverrides getOverrides()

Description copied from interface: IntegrationManagement

Return the overrides.

Specified by:

getOverrides in interface IntegrationManagement

Returns:

the overrides.

receive

public final Message<T> receive()

Description copied from interface: MessageSource

Retrieve the next available message from this source. Returns null if no message is available.

Specified by:

receive in interface MessageSource<T>

Returns:

The message or null.

buildMessage

protected Message<T> buildMessage(Object result)

doReceive

@Nullable
protected abstract Object doReceive()

Subclasses must implement this method. Typically the returned value will be the payload of type T, but the returned value may also be a Message instance whose payload is of type T; also can be AbstractIntegrationMessageBuilder which is used for additional headers population.

Returns:

The value returned.

destroy

public void destroy()

Specified by:

destroy in interface DisposableBean

Specified by:

destroy in interface IntegrationManagement