nl.nn.adapterframework.senders

Class SenderWrapperBase

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.senders.SenderWrapperBase

All Implemented Interfaces:

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

Direct Known Subclasses:

SenderSeries, SenderWrapper

public abstract class SenderWrapperBase
extends SenderWithParametersBase
implements HasStatistics, ICacheEnabled<String,String>

Baseclass for Wrappers 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

Nested Class Summary

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

HasStatistics.Action

Field Summary

Fields

Modifier and Type	Field and Description
protected SenderWrapperProcessor	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
SenderWrapperBase()

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.
abstract SenderResult	doSendMessage(Message message, PipeLineSession session)
String	getLogPrefix() Returns the true name of the class and not XsltPipe$$EnhancerBySpringCGLIB$$563e6b5d.
protected abstract boolean	isSenderConfigured()
void	open() This method will be called to start the sender.
SenderResult	sendMessage(Message message, PipeLineSession session) Send a message to some destination (as configured in the Sender object).
void	setGetInputFromFixedValue(String string) If set, this fixed value is taken as input, instead of regular input
void	setGetInputFromSessionKey(String string) If set, input is taken from this session key, instead of regular input
void	setPreserveInput(boolean preserveInput) If set true, the input of a pipe is restored before processing the next one
void	setStoreInputInSessionKey(String string) If set, the input is stored under this session key
void	setStoreResultInSessionKey(String string) If set, the result is stored under this session key

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.statistics.HasStatistics

iterateOverStatistics

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

getCache, setCache

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

isSynchronous, 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

Field Detail

senderWrapperProcessor

protected SenderWrapperProcessor senderWrapperProcessor

Constructor Detail

SenderWrapperBase

public SenderWrapperBase()

Method Detail

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 SenderWithParametersBase

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 SenderBase

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 SenderBase

Throws:

SenderException

isSenderConfigured

protected abstract boolean isSenderConfigured()

doSendMessage

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

Throws:

SenderException

TimeoutException

sendMessage

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

Description copied from interface: ISender

Send a message to some destination (as configured in the Sender object). This method may only be called after the configure() method is called.

The following table shows the difference between synchronous and a-synchronous senders:

	synchronous	a-synchronous
ISender.isSynchronous() returns	true	false
return value of sendMessage() is	the reply-message	the messageId of the message sent
the correlationID specified with sendMessage()	may be ignored	is sent with the message
a {link TimeOutException}	may be thrown if a timeout occurs waiting for a reply	should not be expected

Multiple objects may try to call this method at the same time, from different threads. Implementations of this method should therefore be thread-safe, or synchronized.

Specified by:

sendMessage in interface ISender

Throws:

SenderException

TimeoutException

getLogPrefix

public String getLogPrefix()

Description copied from class: SenderBase

Returns the true name of the class and not XsltPipe$$EnhancerBySpringCGLIB$$563e6b5d. ClassUtils.nameOf(Object) makes sure the original class will be used.

Overrides:

getLogPrefix in class SenderBase

Returns:

className + name of the ISender

setGetInputFromSessionKey

public void setGetInputFromSessionKey(String string)

If set, input is taken from this session key, instead of regular input

setGetInputFromFixedValue

public void setGetInputFromFixedValue(String string)

If set, this fixed value is taken as input, instead of regular input

setPreserveInput

public void setPreserveInput(boolean preserveInput)

If set true, the input of a pipe is restored before processing the next one

Default value

false

setStoreResultInSessionKey

public void setStoreResultInSessionKey(String string)

If set, the result is stored under this session key

setStoreInputInSessionKey

public void setStoreInputInSessionKey(String string)

If set, the input is stored under this session key