Class JavaListener<M>

java.lang.Object

org.frankframework.receivers.JavaListener<M>

All Implemented Interfaces:

nl.nn.adapterframework.dispatcher.RequestProcessor, FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, IConfigurable, IListener<M>, IPushingListener<M>, IScopeProvider, NameAware, RequestReplyListener, ServiceClient, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

@DestinationType(JVM)
@Category(BASIC)
public class JavaListener<M>
extends Object
implements RequestReplyListener, IPushingListener<M>, nl.nn.adapterframework.dispatcher.RequestProcessor, HasPhysicalDestination, ServiceClient

Use this listener to receive messages from other adapters or a scheduler within the same Frank-application or from other components residing in the same JVM. JavaListeners can receive calls made via de ibis-servicedispatcher, which should be located on the JVM classpath to receive calls from other components in the JVM. If you want to call an adapter in the same Frank-application, consider using the IbisLocalSender.

To understand what this listener does exactly, please remember that the Frank!Framework is a Java application. The JavaListener listens to Java method calls. You can issue Java method calls using a IbisJavaSender (external call) or IbisLocalSender (internal call).

Calling the JavaListener via the IbisJavaSender forces all request messages to be passed as strings without metadata.

When calling the JavaListener via the IbisLocalSender all messages are passed in their native format, retaining all their metadata.

Author:

Gerrit van Brakel

See Also:

• The ServiceDispatcher project on Gitbug for more information.

Nested Class Summary

Nested classes/interfaces inherited from interface RequestReplyListener

RequestReplyListener.ExceptionHandlingMethod

Constructor Summary

Constructors

Constructor	Description
JavaListener()

Method Summary

Modifier and Type	Method	Description
void	afterMessageProcessed(PipeLineResult processResult, RawMessageWrapper<M> 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<M> rawMessage, @NonNull Map<String,Object> context)	Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession).
static JavaListener<?>	getListener(String name)	Returns JavaListener registered under the given name
static Set<String>	getListenerNames()
String	getPhysicalDestinationName()
String	processRequest(String correlationId, String rawMessage, HashMap context)
Message	processRequest(Message message, @NonNull 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	setHttpWsdl(boolean httpWsdl)	If true, the WSDL of the service provided by this listener will available for download
void	setName(String name)	Internal name of the listener, as known to the adapter.
void	setReturnedSessionKeys(String string)	Comma separated list of keys of session variables that should be returned to caller, for correct results as well as for erroneous results.
void	setServiceName(String jndiName)	External Name of the listener.
void	setThrowException(boolean throwException)	Deprecated.
void	start()	Prepares the listener for receiving messages.
void	stop()	Close all resources used for listening.
RawMessageWrapper<M>	wrapRawMessage(M 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 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

JavaListener

public JavaListener()

Method Details

configure

public void configure()
               throws ConfigurationException

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

Throws:

ConfigurationException - in case it was not able to configure the component.

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<M>

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<M>

wrapRawMessage

public RawMessageWrapper<M> wrapRawMessage(M rawMessage,
 PipeLineSession session)

Description copied from interface: IPushingListener

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

If the returned object is an instance of MessageWrapper then the Receiver.processRawMessage(IListener, RawMessageWrapper, PipeLineSession, boolean) will not call IListener.extractMessage(RawMessageWrapper, Map) but directly access the enclosed Message and the

invalid reference

RawMessageWrapper#getContext()

.

Specified by:

wrapRawMessage in interface IPushingListener<M>

Parameters:

rawMessage - The raw message data, unwrapped

session - PipeLineSession to populate with properties from the message.

Returns:

Wrapped raw message

processRequest

public String processRequest(String correlationId,
 String rawMessage,
 HashMap context)
                      throws ListenerException

Specified by:

processRequest in interface nl.nn.adapterframework.dispatcher.RequestProcessor

Throws:

ListenerException

processRequest

public Message processRequest(Message message,
 @NonNull 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.

getListener

public static JavaListener<?> getListener(String name)

Returns JavaListener registered under the given name

getListenerNames

public static Set<String> getListenerNames()

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<M>

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
 RawMessageWrapper<M> rawMessage,
 PipeLineSession pipeLineSession)
                           throws ListenerException

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<M>

Throws:

ListenerException

extractMessage

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

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.

The Receiver does not call this method when the listener implementation returned an instance of MessageWrapper from IPullingListener.getRawMessage(Map) or * IPushingListener.wrapRawMessage(Object, PipeLineSession).

Specified by:

extractMessage in interface IListener<M>

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.

Throws:

ListenerException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

setName

@Mandatory
public void setName(String name)

Internal name of the listener, as known to the adapter. An IbisLocalSender refers to this name in its javaListener-attribute.

Specified by:

setName in interface NameAware

setServiceName

public void setServiceName(String jndiName)

External Name of the listener. An IbisJavaSender refers to this name in its serviceName-attribute.

setReturnedSessionKeys

public void setReturnedSessionKeys(String string)

Comma separated list of keys of session variables that should be returned to caller, for correct results as well as for erroneous results. If not set (not even to an empty value), all session keys can be returned.

Default value

all session keys can be returned

setThrowException

@Deprecated(since="9.2")
@ConfigurationWarning("Replaced with attribute 'onException', true = 'RETHROW' and false 'FORMAT_AND_RETURN'")
public void setThrowException(boolean throwException)

Deprecated.

Should the JavaListener throw a ListenerException when it occurs or return an error message. Please consider using an ErrorMessageFormatter instead of disabling Exception from being thrown.

Default value

true

setHttpWsdl

public void setHttpWsdl(boolean httpWsdl)

If true, the WSDL of the service provided by this listener will available for download

Default value

false