nl.nn.adapterframework.stream

Class StreamingPipe

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.stream.StreamingPipe

All Implemented Interfaces:

HasTransactionAttribute, IConfigurable, IConfigurationAware, IExtendedPipe, IForwardTarget, INamedObject, IPipe, IScopeProvider, EventThrowing, IOutputStreamingSupport, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

Base64Pipe, ChecksumPipe, CollectorPipe, CompressPipe, CsvParserPipe, EchoPipe, FileSystemPipe, MessageSendingPipe, PGPPipe, Text2XmlPipe, TextSplitterPipe, XsltPipe

public abstract class StreamingPipe
extends FixedForwardPipe
implements IOutputStreamingSupport

Field Summary

Fields

Modifier and Type	Field and Description
static String	AUTOMATIC_STREAMING

Fields inherited from class nl.nn.adapterframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class nl.nn.adapterframework.core.TransactionAttributes

log

Fields inherited from interface nl.nn.adapterframework.core.IExtendedPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor and Description
StreamingPipe()

Method Summary

Modifier and Type	Method and Description
protected boolean	canProvideOutputStream() returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g.
protected boolean	canStreamToNextPipe() called if the pipe implementation requests an OutputStream, to determine if there are side effects configured that require the output of this pipe to be available at the return of the doPipe() method.
void	configure() checks for correct configuration of forward
protected IForwardTarget	getNextPipe() Find the target to receive this pipes output, i.e that could provide an output stream
protected MessageOutputStream	getTargetStream(PipeLineSession session) Provides a non-null MessageOutputStream, that the caller can use to obtain a Writer, OutputStream or ContentHandler.
boolean	isStreamingActive()
protected MessageOutputStream	provideOutputStream(PipeLineSession session) provide the outputstream, or null if a stream cannot be provided.
MessageOutputStream	provideOutputStream(PipeLineSession session, IForwardTarget next) Don't override unless you're absolutely sure what you're doing!
void	setStreamingActive(boolean streamingActive) If true, then this pipe can provide an OutputStream to the previous pipe, to write its output to.
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.

Methods inherited from class nl.nn.adapterframework.pipes.FixedForwardPipe

getParameterValue, setIfParam, setIfValue, setOnlyIfSessionKey, setOnlyIfValue, setSkipOnEmptyInput, setUnlessSessionKey, setUnlessValue, skipPipe

Methods inherited from class nl.nn.adapterframework.pipes.AbstractPipe

addParameter, consumesSessionVariable, createBean, doPipe, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, getParameterOverriddenAttributeValue, getParameterValueList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, start, stop, throwEvent

Methods inherited from class nl.nn.adapterframework.core.TransactionAttributes

configureTransactionAttributes, isTransacted, isTransacted, setTransacted, setTransactionTimeout

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.core.IExtendedPipe

getChompCharSize, getDurationThreshold, getElementToMove, getElementToMoveChain, getElementToMoveSessionKey, getEmptyInputReplacement, getGetInputFromFixedValue, getGetInputFromSessionKey, getLocker, getSecLogSessionKeys, getStoreResultInSessionKey, isPreserveInput, isRemoveCompactMsgNamespaces, isRestoreMovedElements, isWriteToSecLog, setPipeLine

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

getMaxThreads

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

getName

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 nl.nn.adapterframework.core.IForwardTarget

getName

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

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Field Detail

AUTOMATIC_STREAMING

public static final String AUTOMATIC_STREAMING

See Also:

Constant Field Values

Constructor Detail

StreamingPipe

public StreamingPipe()

Method Detail

configure

public void configure()
               throws ConfigurationException

Description copied from class: FixedForwardPipe

checks for correct configuration of forward

Specified by:

configure in interface IConfigurable

Specified by:

configure in interface IPipe

Overrides:

configure in class FixedForwardPipe

Throws:

ConfigurationException

getNextPipe

protected IForwardTarget getNextPipe()

Find the target to receive this pipes output, i.e that could provide an output stream

canProvideOutputStream

protected boolean canProvideOutputStream()

returns true when: a) the pipe might be able to accept an input by providing an OutputStream, and b) there are no side effects configured that prevent handing over its PipeRunResult to the calling pipe (e.g. storeResultInSessionKey) c) there are no side effects that require the input to be available at the end of the pipe (e.g. preserveInput=true) d) there are no parameters that require the input value or context (b and c are implemented by PipeProcessors, that do not support outputStreaming)

canStreamToNextPipe

protected boolean canStreamToNextPipe()

called if the pipe implementation requests an OutputStream, to determine if there are side effects configured that require the output of this pipe to be available at the return of the doPipe() method. All side effects that are handled by PipeProcessors (storeResultInSessionKey, preserveInput) and move and chop actions (restoreMovedElements, elementToMove, chompCharSize, ElementToMoveChain) inhibit streaming to the next pipe.

provideOutputStream

protected MessageOutputStream provideOutputStream(PipeLineSession session)
                                           throws StreamingException

provide the outputstream, or null if a stream cannot be provided. Implementations should provide a forward target by calling getNextPipe().

Throws:

StreamingException

provideOutputStream

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

Don't override unless you're absolutely sure what you're doing!

Specified by:

provideOutputStream in interface IOutputStreamingSupport

Throws:

StreamingException

getTargetStream

protected MessageOutputStream getTargetStream(PipeLineSession session)
                                       throws StreamingException

Provides a non-null MessageOutputStream, that the caller can use to obtain a Writer, OutputStream or ContentHandler.

Throws:

StreamingException

setStreamingActive

public void setStreamingActive(boolean streamingActive)

If true, then this pipe can provide an OutputStream to the previous pipe, to write its output to. Can be used to switch this streaming off for debugging purposes

Default value

set by appconstant streaming.auto

isStreamingActive

public boolean isStreamingActive()

supportsOutputStreamPassThrough

public boolean supportsOutputStreamPassThrough()

Description copied from interface: IOutputStreamingSupport

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.

Specified by:

supportsOutputStreamPassThrough in interface IOutputStreamingSupport