Package org.frankframework.senders

Class FixedResultSender

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

org.frankframework.senders.FixedResultSender

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

@Category(BASIC)
public class FixedResultSender
extends AbstractSenderWithParameters

FixedResultSender, same behaviour as FixedResultPipe, but now as a ISender.

Since:

4.9

Author:

Gerrit van Brakel

Parameters

Any parameters defined on the sender will be used for replacements. Each occurrence of ${name-of-parameter} in the file fileName will be replaced by its corresponding value-of-parameter. This works only with files, not with values supplied in attribute returnString.

Field Summary

Fields inherited from class org.frankframework.senders.AbstractSenderWithParameters

parameterNamesMustBeUnique, paramList

Fields inherited from class org.frankframework.senders.AbstractSender

log

Constructor Summary

Constructors

Constructor	Description
FixedResultSender()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
boolean	isSynchronous()	When true, the result of sendMessage is the reply of the request.
SenderResult	sendMessage(Message message, PipeLineSession session)	Send a message to some destination (as configured in the Sender object).
void	setFilename(String filename)	Name of the file containing the result message
void	setReplaceFrom(String replaceFrom)
void	setReplaceTo(String replaceTo)
void	setReturnString(String returnString)	returned message
void	setStyleSheetName(String styleSheetName)
void	setSubstituteVars(boolean substitute)	should values between ${ and } be resolved from the pipelinesession

Methods inherited from class org.frankframework.senders.AbstractSenderWithParameters

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

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

sendMessageOrThrow, start, stop

Methods inherited from interface org.frankframework.core.NameAware

setName

Constructor Details

FixedResultSender

public FixedResultSender()

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 AbstractSenderWithParameters

Throws:

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

sendMessage

@Nonnull
public SenderResult sendMessage(@Nonnull
 Message message,
 @Nonnull
 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.

Throws:

SenderException

TimeoutException

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

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

setSubstituteVars

public void setSubstituteVars(boolean substitute)

should values between ${ and } be resolved from the pipelinesession

Default value

false

setFilename

public void setFilename(String filename)

Name of the file containing the result message

setReturnString

public void setReturnString(String returnString)

returned message

setReplaceFrom

public void setReplaceFrom(String replaceFrom)

setReplaceTo

public void setReplaceTo(String replaceTo)

setStyleSheetName

public void setStyleSheetName(String styleSheetName)