Package org.frankframework.core

Interface IMessageHandler<M>

Type Parameters:

M - the raw message type

All Known Implementing Classes:

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	Description
Message	formatException(String extraInfo, PipeLineSession session, 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(org.frankframework.receivers.RawMessageWrapper<M>, java.util.Map<java.lang.String, java.lang.Object>) and IListener.afterMessageProcessed(org.frankframework.core.PipeLineResult, org.frankframework.receivers.RawMessageWrapper<M>, org.frankframework.core.PipeLineSession)
Message	processRequest(IListener<M> origin, RawMessageWrapper<M> rawMessage, Message message, PipeLineSession session)	Alternative to functions above, will NOT use IListener.extractMessage(org.frankframework.receivers.RawMessageWrapper<M>, java.util.Map<java.lang.String, java.lang.Object>).

Method Details

processRawMessage

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

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

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(org.frankframework.receivers.RawMessageWrapper<M>, java.util.Map<java.lang.String, java.lang.Object>). Used by PushingListeners.

Throws:

ListenerException

formatException

Message formatException(String extraInfo,
 PipeLineSession session,
 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.