Class FrankListener

java.lang.Object

org.frankframework.receivers.FrankListener

All Implemented Interfaces:

ConfigurationAware, FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IListener<Message>, IPushingListener<Message>, IScopeProvider, NameAware, RequestReplyListener, ServiceClient, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@DestinationType(ADAPTER)
@Category(BASIC)
public class FrankListener
extends Object
implements RequestReplyListener, IPushingListener<Message>, HasPhysicalDestination, ServiceClient, ConfigurationAware

Listener to receive messages sent by the FrankSender, for situations where calling an Adapter directly is not desired. This could be because message / error logging is required for messages sent to the subadapter.
See the FrankSender documentation for more information.

Nested Class Summary

Nested classes/interfaces inherited from interface RequestReplyListener

RequestReplyListener.ExceptionHandlingMethod

Constructor Summary

Constructors

Constructor	Description
FrankListener()

Method Summary

Modifier and Type	Method	Description
void	afterMessageProcessed(PipeLineResult processResult, RawMessageWrapper<Message> rawMessage, PipeLineSession pipeLineSession)	Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
void	configure()	Configure this component.
Message	extractMessage(@NonNull RawMessageWrapper<Message> rawMessage, @NonNull Map<String,Object> context)	Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession).
static @Nullable FrankListener	getListener(String name)
String	getPhysicalDestinationName()
Message	processRequest(Message message, PipeLineSession session)	Method to implement for processing a request.
void	setExceptionListener(IbisExceptionListener listener)	Set a (single) listener that will be notified of any exceptions.
void	setName(String name)	Name of the listener by which it can be found by the FrankSender.
void	start()	Prepares the listener for receiving messages.
void	stop()	Close all resources used for listening.
MessageWrapper<Message>	wrapRawMessage(Message rawMessage, PipeLineSession session)	Wrap a raw message in a MessageWrapper.

Methods inherited from class Object

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

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface ConfigurationAware

setConfiguration

Methods inherited from interface FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface IPushingListener

setHandler

Methods inherited from interface RequestReplyListener

getOnException, setOnException

Constructor Details

FrankListener

public FrankListener()

Method Details

getListener

public static @Nullable FrankListener getListener(String name)

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setExceptionListener

public void setExceptionListener(IbisExceptionListener listener)

Description copied from interface: IPushingListener

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.

Specified by:

setExceptionListener in interface IPushingListener<Message>

wrapRawMessage

public MessageWrapper<Message> wrapRawMessage(Message rawMessage,
 PipeLineSession session)

Description copied from interface: IPushingListener

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

Specified by:

wrapRawMessage in interface IPushingListener<Message>

Parameters:

rawMessage - The raw message data, unwrapped

session - PipeLineSession to populate with properties from the message.

Returns:

Wrapped raw message

configure

public void configure()

Description copied from interface: IConfigurable

Configure this component.

configure() is called once at startup of the framework in the configure method of the owner of this IConfigurable. Purpose of this method is to check whether the static configuration of the object is correct. As much as possible class-instantiating should take place in the configure(), to improve performance.

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

start

public void start()

Description copied from interface: IListener

Prepares the listener for receiving messages. start() is called once each time the listener is started.

Specified by:

start in interface IListener<Message>

stop

public void stop()

Description copied from interface: IListener

Close all resources used for listening. Called once each time the listener is stopped.

Specified by:

stop in interface IListener<Message>

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
 RawMessageWrapper<Message> rawMessage,
 PipeLineSession pipeLineSession)

Description copied from interface: IListener

Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.

Specified by:

afterMessageProcessed in interface IListener<Message>

extractMessage

public Message extractMessage(@NonNull RawMessageWrapper<Message> rawMessage,
 @NonNull Map<String,Object> context)

Description copied from interface: IListener

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.

Specified by:

extractMessage in interface IListener<Message>

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.

setName

public void setName(String name)

Name of the listener by which it can be found by the FrankSender. If this is not configured, the name will default to the name of the Adapter. The name of the FrankListener must be unique across the configuration.

Specified by:

setName in interface NameAware

Parameters:

name - Name of the listener. If not set, will default to Adapter name.

processRequest

public Message processRequest(Message message,
 PipeLineSession session)
                       throws ListenerException

Description copied from interface: ServiceClient

Method to implement for processing a request. This will usually delegate to a IListener implementation.
TODO: We may want to add the correlationId parameter back to this method, for cleaner calling and cleaner implementation.

Specified by:

processRequest in interface ServiceClient

Parameters:

message - Message to process

session - PipeLineSession of the request. If the request has a correlation ID, it should be put into this session.

Returns:

Resulting Message.

Throws:

ListenerException - Thrown if an exception occurs.