Package org.frankframework.filesystem

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

java.lang.Object

org.frankframework.filesystem.FileSystemActor<F,S>

public class FileSystemActor<F,S extends IBasicFileSystem<F>>
extends Object

Worker class for AbstractFileSystemPipe and AbstractFileSystemSender.

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 Content 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., typeFilter Filter for action list. Specify FILES_ONLY, FOLDERS_ONLY or FILES_AND_FOLDERS. By default, only files are listed.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	FileSystemActor.FileSystemAction

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor	Description
FileSystemActor()

Method Summary

Modifier and Type	Method	Description
protected void	actionRequiresAtLeastOneOfTwoParametersOrAttribute(HasName owner, ParameterList parameterList, FileSystemActor.FileSystemAction configuredAction, FileSystemActor.FileSystemAction action, String parameter1, String parameter2, String attributeName, String attributeValue)
protected void	addActions(List<FileSystemActor.FileSystemAction> specificActions)
void	configure(S fileSystem, ParameterList parameterList, FrankElement owner)
Message	doAction(Message input, ParameterValueList pvl, PipeLineSession session)
void	open()
void	setAction(FileSystemActor.FileSystemAction action)	If parameter ["action"<F,S extends IBasicFileSystem<F>>] is set, then the attribute action value will be overridden with the value of the parameter.
void	setCharset(String charset)	Charset to be used for "read"<F,S extends IBasicFileSystem<F>> and "write"<F,S extends IBasicFileSystem<F>> action
void	setCreateFolder(boolean createFolder)	If true: if a non-existing folder is part of the fileName, it will be created.
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"<F,S extends IBasicFileSystem<F>>, "copy"<F,S extends IBasicFileSystem<F>> or "rename"<F,S extends IBasicFileSystem<F>>.
void	setExcludeWildcard(String excludeWildcard)	Filter of files to be excluded when looking in inputFolder.
void	setFilename(String filename)	Filename to operate on.
void	setInputFolder(String inputFolder)	Folder that is scanned for files when action="list"<F,S extends IBasicFileSystem<F>>.
void	setNumberOfBackups(int numberOfBackups)	For the actions "write"<F,S extends IBasicFileSystem<F>> and "append"<F,S extends IBasicFileSystem<F>>, with rotateSize>0: the number of backup files that is kept.
void	setOutputFormat(DocumentFormat outputFormat)	Sets the outputFormat.
void	setOverwrite(boolean overwrite)	If set true, for actions "create"<F,S extends IBasicFileSystem<F>>, "write"<F,S extends IBasicFileSystem<F>>, "move"<F,S extends IBasicFileSystem<F>>, "copy"<F,S extends IBasicFileSystem<F>> or "rename"<F,S extends IBasicFileSystem<F>>, 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"<F,S extends IBasicFileSystem<F>>: 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"<F,S extends IBasicFileSystem<F>>: 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	setTypeFilter(TypeFilter typeFilter)	Filter for action list.
void	setWildcard(String wildcard)	Filter of files to look for in inputFolder e.g. '*.inp'.
void	setWriteLineSeparator(boolean writeLineSeparator)	If set to true then the system specific line separator will be appended to the file after executing the action.

Methods inherited from class java.lang.Object

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

Field Details

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

PARAMETER_TYPEFILTER

public static final String PARAMETER_TYPEFILTER

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 Details

FileSystemActor

public FileSystemActor()

Method Details

configure

public void configure(@Nonnull
 S fileSystem,
 @Nonnull
 ParameterList parameterList,
 @Nonnull
 FrankElement owner)
               throws ConfigurationException

Throws:

ConfigurationException

actionRequiresAtLeastOneOfTwoParametersOrAttribute

protected void actionRequiresAtLeastOneOfTwoParametersOrAttribute(@Nonnull
 HasName owner,
 @Nonnull
 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

Throws:

FileSystemException

addActions

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

setAction

public void setAction(FileSystemActor.FileSystemAction action)

If parameter ["action"<F,S extends IBasicFileSystem<F>>] 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"<F,S extends IBasicFileSystem<F>>. When not set, the root is scanned

setCreateFolder

public void setCreateFolder(boolean createFolder)

If true: if a non-existing folder is part of the fileName, it will be created.

Default value

false

setOverwrite

public void setOverwrite(boolean overwrite)

If set true, for actions "create"<F,S extends IBasicFileSystem<F>>, "write"<F,S extends IBasicFileSystem<F>>, "move"<F,S extends IBasicFileSystem<F>>, "copy"<F,S extends IBasicFileSystem<F>> or "rename"<F,S extends IBasicFileSystem<F>>, 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"<F,S extends IBasicFileSystem<F>> is used. If that is not set either, the input is used

setDestination

public void setDestination(String destination)

Destination for "move"<F,S extends IBasicFileSystem<F>>, "copy"<F,S extends IBasicFileSystem<F>> or "rename"<F,S extends IBasicFileSystem<F>>. If not set, the parameter "destination"<F,S extends IBasicFileSystem<F>> is used. If that is not set either, the input is used

setRotateDays

public void setRotateDays(int rotateDays)

For action="append"<F,S extends IBasicFileSystem<F>>: 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"<F,S extends IBasicFileSystem<F>>: 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"<F,S extends IBasicFileSystem<F>> and "append"<F,S extends IBasicFileSystem<F>>, 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

setWildcard

public void setWildcard(String wildcard)

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

setExcludeWildcard

public void setExcludeWildcard(String excludeWildcard)

Filter of files to be excluded when looking in inputFolder. Works with actions "move"<F,S extends IBasicFileSystem<F>>, "copy"<F,S extends IBasicFileSystem<F>>, "delete"<F,S extends IBasicFileSystem<F>> and "list"<F,S extends IBasicFileSystem<F>>

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"<F,S extends IBasicFileSystem<F>> and "append"<F,S extends IBasicFileSystem<F>>

Default value

false

setCharset

public void setCharset(String charset)

Charset to be used for "read"<F,S extends IBasicFileSystem<F>> and "write"<F,S extends IBasicFileSystem<F>> 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"<F,S extends IBasicFileSystem<F>>, "readDelete"<F,S extends IBasicFileSystem<F>> and "move"<F,S extends IBasicFileSystem<F>>

setOutputFormat

public void setOutputFormat(DocumentFormat outputFormat)

Sets the outputFormat. This ignored when reading a file. Is applicable to actions which return information about file(s). Relevant for: 'info', 'list', 'append', 'move', 'delete' and 'copy' actions.

Default value

XML

setTypeFilter

public void setTypeFilter(TypeFilter typeFilter)

Filter for action list. Specify FILES_ONLY, FOLDERS_ONLY or FILES_AND_FOLDERS.

Default value

FILES_ONLY