nl.nn.adapterframework.core

Interface IListener<M>

Type Parameters:

M - the raw message type

All Superinterfaces:

org.springframework.context.ApplicationContextAware, org.springframework.beans.factory.Aware, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider

All Known Subinterfaces:

IBulkDataListener<M>, ICorrelatedPullingListener<M>, IPeekableListener<M>, IPortConnectedListener<M>, IPostboxListener<M>, IPullingListener<M>, IPushingListener<M>, IRedeliveringListener<M>, ISapListener<F>

All Known Implementing Classes:

ApiListener, BisJmsListener, CmisEventListener, DirectoryListener, EsbJmsListener, ExchangeMailListener, FileRecordListener, FileSystemListener, FtpFileSystemListener, FtpListener, FxfListener, HttpListener, IfsaProviderListener, IfsaProviderListener, IfsaSimulatorJmsListener, ImapListener, JavaListener, JdbcListener, JdbcQueryListener, JdbcTableListener, JmsListener, JmsListenerBase, MailListener, MessageStoreListener, MqttListener, PullingIfsaProviderListener, PullingJmsListener, PushingIfsaProviderListener, PushingJmsListener, PushingListenerAdapter, RestListener, Samba2Listener, SambaListener, SapListener, SapListener, SapListenerImpl, SimpleJdbcListener, TibcoListener, TibcoLogJmsListener, WebServiceListener

@FrankDocGroup(order=30,
               name="Listeners")
public interface IListener<M>
extends IConfigurable

Base-interface for IPullingListener and IPushingListener.

Since:

4.2

Author:

Gerrit van Brakel

Method Summary

Modifier and Type	Method and Description
void	afterMessageProcessed(PipeLineResult processResult, Object rawMessageOrWrapper, Map<String,Object> context) Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
void	close() Close all resources used for listening.
void	configure() configure() is called once at startup of the framework in the configure() method of the owner of this listener.
Message	extractMessage(M rawMessage, Map<String,Object> context) Extracts string from message obtained from IPullingListener.getRawMessage(Map).
String	getIdFromRawMessage(M rawMessage, Map<String,Object> context) Extracts ID-string from message obtained from IPullingListener.getRawMessage(Map).
void	open() Prepares the listener for receiving messages.

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

configure

void configure()
        throws ConfigurationException

configure() is called once at startup of the framework in the configure() method of the owner of this listener. Purpose of this method is to reduce creating connections to databases etc. in the IPullingListener.getRawMessage(Map) method. As much as possible class-instantiating should take place in the configure() or open() method, to improve performance.

Specified by:

configure in interface IConfigurable

Throws:

ConfigurationException

open

void open()
   throws ListenerException

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

Throws:

ListenerException

close

void close()
    throws ListenerException

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

Throws:

ListenerException

getIdFromRawMessage

String getIdFromRawMessage(M rawMessage,
                           Map<String,Object> context)
                    throws ListenerException

Extracts ID-string from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the context.
Common entries in the session context are:

• id: messageId, identifies the current transportation of the message
• cid: correlationId, identifies the processing of the message in the global chain
• tsReceived: timestamp of reception of the message, formatted as yyyy-MM-dd HH:mm:ss.SSS
• tsSent: timestamp of sending of the message (only when available), formatted as yyyy-MM-dd HH:mm:ss.SSS

Returns:

Correlation ID string.

Throws:

ListenerException

extractMessage

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

Extracts string from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the threadContext.

Returns:

input message for adapter.

Throws:

ListenerException

afterMessageProcessed

void afterMessageProcessed(PipeLineResult processResult,
                           Object rawMessageOrWrapper,
                           Map<String,Object> context)
                    throws ListenerException

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

Throws:

ListenerException