Package org.frankframework.pipes

Class LocalFileSystemPipe

java.lang.Object

org.frankframework.core.TransactionAttributes

org.frankframework.pipes.AbstractPipe

org.frankframework.pipes.FixedForwardPipe

org.frankframework.filesystem.AbstractFileSystemPipe<Path,LocalFileSystem>

org.frankframework.pipes.LocalFileSystemPipe

All Implemented Interfaces:

FrankElement, HasApplicationContext, HasName, HasPhysicalDestination, HasTransactionAttribute, IConfigurable, IForwardTarget, IPipe, IScopeProvider, IWithParameters, NameAware, EventThrowing, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware, org.springframework.context.Lifecycle

public class LocalFileSystemPipe
extends AbstractFileSystemPipe<Path,LocalFileSystem>

Pipe to work with the server local filesystem.

In addition to regular parameters for filesystem senders, it is possible to set custom extended attributes on files by prefixing parameter names with "FileAttribute."<F>. This prefix will be not be part of the actual metadata property name.

The string value of these parameters will be used as value of the custom metadata attribute.

If extended attributes actually can be written depends on the underlying OS / filesystem.

Field Summary

Fields inherited from class org.frankframework.pipes.AbstractPipe

parameterNamesMustBeUnique

Fields inherited from class org.frankframework.core.TransactionAttributes

log

Fields inherited from interface org.frankframework.core.IPipe

LONG_DURATION_MONITORING_EVENT, MESSAGE_SIZE_MONITORING_EVENT, PIPE_EXCEPTION_MONITORING_EVENT

Constructor Summary

Constructors

Constructor	Description
LocalFileSystemPipe()

Method Summary

Modifier and Type	Method	Description
void	setCreateRootFolder(boolean createRootFolder)
void	setRoot(String root)

Methods inherited from class org.frankframework.filesystem.AbstractFileSystemPipe

addActions, configure, doPipe, getAction, getPhysicalDestinationName, setAction, setCharset, setCreateFolder, setDeleteEmptyFolder, setDestination, setExcludeWildcard, setFilename, setFileSystem, setInputFolder, setNumberOfBackups, setOutputFormat, setOverwrite, setRemoveNonEmptyFolder, setRotateDays, setRotateSize, setTypeFilter, setWildcard, setWriteLineSeparator, start, stop

Methods inherited from class org.frankframework.pipes.FixedForwardPipe

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

Methods inherited from class org.frankframework.pipes.AbstractPipe

addForward, addParameter, consumesSessionVariable, createBean, findForward, getAdapter, getEventSourceName, getForwards, getParameterList, hasRegisteredForward, isRunning, registerEvent, setApplicationContext, setChompCharSize, setDurationThreshold, setElementToMove, setElementToMoveChain, setElementToMoveSessionKey, setEmptyInputReplacement, setGetInputFromFixedValue, setGetInputFromSessionKey, setHideRegex, setLocker, setLogIntermediaryResults, setMaxThreads, setName, setPreserveInput, setRemoveCompactMsgNamespaces, setRestoreMovedElements, setSecLogSessionKeys, setSizeStatistics, setStoreResultInSessionKey, setWriteToSecLog, sizeStatisticsEnabled, throwEvent

Methods inherited from class org.frankframework.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 org.frankframework.core.FrankElement

addConfigWarning

Methods inherited from interface org.frankframework.core.HasApplicationContext

getApplicationContext, getConfigurationClassLoader

Methods inherited from interface org.frankframework.core.HasName

getName

Methods inherited from interface org.frankframework.core.HasTransactionAttribute

getTransactionAttribute, getTransactionTimeout, getTxDef, setTransactionAttribute

Methods inherited from interface org.frankframework.core.IForwardTarget

getName

Methods inherited from interface org.frankframework.core.IPipe

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

Constructor Details

LocalFileSystemPipe

public LocalFileSystemPipe()

Method Details

setRoot

@ReferTo(LocalFileSystem.class)
public void setRoot(String root)

setCreateRootFolder

@ReferTo(LocalFileSystem.class)
public void setCreateRootFolder(boolean createRootFolder)