Interface IPullingListener<M>

Type Parameters:

M - the raw message type

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, FrankElement, HasApplicationContext, HasName, IConfigurable, IListener<M>, IScopeProvider, NameAware

All Known Subinterfaces:

ICorrelatedPullingListener<M>, IPeekableListener<M>

All Known Implementing Classes:

AbstractFileSystemListener, AbstractMailListener, DirectoryListener, ExchangeMailListener, FtpFileSystemListener, ImapListener, JdbcListener, JdbcQueryListener, JdbcTableListener, KafkaListener, MessageStoreListener, PullingJmsListener, Samba2Listener, SambaListener, SftpFileSystemListener, SimpleJdbcListener

public interface IPullingListener<M>
extends IListener<M>

Defines listening behaviour of pulling receivers. Pulling receivers are receivers that poll for a message, as opposed to pushing receivers that are 'message driven'

Author:

Gerrit van Brakel

Method Summary

Modifier and Type	Method	Description
void	closeThread(@NonNull Map<String,Object> threadContext)	Finalizes a message receiving thread.
@Nullable RawMessageWrapper<M>	getRawMessage(@NonNull Map<String,Object> threadContext)	Retrieves messages from queue or other channel, but does no processing on it.
@NonNull Map<String,Object>	openThread()	Prepares a thread for receiving messages.

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface IConfigurable

configure

Methods inherited from interface IListener

afterMessageProcessed, extractMessage, start, stop

Methods inherited from interface NameAware

setName

Method Details

openThread

@NonNull Map<String,Object> openThread()
                                throws ListenerException

Prepares a thread for receiving messages. Called once for each thread that will listen for messages.

Returns:

the threadContext for this thread. The threadContext is a Map in which thread-specific data can be stored. May not be null, must be a mutable map type.

Throws:

ListenerException

closeThread

void closeThread(@NonNull Map<String,Object> threadContext)
          throws ListenerException

Finalizes a message receiving thread. Called once for each thread that listens for messages, just before IListener.stop() is called.

Throws:

ListenerException

getRawMessage

@Nullable RawMessageWrapper<M> getRawMessage(@NonNull Map<String,Object> threadContext)
                                      throws ListenerException

Retrieves messages from queue or other channel, but does no processing on it. Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Any thread-specific properties should be stored in and retrieved from the threadContext.

If the returned object is an instance of MessageWrapper then the Receiver.processRawMessage(IListener, RawMessageWrapper, PipeLineSession, boolean) will not call IListener.extractMessage(RawMessageWrapper, Map) but directly access the enclosed Message and the

invalid reference

RawMessageWrapper#getContext()

.

Throws:

ListenerException