nl.nn.adapterframework.filesystem

Class FileSystemPipe<F,FS extends IBasicFileSystem<F>>

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.filesystem.FileSystemPipe<F,FS>

All Implemented Interfaces:

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

Direct Known Subclasses:

LocalFileSystemPipe, Samba1Pipe, Samba2Pipe

@ElementType(value=ENDPOINT)
 @SupportsOutputStreaming
public abstract class FileSystemPipe<F,FS extends IBasicFileSystem<F>>
extends StreamingPipe
implements HasPhysicalDestination

Base class for Pipes that use a FileSystem.

Author:

Gerrit van Brakel

See Also:

FileSystemActor

Specific parameters

action overrides attribute action., filename overrides attribute filename. If not present, the input message is used., destination destination for action rename and move. Overrides attribute destination., contents contents for action write and append., inputFolder folder for actions list, mkdir and rmdir. This is a sub folder of baseFolder. Overrides attribute inputFolder. If not present, the input message is used.

Field Summary

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

Method Summary

Modifier and Type	Method and Description
protected void	addActions(List<FileSystemActor.FileSystemAction> specificActions)
void	configure() checks for correct configuration of forward
PipeRunResult	doPipe(Message message, PipeLineSession session) This is where the action takes place.
FileSystemActor.FileSystemAction	getAction()
String	getDomain()
FS	getFileSystem()
String	getPhysicalDestinationName()
protected MessageOutputStream	provideOutputStream(PipeLineSession session) provide the outputstream, or null if a stream cannot be provided.
void	setAction(FileSystemActor.FileSystemAction action)
void	setBase64(Base64Pipe.Direction base64) Deprecated.
void	setCharset(String charset)
void	setCreateFolder(boolean createFolder)
void	setDeleteEmptyFolder(boolean deleteEmptyFolder)
void	setDestination(String destination)
void	setExcludeWildcard(String excludeWildcard)
void	setExcludeWildCard(String excludeWildcard) Deprecated.
void	setFilename(String filename)
protected void	setFileSystem(FS fileSystem)
void	setInputFolder(String inputFolder)
void	setNumberOfBackups(int numberOfBackups)
void	setOutputFormat(DocumentFormat outputFormat)
void	setOverwrite(boolean overwrite)
void	setRemoveNonEmptyFolder(boolean removeNonEmptyFolder)
void	setRotateDays(int rotateDays)
void	setRotateSize(int rotateSize)
void	setWildcard(String wildcard)
void	setWildCard(String wildcard) Deprecated.
void	setWriteLineSeparator(boolean writeLineSeparator)
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.
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.stream.StreamingPipe

canProvideOutputStream, canStreamToNextPipe, 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, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getInSizeStatDummyObject, getOutSizeStatDummyObject, getParameterList, hasSizeStatistics, registerEvent, registerForward, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, 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.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.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

Constructor Detail

FileSystemPipe

public FileSystemPipe()

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 StreamingPipe

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 AbstractPipe

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 AbstractPipe

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

Overrides:

supportsOutputStreamPassThrough in class StreamingPipe

provideOutputStream

protected MessageOutputStream provideOutputStream(PipeLineSession session)
                                           throws StreamingException

Description copied from class: StreamingPipe

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

Overrides:

provideOutputStream in class StreamingPipe

Throws:

StreamingException

doPipe

@Nullable
public PipeRunResult doPipe(@Nonnull
                                      Message message,
                                      @Nonnull
                                      PipeLineSession session)
                               throws PipeRunException

Description copied from interface: IPipe

This is where the action takes place. Pipes may only throw a PipeRunException, to be handled by the caller of this object. Implementations must either consume the message, or pass it on to the next Pipe in the PipeRunResult. If the result of the Pipe does not depend on the input, like for the FixedResultPipe, the Pipe can schedule the input to be closed at session exit, by calling Message.closeOnCloseOf(PipeLineSession, String) This allows the previous Pipe to release any resources (e.g. connections) that it might have kept open until the message was consumed. Doing so avoids connections leaking from pools, while it enables efficient streaming processing of data while it is being read from a stream.

Specified by:

doPipe in interface IPipe

Throws:

PipeRunException

getPhysicalDestinationName

public String getPhysicalDestinationName()

Specified by:

getPhysicalDestinationName in interface HasPhysicalDestination

getDomain

public String getDomain()

Specified by:

getDomain in interface HasPhysicalDestination

getFileSystem

public FS getFileSystem()

setFileSystem

protected void setFileSystem(FS fileSystem)

addActions

protected void addActions(List<FileSystemActor.FileSystemAction> specificActions)

setAction

@ReferTo(value=FileSystemActor.class)
public void setAction(FileSystemActor.FileSystemAction action)

getAction

public FileSystemActor.FileSystemAction getAction()

setFilename

@ReferTo(value=FileSystemActor.class)
public void setFilename(String filename)

setDestination

@ReferTo(value=FileSystemActor.class)
public void setDestination(String destination)

setInputFolder

@ReferTo(value=FileSystemActor.class)
public void setInputFolder(String inputFolder)

setCreateFolder

@ReferTo(value=FileSystemActor.class)
public void setCreateFolder(boolean createFolder)

setOverwrite

@ReferTo(value=FileSystemActor.class)
public void setOverwrite(boolean overwrite)

setRotateDays

@ReferTo(value=FileSystemActor.class)
public void setRotateDays(int rotateDays)

setRotateSize

@ReferTo(value=FileSystemActor.class)
public void setRotateSize(int rotateSize)

setNumberOfBackups

@ReferTo(value=FileSystemActor.class)
public void setNumberOfBackups(int numberOfBackups)

setBase64

@ReferTo(value=FileSystemActor.class)
 @Deprecated
public void setBase64(Base64Pipe.Direction base64)

Deprecated.

setWildCard

@Deprecated
 @ConfigurationWarning(value="attribute \'wildCard\' has been renamed to \'wildcard\'")
public void setWildCard(String wildcard)

Deprecated.

setWildcard

@ReferTo(value=FileSystemActor.class)
public void setWildcard(String wildcard)

setExcludeWildCard

@Deprecated
 @ConfigurationWarning(value="attribute \'excludeWildCard\' has been renamed to \'excludeWildcard\'")
public void setExcludeWildCard(String excludeWildcard)

Deprecated.

setExcludeWildcard

@ReferTo(value=FileSystemActor.class)
public void setExcludeWildcard(String excludeWildcard)

setRemoveNonEmptyFolder

@ReferTo(value=FileSystemActor.class)
public void setRemoveNonEmptyFolder(boolean removeNonEmptyFolder)

setWriteLineSeparator

@ReferTo(value=FileSystemActor.class)
public void setWriteLineSeparator(boolean writeLineSeparator)

setCharset

@ReferTo(value=FileSystemActor.class)
public void setCharset(String charset)

setDeleteEmptyFolder

@ReferTo(value=FileSystemActor.class)
public void setDeleteEmptyFolder(boolean deleteEmptyFolder)

setOutputFormat

@ReferTo(value=FileSystemActor.class)
public void setOutputFormat(DocumentFormat outputFormat)