Package org.frankframework.senders

Class SenderSeries

java.lang.Object

org.frankframework.senders.SenderBase

org.frankframework.senders.SenderWithParametersBase

org.frankframework.senders.SenderWrapperBase

org.frankframework.senders.SenderSeries

All Implemented Interfaces:

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

Direct Known Subclasses:

JavascriptSender, ParallelSenders

public class SenderSeries
extends SenderWrapperBase

Series of Senders, that are executed one after another.

Since:

4.9

Author:

Gerrit van Brakel

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
SenderSeries()

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.
boolean	consumesSessionVariable(String sessionKey)	returns true if the sender or one of its children use the named session variable.
SenderResult	doSendMessage(Message message, PipeLineSession session)
protected Iterable<ISender>	getSenders()
protected io.micrometer.core.instrument.DistributionSummary	getStatisticsKeeper(ISender sender)
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	registerSender(ISender sender)	one or more specifications of senders that will be executed one after another.
final void	setSender(ISender sender)	Deprecated.
void	setSynchronous(boolean synchronous)

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

SenderSeries

public SenderSeries()

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

consumesSessionVariable

public boolean consumesSessionVariable(String sessionKey)

Description copied from interface: ISender

returns true if the sender or one of its children use the named session variable. Callers can use this to determine if a message needs to be preserved.

Specified by:

consumesSessionVariable in interface ISender

Specified by:

consumesSessionVariable in interface ISenderWithParameters

Overrides:

consumesSessionVariable in class SenderWithParametersBase

setSender

@Deprecated
public final void setSender(ISender sender)

Deprecated.

registerSender

public void registerSender(ISender sender)

one or more specifications of senders that will be executed one after another. Each sender will get the result of the preceding one as input.

getStatisticsKeeper

@Nonnull
protected io.micrometer.core.instrument.DistributionSummary getStatisticsKeeper(ISender sender)

getSenders

protected Iterable<ISender> getSenders()

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

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

setSynchronous

public void setSynchronous(boolean synchronous)