Package org.frankframework.larva

Class ListenerMessageHandler<M>

java.lang.Object

org.frankframework.larva.ListenerMessageHandler<M>

All Implemented Interfaces:

IMessageHandler<M>

public class ListenerMessageHandler<M>
extends Object
implements IMessageHandler<M>

Message handler for JavaListener and WebServiceListener.

Author:

Jaco de Groot, Niels Meijer

Constructor Summary

Constructors

Constructor	Description
ListenerMessageHandler(long defaultTimeout)

Method Summary

Modifier and Type	Method	Description
Message	formatException(String extraInfo, PipeLineSession arg1, Message arg2, Throwable arg3)	Formats any exception thrown by any of the above methods to a message that can be returned.
ListenerMessage	getRequestMessageOrNull()	Attempt to retrieve a ListenerMessage.
ListenerMessage	getRequestMessageWithDefaultTimeout()
ListenerMessage	getResponseMessageOrNull()	Attempt to retrieve a ListenerMessage.
void	processRawMessage(IListener<M> origin, RawMessageWrapper<M> rawMessage, PipeLineSession threadContext, 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>).
void	putResponseMessage(ListenerMessage listenerMessage)
void	setRequestTimeOut(int timeout)
void	setResponseTimeOut(int timeout)
void	setTimeout(long timeout)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ListenerMessageHandler

public ListenerMessageHandler(long defaultTimeout)

Method Details

processRequest

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

Description copied from interface: IMessageHandler

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.

Specified by:

processRequest in interface IMessageHandler<M>

Throws:

ListenerException

getRequestMessageOrNull

@Nullable
public ListenerMessage getRequestMessageOrNull()

Attempt to retrieve a ListenerMessage. Returns NULL if none is present

getRequestMessageWithDefaultTimeout

@Nonnull
public ListenerMessage getRequestMessageWithDefaultTimeout()
                                                    throws TimeoutException

Throws:

TimeoutException

getResponseMessageOrNull

@Nullable
public ListenerMessage getResponseMessageOrNull()

Attempt to retrieve a ListenerMessage. Returns NULL if none is present

putResponseMessage

public void putResponseMessage(ListenerMessage listenerMessage)

setTimeout

public void setTimeout(long timeout)

setRequestTimeOut

public void setRequestTimeOut(int timeout)

setResponseTimeOut

public void setResponseTimeOut(int timeout)

processRawMessage

public void processRawMessage(IListener<M> origin,
 RawMessageWrapper<M> rawMessage,
 PipeLineSession threadContext,
 boolean duplicatesAlreadyChecked)
                       throws ListenerException

Description copied from interface: IMessageHandler

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)

Specified by:

processRawMessage in interface IMessageHandler<M>

Throws:

ListenerException

formatException

public Message formatException(String extraInfo,
 PipeLineSession arg1,
 Message arg2,
 Throwable arg3)

Description copied from interface: IMessageHandler

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.

Specified by:

formatException in interface IMessageHandler<M>