Package org.frankframework.collection

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

java.lang.Object

org.frankframework.senders.SenderBase

org.frankframework.senders.SenderWithParametersBase

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

All Implemented Interfaces:

IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ZipWriterSender

public abstract class CollectorSenderBase<C extends ICollector<P>,P>
extends SenderWithParametersBase

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

Author:

Niels Meijer

Parameters

all parameters are handled by the collection.

Field Summary

Fields inherited from class org.frankframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class org.frankframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor	Description
CollectorSenderBase()

Method Summary

Modifier and Type	Method	Description
void	configure()	configure() is called once at startup of the framework in the configure method of the owner of this sender.
protected Collection<C,P>	getCollection(PipeLineSession session)
String	getCollectionName()	Session key used to refer to collection.
SenderResult	sendMessage(Message message, PipeLineSession session)	Send a message to some destination (as configured in the Sender object).
void	setCollectionName(String collectionName)	Session key used to refer to collection.

Methods inherited from class org.frankframework.senders.SenderWithParametersBase

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

Methods inherited from class org.frankframework.senders.SenderBase

close, createBean, getApplicationContext, getConfigurationClassLoader, getLogPrefix, getName, open, setApplicationContext, setName

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

getApplicationContext, getName

Methods inherited from interface org.frankframework.core.INamedObject

getName, setName

Methods inherited from interface org.frankframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.ISender

close, isSynchronous, open, sendMessageOrThrow

Constructor Details

CollectorSenderBase

public CollectorSenderBase()

Method Details

configure

public void configure()
               throws ConfigurationException

Description copied from interface: 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.

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface ISender

Overrides:

configure in class SenderWithParametersBase

Throws:

ConfigurationException

getCollection

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

Throws:

CollectionException

sendMessage

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

getCollectionName

public String getCollectionName()

Session key used to refer to collection. Must be specified with another value if multiple CollectorPipes are active at the same time in the same session

Default value

collection

setCollectionName

public void setCollectionName(String collectionName)

Session key used to refer to collection. Must be specified with another value if multiple CollectorPipes are active at the same time in the same session

Default value

collection