org.springframework.integration.core

Interface MessageSource<T>

All Superinterfaces:

IntegrationPattern

All Known Implementing Classes:

AbstractFetchLimitingMessageSource, AbstractInboundFileSynchronizingMessageSource, AbstractMessageSource, AbstractRemoteFileStreamingMessageSource, AmqpMessageSource, AttributePollingMessageSource, ByteStreamReadingMessageSource, CharacterStreamReadingMessageSource, CorrelatingMessageBarrier, ExpressionEvaluatingMessageSource, FeedEntryMessageSource, FileReadingMessageSource, FtpInboundFileSynchronizingMessageSource, FtpStreamingMessageSource, JdbcPollingChannelAdapter, JmsDestinationPollingSource, JpaPollingChannelAdapter, KafkaMessageSource, MailReceivingMessageSource, MBeanTreePollingMessageSource, MessageProcessorMessageSource, MethodInvokingMessageSource, MongoDbMessageSource, R2dbcMessageSource, ReactiveMongoDbMessageSource, RedisStoreMessageSource, ResourceRetrievingMessageSource, ScriptExecutingMessageSource, SftpInboundFileSynchronizingMessageSource, SftpStreamingMessageSource, StoredProcPollingChannelAdapter

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface MessageSource<T>
extends IntegrationPattern

Base interface for any source of Messages that can be polled.

Author:

Mark Fisher, Artem Bilan

Method Summary

Modifier and Type	Method and Description
default IntegrationPatternType	getIntegrationPatternType() Return a pattern type this component implements.
Message<T>	receive() Retrieve the next available message from this source.

Method Detail

receive

@Nullable
Message<T> receive()

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

Returns:

The message or null.

getIntegrationPatternType

default IntegrationPatternType getIntegrationPatternType()

Description copied from interface: IntegrationPattern

Return a pattern type this component implements.

Specified by:

getIntegrationPatternType in interface IntegrationPattern

Returns:

the IntegrationPatternType this component implements.