nl.nn.adapterframework.core

Interface IPullingListener<M>

Type Parameters:

M - the raw message type

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, IConfigurable, IConfigurationAware, IListener<M>, INamedObject, IScopeProvider

All Known Subinterfaces:

ICorrelatedPullingListener<M>, IPeekableListener<M>, IPostboxListener<M>

All Known Implementing Classes:

DirectoryListener, ExchangeMailListener, FileRecordListener, FileSystemListener, FtpFileSystemListener, ImapListener, JdbcListener, JdbcQueryListener, JdbcTableListener, MailListener, MessageStoreListener, PullingIfsaProviderListener, 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 and Description
void	closeThread(Map<String,Object> threadContext) Finalizes a message receiving thread.
RawMessageWrapper<M>	getRawMessage(Map<String,Object> threadContext) Retrieves messages from queue or other channel, but does no processing on it.
Map<String,Object>	openThread() Prepares a thread for receiving messages.

Methods inherited from interface nl.nn.adapterframework.core.IListener

afterMessageProcessed, close, configure, extractMessage, open

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Method Detail

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.close() is called.

Throws:

ListenerException

getRawMessage

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.

Throws:

ListenerException