Class AbstractCollectorSender<C extends ICollector<P>, P>

java.lang.Object

org.frankframework.senders.AbstractSender

org.frankframework.senders.AbstractSenderWithParameters

org.frankframework.collection.AbstractCollectorSender<C,P>

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:

ZipWriterSender

public abstract class AbstractCollectorSender<C extends ICollector<P>, P>
extends AbstractSenderWithParameters

Sender that writes an item to a collection, created by AbstractCollectorPipe with action=OPEN.

Author:

Niels Meijer

Parameters

all parameters are handled by the collection.

Field Summary

Fields inherited from class AbstractSenderWithParameters

parameterNamesMustBeUnique, paramList

Fields inherited from class AbstractSender

log

Constructor Summary

Constructors

Constructor	Description
AbstractCollectorSender()

Method Summary

Modifier and Type	Method	Description
void	configure()	Configure this component.
protected @NonNull Collection<C,P>	getCollection(PipeLineSession session)
@NonNull SenderResult	sendMessage(@NonNull Message message, @NonNull PipeLineSession session)	Send a message to some destination (as configured in the Sender object).

Methods inherited from class AbstractSenderWithParameters

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

Methods inherited from class AbstractSender

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

Methods inherited from class 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 FrankElement

addConfigWarning

Methods inherited from interface HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface HasName

getName

Methods inherited from interface ISender

isSynchronous, sendMessageOrThrow, start, stop

Methods inherited from interface NameAware

setName

Constructor Details

AbstractCollectorSender

public AbstractCollectorSender()

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.

getCollection

protected @NonNull Collection<C,P> getCollection(PipeLineSession session)
                                          throws CollectionException

Throws:

CollectionException

sendMessage

public @NonNull 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