Package org.frankframework.http

Class PushingListenerAdapter

java.lang.Object

org.frankframework.http.PushingListenerAdapter

All Implemented Interfaces:

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

Direct Known Subclasses:

ApiListener, RestListener, WebServiceListener

public class PushingListenerAdapter
extends Object
implements IPushingListener<Message>, ServiceClient

Baseclass of a IPushingListener that enables a Receiver to receive messages from Servlets.

Since:

4.12

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field	Description
protected org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor	Description
PushingListenerAdapter()

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()	initialize listener and register this to the JNDI
Message	extractMessage(RawMessageWrapper<Message> rawMessage, Map<String,Object> context)	Extracts data from message obtained from IPullingListener.getRawMessage(Map) or IPushingListener.wrapRawMessage(Object, PipeLineSession).
org.springframework.context.ApplicationContext	getApplicationContext()
ClassLoader	getConfigurationClassLoader()	This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.
String	getName()
boolean	isApplicationFaultsAsExceptions()
boolean	isRunning()
Message	processRequest(Message rawMessage, PipeLineSession session)	Method to implement for processing a request.
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setApplicationFaultsAsExceptions(boolean b)
void	setExceptionListener(IbisExceptionListener exceptionListener)	Set a (single) listener that will be notified of any exceptions.
void	setHandler(IMessageHandler<Message> handler)	Set the handler that will do the processing of the message.
void	setName(String name)	Name of the listener as known to the adapter
void	setRunning(boolean running)
void	start()	Prepares the listener for receiving messages.
void	stop()	Close all resources used for listening.
String	toString()
RawMessageWrapper<Message>	wrapRawMessage(Message rawMessage, PipeLineSession session)	Wrap a raw message in a MessageWrapper.

Methods inherited from class java.lang.Object

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

Field Details

log

protected org.apache.logging.log4j.Logger log

Constructor Details

PushingListenerAdapter

public PushingListenerAdapter()

Method Details

configure

public void configure()
               throws ConfigurationException

initialize listener and register this to the JNDI

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IListener<Message>

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. open() 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>

wrapRawMessage

public RawMessageWrapper<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

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.

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>

processRequest

public Message processRequest(Message rawMessage,
 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:

rawMessage - 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.

toString

public String toString()

Overrides:

toString in class Object

setName

public void setName(String name)

Name of the listener as known to the adapter

Specified by:

setName in interface NameAware

setHandler

public void setHandler(IMessageHandler<Message> handler)

Description copied from interface: IPushingListener

Set the handler that will do the processing of the message. Each of the received messages must be pushed through handler.processMessage()

Specified by:

setHandler in interface IPushingListener<Message>

setExceptionListener

public void setExceptionListener(IbisExceptionListener exceptionListener)

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>

setApplicationFaultsAsExceptions

public void setApplicationFaultsAsExceptions(boolean b)

setRunning

@Protected
public void setRunning(boolean running)

getName

public String getName()

Specified by:

getName in interface HasName

isApplicationFaultsAsExceptions

public boolean isApplicationFaultsAsExceptions()

isRunning

public boolean isRunning()

getConfigurationClassLoader

public ClassLoader getConfigurationClassLoader()

Description copied from interface: IScopeProvider

This ClassLoader is set upon creation of the object, used to retrieve resources configured by the Ibis application.

Specified by:

getConfigurationClassLoader in interface HasApplicationContext

Specified by:

getConfigurationClassLoader in interface IScopeProvider

Returns:

returns the ClassLoader created by the ClassLoaderManager.

getApplicationContext

public org.springframework.context.ApplicationContext getApplicationContext()

Specified by:

getApplicationContext in interface HasApplicationContext

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware