Package org.frankframework.filesystem

Enum Class FileSystemActor.FileSystemAction

java.lang.Object

java.lang.Enum<FileSystemActor.FileSystemAction>

org.frankframework.filesystem.FileSystemActor.FileSystemAction

All Implemented Interfaces:

Serializable, Comparable<FileSystemActor.FileSystemAction>, Constable, DocumentedEnum

Enclosing class:

FileSystemActor<F,S extends IBasicFileSystem<F>>

public static enum FileSystemActor.FileSystemAction
extends Enum<FileSystemActor.FileSystemAction>
implements DocumentedEnum

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
APPEND	(only for filesystems that support 'append') append contents, specified by parameter contents or input message, to a file, specified by attribute filename, parameter filename or input message.
COPY	copy a file, specified by attribute filename, parameter filename or input message, to a folder specified by attribute destination or parameter destination
CREATE	create empty file, specified by attribute filename, parameter filename or input message
DELETE	delete a file, specified by attribute filename, parameter filename or input message
DOWNLOAD	Deprecated.
FORWARD	(for MailFileSystems only:) forward an existing file, specified by parameter contents or input message, to a file, to an email address specified by attribute destination or parameter destination
INFO	show info about a single file, specified by attribute filename, parameter filename or input message
LIST	list files in a folder/directory, specified by attribute inputFolder, parameter inputFolder or input message
LISTATTACHMENTS	Specific to FileSystemSenderWithAttachments
MKDIR	create a folder/directory, specified by attribute inputFolder, parameter inputFolder or input message
MOVE	move a file, specified by attribute filename, parameter filename or input message, to a folder specified by attribute destination or parameter destination
READ	read a file, specified by attribute filename, parameter filename or input message
READDELETE	like read, but deletes the file after it has been read
RENAME	change the name of a file, specified by attribute filename, parameter filename or input message, to the value specified by attribute destination or parameter destination
RMDIR	remove a folder/directory, specified by attribute inputFolder, parameter inputFolder or input message
UPLOAD	Deprecated.
WRITE	Creates file and writes contents, specified by parameter contents or input message, to a file, specified by attribute filename, parameter filename or input message.

Method Summary

Modifier and Type	Method	Description
static FileSystemActor.FileSystemAction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FileSystemActor.FileSystemAction[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.frankframework.doc.DocumentedEnum

getLabel, name

Enum Constant Details

LIST

public static final FileSystemActor.FileSystemAction LIST

list files in a folder/directory, specified by attribute inputFolder, parameter inputFolder or input message

INFO

public static final FileSystemActor.FileSystemAction INFO

show info about a single file, specified by attribute filename, parameter filename or input message

READ

public static final FileSystemActor.FileSystemAction READ

read a file, specified by attribute filename, parameter filename or input message

DOWNLOAD

@Deprecated
public static final FileSystemActor.FileSystemAction DOWNLOAD

Deprecated.

replaced by read

READDELETE

public static final FileSystemActor.FileSystemAction READDELETE

like read, but deletes the file after it has been read

MOVE

public static final FileSystemActor.FileSystemAction MOVE

move a file, specified by attribute filename, parameter filename or input message, to a folder specified by attribute destination or parameter destination

COPY

public static final FileSystemActor.FileSystemAction COPY

copy a file, specified by attribute filename, parameter filename or input message, to a folder specified by attribute destination or parameter destination

DELETE

public static final FileSystemActor.FileSystemAction DELETE

delete a file, specified by attribute filename, parameter filename or input message

MKDIR

public static final FileSystemActor.FileSystemAction MKDIR

create a folder/directory, specified by attribute inputFolder, parameter inputFolder or input message

RMDIR

public static final FileSystemActor.FileSystemAction RMDIR

remove a folder/directory, specified by attribute inputFolder, parameter inputFolder or input message

WRITE

public static final FileSystemActor.FileSystemAction WRITE

Creates file and writes contents, specified by parameter contents or input message, to a file, specified by attribute filename, parameter filename or input message. At least one of the parameters must be specified. The missing parameter defaults to the input message. For streaming operation, the parameter filename must be specified.

UPLOAD

@Deprecated
public static final FileSystemActor.FileSystemAction UPLOAD

Deprecated.

replaced by write

APPEND

public static final FileSystemActor.FileSystemAction APPEND

(only for filesystems that support 'append') append contents, specified by parameter contents or input message, to a file, specified by attribute filename, parameter filename or input message. At least one of the parameters must be specified. The missing parameter defaults to the input message. For streaming operation, the parameter filename must be specified.

CREATE

public static final FileSystemActor.FileSystemAction CREATE

create empty file, specified by attribute filename, parameter filename or input message

RENAME

public static final FileSystemActor.FileSystemAction RENAME

change the name of a file, specified by attribute filename, parameter filename or input message, to the value specified by attribute destination or parameter destination

FORWARD

public static final FileSystemActor.FileSystemAction FORWARD

(for MailFileSystems only:) forward an existing file, specified by parameter contents or input message, to a file, to an email address specified by attribute destination or parameter destination

LISTATTACHMENTS

public static final FileSystemActor.FileSystemAction LISTATTACHMENTS

Specific to FileSystemSenderWithAttachments

Method Details

values

public static FileSystemActor.FileSystemAction[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static FileSystemActor.FileSystemAction valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null