@Category(value="Basic") public class FixedResultSender extends SenderWithParametersBase
FixedResultPipe
, but now as a ISender.${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
.parameterNamesMustBeUnique, paramList
log
Constructor and Description |
---|
FixedResultSender() |
Modifier and Type | Method and Description |
---|---|
void |
configure()
configure() is called once at startup of the framework in the configure method of the owner of this sender. |
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 |
setFileName(String fileName)
Deprecated.
|
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
|
addParameter, checkStringAttributeOrParameter, consumesSessionVariable, getParameterList, getParameterOverriddenAttributeValue, getParameterOverriddenAttributeValue, getParameterValueList
close, createBean, getLogPrefix, getName, open, setApplicationContext, setName
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
close, open, sendMessageOrThrow
getName, setName
getApplicationContext, getName
getConfigurationClassLoader
public void configure() throws ConfigurationException
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.configure
in interface IConfigurable
configure
in interface ISender
configure
in class SenderWithParametersBase
ConfigurationException
public SenderResult sendMessage(Message message, PipeLineSession session) throws SenderException, TimeoutException
ISender
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
.
SenderException
TimeoutException
public boolean isSynchronous()
ISender
true
, the result of sendMessage is the reply of the request.public void setSubstituteVars(boolean substitute)
@Deprecated @ConfigurationWarning(value="attribute \'fileName\' is replaced with \'filename\'") public void setFileName(String fileName)
public void setFilename(String filename)
public void setReturnString(String returnString)
public void setReplaceFrom(String replaceFrom)
public void setReplaceTo(String replaceTo)
public void setStyleSheetName(String styleSheetName)
Copyright © 2023 Frank!Framework. All rights reserved.