nl.nn.adapterframework.senders

Class SenderWrapper

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.senders.SenderWrapperBase

nl.nn.adapterframework.senders.SenderWrapper

All Implemented Interfaces:

ICacheEnabled<String,String>, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, HasStatistics, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class SenderWrapper
extends SenderWrapperBase

Wrapper for senders, that allows to get input from a session variable, and to store output in a session variable.

Since:

4.9

Author:

Gerrit van Brakel

Parameters

any parameters defined on the SenderWrapper will be handed to the sender, if this is a ISenderWithParameters

Nested Class Summary

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

Fields inherited from class nl.nn.adapterframework.senders.SenderWrapperBase

senderWrapperProcessor

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor and Description
SenderWrapper()

Method Summary

Modifier and Type	Method and Description
void	close() Stop/close the sender and deallocate resources.
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
SenderResult	doSendMessage(Message message, PipeLineSession session)
protected boolean	isSenderConfigured()
boolean	isSynchronous() When true, the result of sendMessage is the reply of the request.
void	iterateOverStatistics(StatisticsKeeperIterationHandler hski, Object data, HasStatistics.Action action)
void	open() This method will be called to start the sender.

Methods inherited from class nl.nn.adapterframework.senders.SenderWrapperBase

getLogPrefix, sendMessage, setGetInputFromFixedValue, setGetInputFromSessionKey, setPreserveInput, setStoreInputInSessionKey, setStoreResultInSessionKey

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

createBean, getName, setApplicationContext, setName

Methods inherited from class java.lang.Object

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

Methods inherited from interface nl.nn.adapterframework.cache.ICacheEnabled

getCache, setCache

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

sendMessageOrThrow

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

getName, setName

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

Constructor Detail

SenderWrapper

public SenderWrapper()

Method Detail

isSenderConfigured

protected boolean isSenderConfigured()

Specified by:

isSenderConfigured in class SenderWrapperBase

configure

public void configure()
               throws ConfigurationException

Description copied from interface: ISender

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

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class SenderWrapperBase

Throws:

ConfigurationException

open

public void open()
          throws SenderException

Description copied from interface: ISender

This method will be called to start the sender. After this method is called the sendMessage method may be called. Purpose of this method is to reduce creating connections to databases etc. in the sendMessage() method.

Specified by:

open in interface ISender

Overrides:

open in class SenderWrapperBase

Throws:

SenderException

close

public void close()
           throws SenderException

Description copied from interface: ISender

Stop/close the sender and deallocate resources.

Specified by:

close in interface ISender

Overrides:

close in class SenderWrapperBase

Throws:

SenderException

doSendMessage

public SenderResult doSendMessage(Message message,
                                  PipeLineSession session)
                           throws SenderException,
                                  TimeoutException

Specified by:

doSendMessage in class SenderWrapperBase

Throws:

SenderException

TimeoutException

iterateOverStatistics

public void iterateOverStatistics(StatisticsKeeperIterationHandler hski,
                                  Object data,
                                  HasStatistics.Action action)
                           throws SenderException

Throws:

SenderException

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

When true, the result of sendMessage is the reply of the request.

Specified by:

isSynchronous in interface ISender

Overrides:

isSynchronous in class SenderBase