Package org.frankframework.senders

Class AbstractSenderWithParameters

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, IConfigurable, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, NameAware, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

Direct Known Subclasses:

AbstractBlockEnabledSender, AbstractCollectorSender, AbstractFileSystemSender, AbstractMailSender, AbstractSenderWrapper, AmqpSender, CmisSender, CommandSender, EchoSender, FixedResultSender, FrankSender, IbisJavaSender, IbisLocalSender, IdinSender, LogSender, MongoDbSender, ReloadSender, WebServiceNtlmSender, XComSender, XfbSender, XmlJmsBrowserSender, XsltSender

public abstract class AbstractSenderWithParameters
extends AbstractSender
implements ISenderWithParameters

Provides a base class for senders with parameters.

Since:

4.3

Author:

Gerrit van Brakel

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	parameterNamesMustBeUnique
protected ParameterList	paramList

Fields inherited from class org.frankframework.senders.AbstractSender

log

Constructor Summary

Constructors

Constructor	Description
AbstractSenderWithParameters()

Method Summary

Modifier and Type	Method	Description
void	addParameter(IParameter p)
protected void	checkStringAttributeOrParameter(String attributeName, String attributeValue, String parameterName)
void	configure()	Configure this component.
boolean	consumesSessionVariable(String sessionKey)	returns true if the sender or one of its children use the named session variable.
ParameterList	getParameterList()	return the Parameters
protected int	getParameterOverriddenAttributeValue(ParameterValueList pvl, String parameterName, int attributeValue)
protected String	getParameterOverriddenAttributeValue(ParameterValueList pvl, String parameterName, String attributeValue)
protected ParameterValueList	getParameterValueList(Message input, PipeLineSession session)

Methods inherited from class org.frankframework.senders.AbstractSender

createBean, getLogPrefix, getName, isRunning, setApplicationContext, setName, start, stop

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.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.ISender

isSynchronous, sendMessage, sendMessageOrThrow, start, stop

Methods inherited from interface org.frankframework.core.NameAware

setName

Field Details

paramList

@Nonnull
protected ParameterList paramList

parameterNamesMustBeUnique

protected boolean parameterNamesMustBeUnique

Constructor Details

AbstractSenderWithParameters

public AbstractSenderWithParameters()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: IConfigurable

Configure this component.

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

In the case of a container, this will propagate the configure signal to all components that apply.

Specified by:

configure in interface IConfigurable

Overrides:

configure in class AbstractSender

Throws:

ConfigurationException - in case it was not able to configure the component.

addParameter

public void addParameter(IParameter p)

Specified by:

addParameter in interface IWithParameters

getParameterList

@Nonnull
public ParameterList getParameterList()

return the Parameters

Specified by:

getParameterList in interface IWithParameters

checkStringAttributeOrParameter

protected void checkStringAttributeOrParameter(String attributeName,
 String attributeValue,
 String parameterName)
                                        throws ConfigurationException

Throws:

ConfigurationException

getParameterOverriddenAttributeValue

protected String getParameterOverriddenAttributeValue(ParameterValueList pvl,
 String parameterName,
 String attributeValue)

getParameterOverriddenAttributeValue

protected int getParameterOverriddenAttributeValue(ParameterValueList pvl,
 String parameterName,
 int attributeValue)

getParameterValueList

@Nullable
protected ParameterValueList getParameterValueList(Message input,
 PipeLineSession session)
                                            throws SenderException

Throws:

SenderException

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