Package org.frankframework.senders

Class EchoSender

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

org.frankframework.senders.EchoSender

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 EchoSender
extends AbstractSenderWithParameters

Echos input to output.

Since:

4.9

Author:

Gerrit van Brakel

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

Method Summary

Modifier and Type	Method	Description
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	setSynchronous(boolean b)	hack to allow to introduce a correlationid

Methods inherited from class org.frankframework.senders.AbstractSenderWithParameters

addParameter, checkStringAttributeOrParameter, configure, 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

EchoSender

public EchoSender()

Method Details

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

setSynchronous

public void setSynchronous(boolean b)

hack to allow to introduce a correlationid

Default value

true

isSynchronous

public boolean isSynchronous()

Description copied from interface: ISender

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