nl.nn.adapterframework.filesystem

Class ForEachAttachmentPipe<F,A,FS extends IWithAttachments<F,A>>

java.lang.Object

nl.nn.adapterframework.core.TransactionAttributes

nl.nn.adapterframework.pipes.AbstractPipe

nl.nn.adapterframework.pipes.FixedForwardPipe

nl.nn.adapterframework.stream.StreamingPipe

nl.nn.adapterframework.pipes.MessageSendingPipe

nl.nn.adapterframework.pipes.IteratingPipe<A>

nl.nn.adapterframework.filesystem.ForEachAttachmentPipe<F,A,FS>

All Implemented Interfaces:

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

public class ForEachAttachmentPipe<F,A,FS extends IWithAttachments<F,A>>
extends IteratingPipe<A>

Nested Class Summary

Nested classes/interfaces inherited from class nl.nn.adapterframework.pipes.IteratingPipe

IteratingPipe.ItemCallback, IteratingPipe.StopReason

Nested classes/interfaces inherited from class nl.nn.adapterframework.pipes.MessageSendingPipe

MessageSendingPipe.LinkMethod

Nested classes/interfaces inherited from interface nl.nn.adapterframework.statistics.HasStatistics

HasStatistics.Action

Field Summary

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

MAX_ITEMS_REACHED_FORWARD, msgTransformerPool, STOP_CONDITION_MET_FORWARD

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

INPUT_VALIDATOR_NAME_PREFIX, INPUT_VALIDATOR_NAME_SUFFIX, INPUT_WRAPPER_NAME_PREFIX, INPUT_WRAPPER_NAME_SUFFIX, MAX_RETRY_INTERVAL, MESSAGE_LOG_NAME_PREFIX, MESSAGE_LOG_NAME_SUFFIX, MIN_RETRY_INTERVAL, msgLog, OUTPUT_VALIDATOR_NAME_PREFIX, OUTPUT_VALIDATOR_NAME_SUFFIX, OUTPUT_WRAPPER_NAME_PREFIX, OUTPUT_WRAPPER_NAME_SUFFIX, PIPE_CLEAR_TIMEOUT_MONITOR_EVENT, PIPE_EXCEPTION_MONITOR_EVENT, PIPE_TIMEOUT_MONITOR_EVENT

Fields inherited from class nl.nn.adapterframework.stream.StreamingPipe

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
ForEachAttachmentPipe()

Method Summary

Modifier and Type	Method and Description
void	configure() checks for correct configuration of forward
Set<String>	getExcludePropertiesSet()
FS	getFileSystem()
protected IDataIterator<A>	getIterator(Message message, PipeLineSession session, Map<String,Object> threadContext)
Set<String>	getOnlyPropertiesSet()
String	getPhysicalDestinationName()
protected Message	itemToMessage(A item)
void	setExcludeProperties(String excludePropertiesList) comma separated list of attachment properties not to list.
void	setFileSystem(FS fileSystem)
void	setOnlyProperties(String onlyPropertiesList) comma separated list of attachment properties to list
void	start() Perform necessary action to start the pipe.
void	stop() Perform necessary actions to stop the Pipe. For instance, closing JMS connections, DBMS connections etc.

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

canStreamToNextPipe, createItemCallBack, getItem, getStopConditionTp, iterateOverInput, iterateOverStatistics, provideOutputStream, sendMessage, setAddInputToResult, setBlockSize, setCloseIteratorOnExit, setCollectResults, setIgnoreExceptions, setItemNoSessionKey, setMaxChildThreads, setMaxItems, setNamespaceDefs, setOmitXmlDeclaration, setOutputType, setParallel, setRemoveDuplicates, setRemoveXmlDeclarationInResults, setSender, setStopConditionXPathExpression, setStyleSheetName, setXpathExpression

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

canProvideOutputStream, consumesSessionVariable, doPipe, hasSizeStatistics, increaseRetryIntervalAndWait, preserve, propagateName, setAuditTrailNamespaceDefs, setAuditTrailSessionKey, setAuditTrailXPath, setCheckRootTag, setCheckXmlWellFormed, setCorrelationIDNamespaceDefs, setCorrelationIDSessionKey, setCorrelationIDStyleSheet, setCorrelationIDXPath, setExceptionOnResult, setHideMethod, setHideRegex, setInputValidator, setInputWrapper, setLabelNamespaceDefs, setLabelStyleSheet, setLabelXPath, setLinkMethod, setListener, setMaxRetries, setMessageLog, setName, setOutputValidator, setOutputWrapper, setPresumedTimeOutInterval, setResultOnTimeOut, setRetryMaxInterval, setRetryMinInterval, setRetryNamespaceDefs, setRetryXPath, setStreamResultToServlet, setStubFilename, setStubFileName, setTimeOutOnResult, setUseInputForExtract, supportsOutputStreamPassThrough

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

getNextPipe, getTargetStream, isStreamingActive, provideOutputStream, setStreamingActive

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, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setLocker, setLogIntermediaryResults, setMaxThreads, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, 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.HasSender

getSender

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

getName

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, throwEvent

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

getMaxThreads

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

Constructor Detail

ForEachAttachmentPipe

public ForEachAttachmentPipe()

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 IteratingPipe<A>

Throws:

ConfigurationException

start

public void start()
           throws PipeStartException

Description copied from interface: IPipe

Perform necessary action to start the pipe. This method is executed after the IPipe.configure() method, for each start and stop command of the adapter.

Specified by:

start in interface IPipe

Overrides:

start in class MessageSendingPipe

Throws:

PipeStartException

stop

public void stop()

Description copied from interface: IPipe

Perform necessary actions to stop the Pipe.
For instance, closing JMS connections, DBMS connections etc.

Specified by:

stop in interface IPipe

Overrides:

stop in class MessageSendingPipe

getIterator

protected IDataIterator<A> getIterator(Message message,
                                       PipeLineSession session,
                                       Map<String,Object> threadContext)
                                throws SenderException

Overrides:

getIterator in class IteratingPipe<A>

Throws:

SenderException

itemToMessage

protected Message itemToMessage(A item)
                         throws SenderException

Overrides:

itemToMessage in class IteratingPipe<A>

Throws:

SenderException

getPhysicalDestinationName

public String getPhysicalDestinationName()

getFileSystem

public FS getFileSystem()

setFileSystem

public void setFileSystem(FS fileSystem)

setOnlyProperties

public void setOnlyProperties(String onlyPropertiesList)

comma separated list of attachment properties to list

getOnlyPropertiesSet

public Set<String> getOnlyPropertiesSet()

setExcludeProperties

public void setExcludeProperties(String excludePropertiesList)

comma separated list of attachment properties not to list. When specified, 'onlyProperties' is ignored

getExcludePropertiesSet

public Set<String> getExcludePropertiesSet()