nl.nn.adapterframework.stream

Interface IOutputStreamingSupport

All Known Subinterfaces:

IStreamingSender

All Known Implementing Classes:

AmazonS3Sender, Base64Pipe, BlobLineIteratingPipe, ChecksumPipe, ClobLineIteratingPipe, CollectorPipe, CollectorSender, CompressPipe, CreateRestViewPipe, CsvParserPipe, DirectQuerySender, EchoPipe, ExchangeFolderSender, FileLineIteratorPipe, FileSystemActor, FileSystemPipe, FileSystemSender, FileSystemSenderWithAttachments, FixedQuerySender, ForEachAttachmentPipe, ForEachChildElementPipe, FtpFileSystemSender, GenericMessageSendingPipe, ImapSender, IteratingPipe, JdbcIteratingPipeBase, JdbcIteratingPipeBase.MixedQuerySender, JdbcQuerySenderBase, JdbcSenderBase, JsonXsltPipe, JsonXsltSender, LobLineIteratingPipeBase, LocalFileSystemPipe, LocalFileSystemSender, MailSenderPipe, MessageSendingPipe, MongoDbSender, PGPPipe, ResultSet2FileSender, ResultSetIteratingPipe, Samba1Pipe, Samba1Sender, Samba2Pipe, Samba2Sender, SambaPipe, SambaSender, SenderPipe, StreamingPipe, StreamingSenderBase, StreamLineIteratorPipe, StringIteratorPipe, Text2XmlPipe, TextSplitterPipe, XmlFileElementIteratorPipe, XmlQuerySender, XsltPipe, XsltSender, ZipIteratorPipe, ZipWriterPipe, ZipWriterSender

public interface IOutputStreamingSupport

Method Summary

Modifier and Type	Method and Description
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.
boolean	supportsOutputStreamPassThrough() Implementations should return true when they do not require an OutputStream, but can provide one to the preceding pipe if they are themselves provided with one from the next pipe.

Method Detail

supportsOutputStreamPassThrough

boolean supportsOutputStreamPassThrough()

Implementations should return true when they do not require an OutputStream, but can provide one to the preceding pipe if they are themselves provided with one from the next pipe.

provideOutputStream

MessageOutputStream provideOutputStream(PipeLineSession session,
                                        IForwardTarget next)
                                 throws StreamingException

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

Throws:

StreamingException