Package org.frankframework.senders

Class ShadowSender

java.lang.Object

org.frankframework.senders.SenderBase

org.frankframework.senders.SenderWithParametersBase

org.frankframework.senders.SenderWrapperBase

org.frankframework.senders.SenderSeries

org.frankframework.senders.ParallelSenders

org.frankframework.senders.ShadowSender

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 ShadowSender
extends ParallelSenders

Collection of Senders, that are executed all at the same time. Once the results are processed, all results will be sent to the resultSender, while the original sender will return its result to the pipeline.

Multiple sub-senders can be configured within the ShadowSender, the minimum amount of senders is 2 (originalSender + resultSender)

Since:

7.0

Author:

Niels Meijer

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

Method Summary

Modifier and Type	Method	Description
protected void	addResult(SaxDocumentBuilder builder, ISender sender, Map<ISender,ParallelSenderExecutor> executorMap, String tagName)
void	configure()	configure() is called once at startup of the framework in the configure method of the owner of this sender.
protected void	executeGuarded(ISender sender, Message message, PipeLineSession session, Phaser guard, Map<ISender,ParallelSenderExecutor> executorMap)
String	getOriginalSenderName()
String	getResultSenderName()
List<ISender>	getSecondarySenders()
boolean	isWaitForShadowsToFinish()
SenderResult	sendMessage(Message message, PipeLineSession session)	Override this from the parallel sender as it should only execute the original and shadowsenders here!
void	setOriginalSender(String senderName)	Name of the sender that is considered that is considered to be the golden standard, i.e.
void	setResultSender(String senderName)	The sender name which will process the results
void	setWaitForShadowsToFinish(boolean waitForShadowsToFinish)	If set true the sender will wait for all shadows to have finished.
List<ISender>	validateExecutableSenders()

Methods inherited from class org.frankframework.senders.ParallelSenders

createTaskExecutor, doSendMessage, getExecutor, getMaxConcurrentThreads, registerSender, setMaxConcurrentThreads, setSynchronous

Methods inherited from class org.frankframework.senders.SenderSeries

close, consumesSessionVariable, getSenders, getStatisticsKeeper, isSenderConfigured, isSynchronous, open, setSender

Methods inherited from class org.frankframework.senders.SenderWrapperBase

getCache, getGetInputFromFixedValue, getGetInputFromSessionKey, getLogPrefix, getStoreInputInSessionKey, getStoreResultInSessionKey, isPreserveInput, 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

ShadowSender

public ShadowSender()

Method Details

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 ParallelSenders

Throws:

ConfigurationException

validateExecutableSenders

public List<ISender> validateExecutableSenders()
                                        throws ConfigurationException

Throws:

ConfigurationException

executeGuarded

protected void executeGuarded(ISender sender,
 Message message,
 PipeLineSession session,
 Phaser guard,
 Map<ISender,ParallelSenderExecutor> executorMap)
                       throws SenderException

Throws:

SenderException

sendMessage

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

Override this from the parallel sender as it should only execute the original and shadowsenders here!

Specified by:

sendMessage in interface ISender

Overrides:

sendMessage in class SenderWrapperBase

Throws:

SenderException

TimeoutException

addResult

protected void addResult(SaxDocumentBuilder builder,
 ISender sender,
 Map<ISender,ParallelSenderExecutor> executorMap,
 String tagName)
                  throws SAXException,
IOException

Throws:

SAXException

IOException

setOriginalSender

public void setOriginalSender(String senderName)

Name of the sender that is considered that is considered to be the golden standard, i.e. the source of truth.

Default value

the first sender specified

setResultSender

public void setResultSender(String senderName)

The sender name which will process the results

Default value

the last sender specified

setWaitForShadowsToFinish

public void setWaitForShadowsToFinish(boolean waitForShadowsToFinish)

If set true the sender will wait for all shadows to have finished. Otherwise the collection of results will happen in a background thread.

Default value

false

getOriginalSenderName

public String getOriginalSenderName()

getResultSenderName

public String getResultSenderName()

getSecondarySenders

public List<ISender> getSecondarySenders()

isWaitForShadowsToFinish

public boolean isWaitForShadowsToFinish()