org.springframework.integration.endpoint

Class AbstractMessageSource<T>

java.lang.Object

org.springframework.integration.util.AbstractExpressionEvaluator

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

All Implemented Interfaces:

Aware, BeanFactoryAware, BeanNameAware, DisposableBean, InitializingBean, MessageSource<T>, NamedComponent, BaseSourceMetrics, IntegrationManagement, MessageSourceMetrics

Direct Known Subclasses:

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

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

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 and Description
AbstractMessageSource()

Method Summary

Modifier and Type	Method and 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()
int	getMessageCount()
long	getMessageCountLong()
IntegrationManagement.ManagementOverrides	getOverrides() Return the overrides.
boolean	isCountsEnabled()
boolean	isLoggingEnabled()
Message<T>	receive() Retrieve the next available message from this source.
void	registerMetricsCaptor(MetricsCaptor metricsCaptorToSet) Inject a MetricsCaptor
void	reset()
void	setBeanName(String name)
void	setCountsEnabled(boolean countsEnabled)
void	setHeaderExpressions(Map<String,Expression> headerExpressions)
void	setLoggingEnabled(boolean loggingEnabled)
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

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.MessageSourceMetrics

messageCount

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

getComponentType

Constructor Detail

AbstractMessageSource

public AbstractMessageSource()

Method Detail

setHeaderExpressions

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

registerMetricsCaptor

public void registerMetricsCaptor(MetricsCaptor metricsCaptorToSet)

Description copied from interface: IntegrationManagement

Inject a MetricsCaptor

Specified by:

registerMetricsCaptor in interface IntegrationManagement

Parameters:

metricsCaptorToSet - the captor.

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 MessageSourceMetrics

getManagedType

public String getManagedType()

Specified by:

getManagedType in interface MessageSourceMetrics

setManagedName

public void setManagedName(String managedName)

Specified by:

setManagedName in interface MessageSourceMetrics

getManagedName

public String getManagedName()

Specified by:

getManagedName in interface MessageSourceMetrics

getComponentName

public String getComponentName()

Specified by:

getComponentName in interface NamedComponent

isCountsEnabled

public boolean isCountsEnabled()

Specified by:

isCountsEnabled in interface IntegrationManagement

setCountsEnabled

public void setCountsEnabled(boolean countsEnabled)

Specified by:

setCountsEnabled in interface IntegrationManagement

isLoggingEnabled

public boolean isLoggingEnabled()

Specified by:

isLoggingEnabled in interface IntegrationManagement

setLoggingEnabled

public void setLoggingEnabled(boolean loggingEnabled)

Specified by:

setLoggingEnabled in interface IntegrationManagement

reset

public void reset()

Specified by:

reset in interface IntegrationManagement

getMessageCount

public int getMessageCount()

Specified by:

getMessageCount in interface MessageSourceMetrics

Returns:

the number of successful message receptions.

getMessageCountLong

public long getMessageCountLong()

Specified by:

getMessageCountLong in interface MessageSourceMetrics

Returns:

the number of successful handler calls

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