nl.nn.adapterframework.collection

Class CollectorSender<E extends ICollectingElement<C>,C extends ICollector<E>>

java.lang.Object

nl.nn.adapterframework.senders.SenderBase

nl.nn.adapterframework.senders.SenderWithParametersBase

nl.nn.adapterframework.stream.StreamingSenderBase

nl.nn.adapterframework.collection.CollectorSender<E,C>

All Implemented Interfaces:

ICollectingElement<C>, IConfigurable, IConfigurationAware, INamedObject, IScopeProvider, ISender, ISenderWithParameters, IWithParameters, IOutputStreamingSupport, IStreamingSender, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ZipWriterSender

public abstract class CollectorSender<E extends ICollectingElement<C>,C extends ICollector<E>>
extends StreamingSenderBase
implements ICollectingElement<C>

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

Author:

Gerrit van Brakel

Parameters

all parameters are handled by the collection.

Field Summary

Fields inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

parameterNamesMustBeUnique, paramList

Fields inherited from class nl.nn.adapterframework.senders.SenderBase

log

Constructor Summary

Constructors

Constructor and Description
CollectorSender()

Method Summary

Modifier and Type	Method and Description
protected boolean	canProvideOutputStream() returns true when there are no parameters that require the input value or context (or other side effects inhibiting providing an outputstream, to be determined by descendants)
void	configure() configure() is called once at startup of the framework in the configure method of the owner of this sender.
CollectionActor.Action	getAction()
String	getCollection()
MessageOutputStream	provideOutputStream(PipeLineSession session, IForwardTarget next) return a MessageOutputStream that can be used to write a message to, that then will be processed in a streaming way.
PipeRunResult	sendMessage(Message message, PipeLineSession session, IForwardTarget next)
void	setAction(CollectionActor.Action action)
void	setCollection(String collection)

Methods inherited from class nl.nn.adapterframework.stream.StreamingSenderBase

sendMessage, supportsOutputStreamPassThrough

Methods inherited from class nl.nn.adapterframework.senders.SenderWithParametersBase

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

Methods inherited from class nl.nn.adapterframework.senders.SenderBase

close, createBean, getLogPrefix, getName, isSynchronous, 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 nl.nn.adapterframework.collection.ICollectingElement

openCollection

Methods inherited from interface nl.nn.adapterframework.core.ISenderWithParameters

consumesSessionVariable

Methods inherited from interface nl.nn.adapterframework.core.ISender

close, isSynchronous, open, sendMessageOrThrow

Methods inherited from interface nl.nn.adapterframework.core.INamedObject

getName, setName

Methods inherited from interface nl.nn.adapterframework.core.IConfigurationAware

getApplicationContext, getName

Methods inherited from interface nl.nn.adapterframework.core.IScopeProvider

getConfigurationClassLoader

Methods inherited from interface org.springframework.context.ApplicationContextAware

setApplicationContext

Methods inherited from interface nl.nn.adapterframework.core.IWithParameters

addParameter, getParameterList

Constructor Detail

CollectorSender

public CollectorSender()

Method Detail

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 StreamingSenderBase

Throws:

ConfigurationException

sendMessage

public PipeRunResult sendMessage(Message message,
                                 PipeLineSession session,
                                 IForwardTarget next)
                          throws SenderException,
                                 TimeoutException

Specified by:

sendMessage in interface IStreamingSender

Throws:

SenderException

TimeoutException

canProvideOutputStream

protected boolean canProvideOutputStream()

Description copied from class: StreamingSenderBase

returns true when there are no parameters that require the input value or context (or other side effects inhibiting providing an outputstream, to be determined by descendants)

Overrides:

canProvideOutputStream in class StreamingSenderBase

provideOutputStream

public MessageOutputStream provideOutputStream(PipeLineSession session,
                                               IForwardTarget next)
                                        throws StreamingException

Description copied from interface: IOutputStreamingSupport

return a MessageOutputStream that can be used to write a message to, that then will be processed in a streaming way. If a target MessageOutputStream is required to stream output to, this can be obtained from next, if specified. If the implementor of this method is a pipe, and it is the last one in the chain of streaming pipes, it must provide the appropriate forward in the provide MessageOutputStream. If the class cannot provide an outputstream, it must return null. If the provider of an outputstream is a pipe itself, it must provide a proper pipeforward in the provided outputstream

Specified by:

provideOutputStream in interface IOutputStreamingSupport

Throws:

StreamingException

setAction

public void setAction(CollectionActor.Action action)

getAction

public CollectionActor.Action getAction()

setCollection

public void setCollection(String collection)

getCollection

public String getCollection()