nl.nn.adapterframework.core

Interface IMessageHandler<M>

Type Parameters:

M - the raw message type

All Known Implementing Classes:

GenericReceiver, ListenerMessageHandler, Receiver

public interface IMessageHandler<M>

Interface that PushingListeners can use to handle the messages they receive. A call to any of the method defined in this interface will do to process the message.

Since:

4.2

Author:

Gerrit van Brakel

Method Summary

Modifier and Type	Method and Description
Message	formatException(String extraInfo, String correlationId, Message message, Throwable t) Formats any exception thrown by any of the above methods to a message that can be returned.
void	processRawMessage(IListener<M> origin, RawMessageWrapper<M> message, PipeLineSession session, boolean duplicatesAlreadyChecked) Will use listener to perform IListener.extractMessage(nl.nn.adapterframework.receivers.RawMessageWrapper<M>, java.util.Map<java.lang.String, java.lang.Object>) and IListener.afterMessageProcessed(nl.nn.adapterframework.core.PipeLineResult, nl.nn.adapterframework.receivers.RawMessageWrapper<M>, nl.nn.adapterframework.core.PipeLineSession)
void	processRawMessage(IListener<M> origin, RawMessageWrapper<M> message, PipeLineSession session, long waitingTime, boolean duplicatesAlreadyChecked) Same as processRawMessage(IListener,RawMessageWrapper,PipeLineSession, boolean), but now updates IdleStatistics too
Message	processRequest(IListener<M> origin, RawMessageWrapper<M> rawMessage, Message message, PipeLineSession session) Alternative to functions above, will NOT use IListener.extractMessage(nl.nn.adapterframework.receivers.RawMessageWrapper<M>, java.util.Map<java.lang.String, java.lang.Object>).

Method Detail

processRawMessage

void processRawMessage(IListener<M> origin,
                       RawMessageWrapper<M> message,
                       PipeLineSession session,
                       boolean duplicatesAlreadyChecked)
                throws ListenerException

Will use listener to perform IListener.extractMessage(nl.nn.adapterframework.receivers.RawMessageWrapper<M>, java.util.Map<java.lang.String, java.lang.Object>) and IListener.afterMessageProcessed(nl.nn.adapterframework.core.PipeLineResult, nl.nn.adapterframework.receivers.RawMessageWrapper<M>, nl.nn.adapterframework.core.PipeLineSession)

Throws:

ListenerException

processRawMessage

void processRawMessage(IListener<M> origin,
                       RawMessageWrapper<M> message,
                       PipeLineSession session,
                       long waitingTime,
                       boolean duplicatesAlreadyChecked)
                throws ListenerException

Same as processRawMessage(IListener,RawMessageWrapper,PipeLineSession, boolean), but now updates IdleStatistics too

Throws:

ListenerException

processRequest

Message processRequest(IListener<M> origin,
                       RawMessageWrapper<M> rawMessage,
                       Message message,
                       PipeLineSession session)
                throws ListenerException

Alternative to functions above, will NOT use IListener.extractMessage(nl.nn.adapterframework.receivers.RawMessageWrapper<M>, java.util.Map<java.lang.String, java.lang.Object>). Used by PushingListeners.

Throws:

ListenerException

formatException

Message formatException(String extraInfo,
                        String correlationId,
                        Message message,
                        Throwable t)

Formats any exception thrown by any of the above methods to a message that can be returned. Can be used if the calling system has no other way of returning the exception to the caller.