Package org.frankframework.senders

Class SenderWrapper

java.lang.Object

org.frankframework.senders.SenderBase

org.frankframework.senders.SenderWithParametersBase

org.frankframework.senders.SenderWrapperBase

org.frankframework.senders.SenderWrapper

All Implemented Interfaces:

ICacheEnabled<String,String>, AdapterAware, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, 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

Field Summary

Fields inherited from class org.frankframework.senders.SenderWrapperBase

adapter, configurationMetrics, senderWrapperProcessor

Fields inherited from class org.frankframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class org.frankframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor	Description
SenderWrapper()

Method Summary

Modifier and Type	Method	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)
ISender	getSender()	specification of sender to send messages with
protected boolean	isSenderConfigured()
boolean	isSynchronous()	When true, the result of sendMessage is the reply of the request.
void	open()	This method will be called to start the sender.
void	setSender(ISender sender)	specification of sender to send messages with

Methods inherited from class org.frankframework.senders.SenderWrapperBase

getCache, getGetInputFromFixedValue, getGetInputFromSessionKey, getLogPrefix, getStoreInputInSessionKey, getStoreResultInSessionKey, isPreserveInput, sendMessage, setAdapter, setCache, setConfigurationMetrics, setGetInputFromFixedValue, setGetInputFromSessionKey, setPreserveInput, setSenderWrapperProcessor, setStoreInputInSessionKey, setStoreResultInSessionKey

Methods inherited from class org.frankframework.senders.SenderWithParametersBase

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

Methods inherited from class org.frankframework.senders.SenderBase

createBean, getApplicationContext, getConfigurationClassLoader, 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 org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface org.frankframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.ISender

sendMessageOrThrow

Constructor Details

SenderWrapper

public SenderWrapper()

Method Details

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

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

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

getSender

public ISender getSender()

specification of sender to send messages with

setSender

public void setSender(ISender sender)

specification of sender to send messages with