Package org.frankframework.core

Interface IListener<M>

Type Parameters:

M - the raw message type

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, NameAware

All Known Subinterfaces:

ICorrelatedPullingListener<M>, IJmsListener<M>, IKnowsDeliveryCount<M>, IPeekableListener<M>, IPortConnectedListener<M>, IPullingListener<M>, IPushingListener<M>, IRedeliveringListener<M>, ISapListener<F>, ReceiverAware<M>

All Known Implementing Classes:

AbstractFileSystemListener, AbstractJmsListener, AbstractMailListener, ApiListener, BisJmsListener, CmisEventListener, DirectoryListener, EsbJmsListener, ExchangeMailListener, FrankListener, FtpFileSystemListener, FxfListener, ImapListener, JavaListener, JdbcListener, JdbcQueryListener, JdbcTableListener, JmsListener, KafkaListener, MessageStoreListener, MqttListener, PullingJmsListener, PushingJmsListener, PushingListenerAdapter, RestListener, Samba2Listener, SambaListener, SapListener, SapListener, SapListenerImpl, SftpFileSystemListener, SimpleJdbcListener, TibcoLogJmsListener, WebServiceListener

@FrankDocGroup(LISTENER)
@EnterpriseIntegrationPattern(LISTENER)
public interface IListener<M>
extends IConfigurable, FrankElement, NameAware

Base-interface for IPullingListener and IPushingListener.

Since:

4.2

Author:

Gerrit van Brakel

Method Summary

Modifier and Type	Method	Description
void	afterMessageProcessed(PipeLineResult processResult, RawMessageWrapper<M> rawMessage, PipeLineSession pipeLineSession)	Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
Message	extractMessage(RawMessageWrapper<M> rawMessage, Map<String,Object> context)	Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession).
void	start()	Prepares the listener for receiving messages.
void	stop()	Close all resources used for listening.

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.IConfigurable

configure

Methods inherited from interface org.frankframework.core.NameAware

setName

Method Details

start

void start()

Prepares the listener for receiving messages. start() is called once each time the listener is started.

stop

void stop()

Close all resources used for listening. Called once each time the listener is stopped.

extractMessage

Message extractMessage(@Nonnull
 RawMessageWrapper<M> rawMessage,
 @Nonnull
 Map<String,Object> context)
                throws ListenerException

Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession). May also extract other parameters from the message and put those into the context.

Parameters:

rawMessage - The RawMessageWrapper from which to extract the Message.

context - Context to populate. Either a PipeLineSession or a Map threadContext depending on caller.

Returns:

input Message for adapter.

Throws:

ListenerException

afterMessageProcessed

void afterMessageProcessed(PipeLineResult processResult,
 RawMessageWrapper<M> rawMessage,
 PipeLineSession pipeLineSession)
                    throws ListenerException

Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.

Throws:

ListenerException