flux.file

Interface FileFactory

public interface FileFactory

Creates file triggers and actions and other helper objects used by file triggers and actions.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Method Summary

Modifier and Type	Method and Description
FileCopyAction	makeFileCopyAction(java.lang.String name) Makes a new FileCopyAction.
FileCreateAction	makeFileCreateAction(java.lang.String name) Makes a new FileCreateAction.
FileDecryptPgpAction	makeFileDecryptPgpAction(java.lang.String name)
FileDeleteAction	makeFileDeleteAction(java.lang.String name) Makes a new FileDeleteAction.
FileEncryptPgpAction	makeFileEncryptPgpAction(java.lang.String name)
FileExistTrigger	makeFileExistTrigger(java.lang.String name) Makes a new FileExistTrigger.
FileModifiedTrigger	makeFileModifiedTrigger(java.lang.String name) Makes a new FileModifiedTrigger.
FileMoveAction	makeFileMoveAction(java.lang.String name) Makes a new FileMoveAction.
FileNotExistTrigger	makeFileNotExistTrigger(java.lang.String name) Makes a new FileNotExistTrigger.
fluximpl.file.FileReadAction	makeFileReadAction(java.lang.String name) Makes a new FileRenameAction.
FileRenameAction	makeFileRenameAction(java.lang.String name) Makes a new FileRenameAction.
FileUnzipAction	makeFileUnzipAction(java.lang.String name)
FileZipAction	makeFileZipAction(java.lang.String name)
FtpCommandAction	makeFtpCommandAction(java.lang.String name) Makes a new FtpCommandAction.
FtpHost	makeFtpHost() Makes a new FtpHost.
FtpSslHost	makeFtpSslHost() Makes a new FtpSslHost.
Renamer	makeGlobRenamer(java.lang.String fromPattern, java.lang.String toPattern) Renamers are used by file actions that operate on sources and targets.
IncludesFileCriteria	makeIncludesFileCriteria() Makes a new IncludesFileCriteria.
IncludesFileCriteria	makeIncludesFileCriteria(java.lang.String includeFilePattern) Makes a new IncludesFileCriteria using a file pattern.
IncludesFileCriteria	makeIncludesFileCriteria(java.lang.String includeFilePattern, int minimumCount) Makes a new IncludesFileCriteria using a file pattern and minimum count.
LocalHost	makeLocalHost() Makes a new LocalHost.
NetworkHost	makeNetworkHost() Makes a new NetworkHost.
Renamer	makeRegexRenamer(java.lang.String fromPattern, java.lang.String toPattern) Renamers are used by file actions that operate on sources and targets.
S3Host	makeS3Host() Makes a new S3Host.
SecureFtpHost	makeSecureFtpHost() Makes a new SecureFtpHost.
SingleFileCriteria	makeSingleFileCriteria() Makes a new SingleFileCriteria.
SingleFileCriteria	makeSingleFileCriteria(java.lang.String filename) Makes a new SingleFileCriteria using a filename.
TargetFileCriteria	makeTargetFileCriteria() Makes a new TargetFileCriteria.
UncHost	makeUncHost() Makes a new UncHost.

Method Detail

makeFileCopyAction

FileCopyAction makeFileCopyAction(java.lang.String name)

Makes a new FileCopyAction.

Parameters:

name - The name of the action.

Returns:

A freshly made FileCopyAction.

makeFileCreateAction

FileCreateAction makeFileCreateAction(java.lang.String name)

Makes a new FileCreateAction.

Parameters:

name - The name of the action.

Returns:

A freshly made FileCreateAction.

makeFileDeleteAction

FileDeleteAction makeFileDeleteAction(java.lang.String name)

Makes a new FileDeleteAction.

Parameters:

name - The name of the action.

Returns:

A freshly made FileDeleteAction.

makeFileExistTrigger

FileExistTrigger makeFileExistTrigger(java.lang.String name)

Makes a new FileExistTrigger.

Parameters:

name - The name of the trigger.

Returns:

A freshly made FileExistTrigger.

makeFileModifiedTrigger

FileModifiedTrigger makeFileModifiedTrigger(java.lang.String name)

Makes a new FileModifiedTrigger.

Parameters:

name - The name of the trigger.

Returns:

A freshly made FileModifiedTrigger.

makeFileMoveAction

FileMoveAction makeFileMoveAction(java.lang.String name)

Makes a new FileMoveAction.

Parameters:

name - The name of the action.

Returns:

A freshly made FileMoveAction.

makeFileNotExistTrigger

FileNotExistTrigger makeFileNotExistTrigger(java.lang.String name)

Makes a new FileNotExistTrigger.

Parameters:

name - The name of the trigger.

Returns:

A freshly made FileNotExistTrigger.

makeFileRenameAction

FileRenameAction makeFileRenameAction(java.lang.String name)

Makes a new FileRenameAction.

Parameters:

name - The name of the action.

Returns:

A freshly made FileRenameAction.

makeFileReadAction

fluximpl.file.FileReadAction makeFileReadAction(java.lang.String name)

Makes a new FileRenameAction.

Parameters:

name - The name of the action.

Returns:

A freshly made FileRenameAction.

makeFileUnzipAction

FileUnzipAction makeFileUnzipAction(java.lang.String name)

makeFileZipAction

FileZipAction makeFileZipAction(java.lang.String name)

makeFileEncryptPgpAction

FileEncryptPgpAction makeFileEncryptPgpAction(java.lang.String name)

makeFileDecryptPgpAction

FileDecryptPgpAction makeFileDecryptPgpAction(java.lang.String name)

makeFtpCommandAction

FtpCommandAction makeFtpCommandAction(java.lang.String name)

Makes a new FtpCommandAction.

Parameters:

name - The name of the action.

Returns:

A freshly made FtpCommandAction.

makeFtpHost

FtpHost makeFtpHost()

Makes a new FtpHost.

Returns:

A freshly made FtpHost.

makeFtpSslHost

FtpSslHost makeFtpSslHost()

Makes a new FtpSslHost.

Returns:

A freshly made FtpSslHost.

makeGlobRenamer

Renamer makeGlobRenamer(java.lang.String fromPattern,
                        java.lang.String toPattern)
                 throws EngineException

Renamers are used by file actions that operate on sources and targets. If the source file name matches the "from" pattern, the target file name will be created by substituting the "to" pattern. Patterns are case sensitive on all operating systems. A regular expression renamer should be used to ignore case sensitivity.

Parameters:

fromPattern - A glob pattern.

toPattern - A glob pattern.

Throws:

EngineException

makeIncludesFileCriteria

IncludesFileCriteria makeIncludesFileCriteria()

Makes a new IncludesFileCriteria.

Returns:

A freshly made IncludesFileCriteria.

makeIncludesFileCriteria

IncludesFileCriteria makeIncludesFileCriteria(java.lang.String includeFilePattern)

Makes a new IncludesFileCriteria using a file pattern. The IncludesFileCriteria object is first created, then the include() method is called on it using the specified file pattern.

Returns:

A freshly made IncludesFileCriteria using a file pattern.

makeIncludesFileCriteria

IncludesFileCriteria makeIncludesFileCriteria(java.lang.String includeFilePattern,
                                              int minimumCount)

Makes a new IncludesFileCriteria using a file pattern and minimum count. The IncludesFileCriteria object is first created, then the include() method is called on it using the specified file pattern and minimum count.

Returns:

A freshly made IncludesFileCriteria using a file pattern.

makeLocalHost

LocalHost makeLocalHost()

Makes a new LocalHost.

Returns:

A freshly made LocalHost.

makeNetworkHost

NetworkHost makeNetworkHost()

Makes a new NetworkHost.

Returns:

A freshly made NetworkHost.

makeRegexRenamer

Renamer makeRegexRenamer(java.lang.String fromPattern,
                         java.lang.String toPattern)
                  throws EngineException

Renamers are used by file actions that operate on sources and targets. If the source file name matches the "from" regular expression, the target file name will be created by substituting the "to" regular expression.

Parameters:

fromPattern - A regular expression.

toPattern - A regular expression, optionally including backward references.

Throws:

EngineException

makeS3Host

S3Host makeS3Host()

Makes a new S3Host.

Returns:

A freshly made S3Host.

makeSecureFtpHost

SecureFtpHost makeSecureFtpHost()

Makes a new SecureFtpHost.

Returns:

A freshly made SecureFtpHost.

makeSingleFileCriteria

SingleFileCriteria makeSingleFileCriteria()

Makes a new SingleFileCriteria.

Returns:

A freshly made SingleFileCriteria.

makeSingleFileCriteria

SingleFileCriteria makeSingleFileCriteria(java.lang.String filename)

Makes a new SingleFileCriteria using a filename. The SingleFileCriteria object is first created, then the setFilename() method is called on it using the specified filename.

Returns:

A freshly made SingleFileCriteria using a filename.

makeTargetFileCriteria

TargetFileCriteria makeTargetFileCriteria()

Makes a new TargetFileCriteria.

Returns:

A freshly made TargetFileCriteria.

makeUncHost

UncHost makeUncHost()

Makes a new UncHost.

Returns:

A freshly made UncHost.