Package org.frankframework.core

Interface IPushingListener<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:

IPortConnectedListener<M>

All Known Implementing Classes:

ApiListener, FrankListener, HttpListener, JavaListener, JmsListener, PushingJmsListener, PushingListenerAdapter, RestListener, WebServiceListener

public interface IPushingListener<M>
extends IListener<M>

Defines listening behaviour of message driven receivers.

Since:

4.2

Author:

Gerrit van Brakel

Method Summary

Modifier and Type	Method	Description
void	setExceptionListener(IbisExceptionListener listener)	Set a (single) listener that will be notified of any exceptions.
void	setHandler(IMessageHandler<M> handler)	Set the handler that will do the processing of the message.
RawMessageWrapper<M>	wrapRawMessage(M rawMessage, PipeLineSession session)	Wrap a raw message in a MessageWrapper.

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.IListener

afterMessageProcessed, configure, extractMessage, start, stop

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Method Details

setHandler

void setHandler(IMessageHandler<M> handler)

Set the handler that will do the processing of the message. Each of the received messages must be pushed through handler.processMessage()

setExceptionListener

void setExceptionListener(IbisExceptionListener listener)

Set a (single) listener that will be notified of any exceptions. The listener should use this listener to notify the receiver of any exception that occurs outside the processing of a message.

wrapRawMessage

RawMessageWrapper<M> wrapRawMessage(M rawMessage,
 PipeLineSession session)
                             throws ListenerException

Wrap a raw message in a MessageWrapper. Populate PipeLineSession with properties from the message.

Parameters:

rawMessage - The raw message data, unwrapped

session - PipeLineSession to populate with properties from the message.

Returns:

Wrapped raw message

Throws:

ListenerException - If any exception occurs during wrapping, a ListenerException is thrown.