nl.nn.adapterframework.http

Class PushingListenerAdapter

java.lang.Object

nl.nn.adapterframework.http.PushingListenerAdapter

All Implemented Interfaces:

IConfigurable, IConfigurationAware, IListener<Message>, INamedObject, IPushingListener<Message>, IScopeProvider, ServiceClient, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ApiListener, CmisEventListener, HttpListener, RestListener, WebServiceListener

public abstract 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 and Description
protected org.apache.logging.log4j.Logger	log

Constructor Summary

Constructors

Constructor and Description
PushingListenerAdapter()

Method Summary

Modifier and Type	Method and Description
void	afterMessageProcessed(PipeLineResult processResult, Object rawMessageOrWrapper, Map<String,Object> threadContext) Called to perform actions (like committing or sending a reply) after a message has been processed by the Pipeline.
void	close() Close all resources used for listening.
void	configure() initialize listener and register this to the JNDI
Message	extractMessage(Message rawMessage, Map<String,Object> threadContext) Extracts string from message obtained from IPullingListener.getRawMessage(Map).
String	getIdFromRawMessage(Message rawMessage, Map<String,Object> threadContext) Extracts ID-string from message obtained from IPullingListener.getRawMessage(Map).
void	open() Prepares the listener for receiving messages.
Message	processRequest(Message rawMessage, PipeLineSession session)
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)
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Field Detail

log

protected org.apache.logging.log4j.Logger log

Constructor Detail

PushingListenerAdapter

public PushingListenerAdapter()

Method Detail

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

open

public void open()
          throws ListenerException

Description copied from interface: IListener

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

Specified by:

open in interface IListener<Message>

Throws:

ListenerException

close

public void close()

Description copied from interface: IListener

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

Specified by:

close in interface IListener<Message>

getIdFromRawMessage

public String getIdFromRawMessage(Message rawMessage,
                                  Map<String,Object> threadContext)

Description copied from interface: IListener

Extracts ID-string from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the context.
Common entries in the session context are:

• id: messageId, identifies the current transportation of the message
• cid: correlationId, identifies the processing of the message in the global chain
• tsReceived: timestamp of reception of the message, formatted as yyyy-MM-dd HH:mm:ss.SSS
• tsSent: timestamp of sending of the message (only when available), formatted as yyyy-MM-dd HH:mm:ss.SSS

Specified by:

getIdFromRawMessage in interface IListener<Message>

Returns:

Correlation ID string.

extractMessage

public Message extractMessage(Message rawMessage,
                              Map<String,Object> threadContext)

Description copied from interface: IListener

Extracts string from message obtained from IPullingListener.getRawMessage(Map). May also extract other parameters from the message and put those in the threadContext.

Specified by:

extractMessage in interface IListener<Message>

Returns:

input message for adapter.

afterMessageProcessed

public void afterMessageProcessed(PipeLineResult processResult,
                                  Object rawMessageOrWrapper,
                                  Map<String,Object> threadContext)
                           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<Message>

Throws:

ListenerException

processRequest

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

Specified by:

processRequest in interface ServiceClient

Throws:

ListenerException

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 INamedObject

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)