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, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider

All Known Subinterfaces:

ICorrelatedPullingListener<M>, IPeekableListener<M>, IPortConnectedListener<M>, IPostboxListener<M>, IPullingListener<M>, IPushingListener<M>, IRedeliveringListener<M>

All Known Implementing Classes:

ApiListener, FileRecordListener, HttpListener, JavaListener, JdbcListener, JdbcQueryListener, JdbcTableListener, JmsListener, JmsListenerBase, MessageStoreListener, PullingJmsListener, PushingJmsListener, PushingListenerAdapter, RestListener, SimpleJdbcListener, WebServiceListener

@FrankDocGroup(LISTENER)
@ElementType(LISTENER)
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	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.
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(RawMessageWrapper<M> rawMessage, Map<String,Object> context)	Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession).
void	open()	Prepares the listener for receiving messages.

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Method Details

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 each time the listener is stopped.

Throws:

ListenerException

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