nl.nn.adapterframework.filesystem

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

java.lang.Object

nl.nn.adapterframework.filesystem.FileSystemActor<F,FS>

All Implemented Interfaces:

IOutputStreamingSupport

public class FileSystemActor<F,FS extends IBasicFileSystem<F>>
extends Object
implements IOutputStreamingSupport

Worker class for FileSystemPipe and FileSystemSender.

Author:

Gerrit van Brakel

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.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FileSystemActor.FileSystemAction

Field Summary

Fields

Modifier and Type	Field and Description
static String	ACTION_APPEND
static String	ACTION_COPY
static String	ACTION_CREATE
static String	ACTION_DELETE
static String	ACTION_FORWARD
static String	ACTION_INFO
static String	ACTION_LIST
static String	ACTION_LIST_ATTACHMENTS
static String	ACTION_MKDIR
static String	ACTION_MOVE
static String	ACTION_READ_DELETE
static String	ACTION_READ1
static String	ACTION_READ2
static String	ACTION_RENAME
static String	ACTION_RMDIR
static String	ACTION_WRITE1
static String	ACTION_WRITE2
static FileSystemActor.FileSystemAction[]	ACTIONS_BASIC
static FileSystemActor.FileSystemAction[]	ACTIONS_MAIL_FS
static FileSystemActor.FileSystemAction[]	ACTIONS_WRITABLE_FS
protected org.apache.logging.log4j.Logger	log
static String	PARAMETER_ACTION
static String	PARAMETER_CONTENTS1
static String	PARAMETER_CONTENTS2
static String	PARAMETER_DESTINATION
static String	PARAMETER_FILENAME
static String	PARAMETER_INPUTFOLDER

Constructor Summary

Constructors

Constructor and Description
FileSystemActor()

Method Summary

Modifier and Type	Method and Description
protected void	actionRequiresAtLeastOneOfTwoParametersOrAttribute(INamedObject owner, ParameterList parameterList, FileSystemActor.FileSystemAction configuredAction, FileSystemActor.FileSystemAction action, String parameter1, String parameter2, String attributeName, String attributeValue)
protected void	addActions(List<FileSystemActor.FileSystemAction> specificActions)
protected OutputStream	augmentOutputStream(OutputStream out)
protected boolean	canProvideOutputStream()
void	configure(FS fileSystem, ParameterList parameterList, IConfigurable owner)
Message	doAction(Message input, ParameterValueList pvl, PipeLineSession session)
void	open()
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.
void	setAction(FileSystemActor.FileSystemAction action) If parameter ["action"] is set, then the attribute action value will be overridden with the value of the parameter.
void	setBase64(Base64Pipe.Direction base64) Deprecated.
void	setCharset(String charset) Charset to be used for "read" and "write" action
void	setCreateFolder(boolean createFolder) If set true, the folder to create, write, move or copy the file to is created if it does not exist
void	setDeleteEmptyFolder(boolean deleteEmptyFolder) If set to true then the folder will be deleted if it is empty after processing the action.
void	setDestination(String destination) Destination for "move", "copy" or "rename".
void	setExcludeWildcard(String excludeWildcard) Filter of files to be excluded when looking in inputFolder.
void	setExcludeWildCard(String excludeWildcard) Deprecated.
void	setFilename(String filename) Filename to operate on.
void	setInputFolder(String inputFolder) Folder that is scanned for files when action="list".
void	setNumberOfBackups(int numberOfBackups) For the actions "write" and "append", with rotateSize>0: the number of backup files that is kept.
void	setOutputFormat(DocumentFormat outputFormat) OutputFormat
void	setOverwrite(boolean overwrite) If set true, for actions "create", "move", "copy" or "rename", the destination file is overwritten if it already exists
void	setRemoveNonEmptyFolder(boolean removeNonEmptyFolder) If set to true then the folder and the content of the non empty folder will be deleted.
void	setRotateDays(int rotateDays) For action="append": If set to a positive number, the file is rotated each day, and this number of files is kept.
void	setRotateSize(int rotateSize) For action="append": If set to a positive number, the file is rotated when it has reached the specified size, and the number of files specified in numberOfBackups is kept.
void	setWildcard(String wildcard) Filter of files to look for in inputFolder e.g.
void	setWildCard(String wildcard) Deprecated.
void	setWriteLineSeparator(boolean writeLineSeparator) If set to true then the system specific line separator will be appended to the file after executing the action.
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 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected org.apache.logging.log4j.Logger log

ACTION_CREATE

public static final String ACTION_CREATE

See Also:

Constant Field Values

ACTION_LIST

public static final String ACTION_LIST

See Also:

Constant Field Values

ACTION_INFO

public static final String ACTION_INFO

See Also:

Constant Field Values

ACTION_READ1

public static final String ACTION_READ1

See Also:

Constant Field Values

ACTION_READ2

public static final String ACTION_READ2

See Also:

Constant Field Values

ACTION_READ_DELETE

public static final String ACTION_READ_DELETE

See Also:

Constant Field Values

ACTION_MOVE

public static final String ACTION_MOVE

See Also:

Constant Field Values

ACTION_COPY

public static final String ACTION_COPY

See Also:

Constant Field Values

ACTION_DELETE

public static final String ACTION_DELETE

See Also:

Constant Field Values

ACTION_MKDIR

public static final String ACTION_MKDIR

See Also:

Constant Field Values

ACTION_RMDIR

public static final String ACTION_RMDIR

See Also:

Constant Field Values

ACTION_WRITE1

public static final String ACTION_WRITE1

See Also:

Constant Field Values

ACTION_WRITE2

public static final String ACTION_WRITE2

See Also:

Constant Field Values

ACTION_APPEND

public static final String ACTION_APPEND

See Also:

Constant Field Values

ACTION_RENAME

public static final String ACTION_RENAME

See Also:

Constant Field Values

ACTION_FORWARD

public static final String ACTION_FORWARD

See Also:

Constant Field Values

ACTION_LIST_ATTACHMENTS

public static final String ACTION_LIST_ATTACHMENTS

See Also:

Constant Field Values

PARAMETER_ACTION

public static final String PARAMETER_ACTION

See Also:

Constant Field Values

PARAMETER_CONTENTS1

public static final String PARAMETER_CONTENTS1

See Also:

Constant Field Values

PARAMETER_CONTENTS2

public static final String PARAMETER_CONTENTS2

See Also:

Constant Field Values

PARAMETER_FILENAME

public static final String PARAMETER_FILENAME

See Also:

Constant Field Values

PARAMETER_INPUTFOLDER

public static final String PARAMETER_INPUTFOLDER

See Also:

Constant Field Values

PARAMETER_DESTINATION

public static final String PARAMETER_DESTINATION

See Also:

Constant Field Values

ACTIONS_BASIC

public static final FileSystemActor.FileSystemAction[] ACTIONS_BASIC

ACTIONS_WRITABLE_FS

public static final FileSystemActor.FileSystemAction[] ACTIONS_WRITABLE_FS

ACTIONS_MAIL_FS

public static final FileSystemActor.FileSystemAction[] ACTIONS_MAIL_FS

Constructor Detail

FileSystemActor

public FileSystemActor()

Method Detail

configure

public void configure(FS fileSystem,
                      ParameterList parameterList,
                      IConfigurable owner)
               throws ConfigurationException

Throws:

ConfigurationException

actionRequiresAtLeastOneOfTwoParametersOrAttribute

protected void actionRequiresAtLeastOneOfTwoParametersOrAttribute(INamedObject owner,
                                                                  ParameterList parameterList,
                                                                  FileSystemActor.FileSystemAction configuredAction,
                                                                  FileSystemActor.FileSystemAction action,
                                                                  String parameter1,
                                                                  String parameter2,
                                                                  String attributeName,
                                                                  String attributeValue)
                                                           throws ConfigurationException

Throws:

ConfigurationException

open

public void open()
          throws FileSystemException

Throws:

FileSystemException

doAction

public Message doAction(@Nonnull
                        Message input,
                        ParameterValueList pvl,
                        @Nonnull
                        PipeLineSession session)
                 throws FileSystemException,
                        TimeoutException

Throws:

FileSystemException

TimeoutException

canProvideOutputStream

protected boolean canProvideOutputStream()

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

augmentOutputStream

protected OutputStream augmentOutputStream(OutputStream out)

provideOutputStream

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

Description copied from interface: IOutputStreamingSupport

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

Specified by:

provideOutputStream in interface IOutputStreamingSupport

Throws:

StreamingException

addActions

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

setAction

public void setAction(FileSystemActor.FileSystemAction action)

If parameter ["action"] is set, then the attribute action value will be overridden with the value of the parameter.

setInputFolder

public void setInputFolder(String inputFolder)

Folder that is scanned for files when action="list". When not set, the root is scanned

setCreateFolder

public void setCreateFolder(boolean createFolder)

If set true, the folder to create, write, move or copy the file to is created if it does not exist

Default value

false

setOverwrite

public void setOverwrite(boolean overwrite)

If set true, for actions "create", "move", "copy" or "rename", the destination file is overwritten if it already exists

Default value

false

setFilename

public void setFilename(String filename)

Filename to operate on. If not set, the parameter "filename" is used. If that is not set either, the input is used

setDestination

public void setDestination(String destination)

Destination for "move", "copy" or "rename". If not set, the parameter "destination" is used. If that is not set either, the input is used

setRotateDays

public void setRotateDays(int rotateDays)

For action="append": If set to a positive number, the file is rotated each day, and this number of files is kept. The inputFolder must point to the directory where the file resides

Default value

0

setRotateSize

public void setRotateSize(int rotateSize)

For action="append": If set to a positive number, the file is rotated when it has reached the specified size, and the number of files specified in numberOfBackups is kept. Size is specified in plain bytes, suffixes like 'K', 'M' or 'G' are not recognized. The inputFolder must point to the directory where the file resides

Default value

0

setNumberOfBackups

public void setNumberOfBackups(int numberOfBackups)

For the actions "write" and "append", with rotateSize>0: the number of backup files that is kept. The inputFolder must point to the directory where the file resides

Default value

0

setBase64

@Deprecated
public void setBase64(Base64Pipe.Direction base64)

Deprecated.

For actions "read", "write" and "append". When set the stream is base64 encoded or decoded

setWildCard

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

Deprecated.

setWildcard

public void setWildcard(String wildcard)

Filter of files to look for in inputFolder e.g. '*.inp'. Works with actions "move", "copy", "delete" and "list"

setExcludeWildCard

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

Deprecated.

setExcludeWildcard

public void setExcludeWildcard(String excludeWildcard)

Filter of files to be excluded when looking in inputFolder. Works with actions "move", "copy", "delete" and "list"

setRemoveNonEmptyFolder

public void setRemoveNonEmptyFolder(boolean removeNonEmptyFolder)

If set to true then the folder and the content of the non empty folder will be deleted.

setWriteLineSeparator

public void setWriteLineSeparator(boolean writeLineSeparator)

If set to true then the system specific line separator will be appended to the file after executing the action. Works with actions "write" and "append"

Default value

false

setCharset

public void setCharset(String charset)

Charset to be used for "read" and "write" action

setDeleteEmptyFolder

public void setDeleteEmptyFolder(boolean deleteEmptyFolder)

If set to true then the folder will be deleted if it is empty after processing the action. Works with actions "delete", "readDelete" and "move"

setOutputFormat

public void setOutputFormat(DocumentFormat outputFormat)

OutputFormat

Default value

XML