Perform File Operation

This handler (com.rierino.handler.FSEventHandler) provides ability to interact with local and remote file systems for directory and file operations.

Handler Parameters

Parameter	Definition	Example	Default
systems	Comma separated list of file system names to use	imageFs,cdnFs	-
role.source	System name for sourcing files from for sync file role calls	imageFs	-
role.target	System name for pushing files to for sync file role calls	cdnFs	-
role.fromRegex	Regex for filtering source files	/source/(?<folder>\\w+)/(?<file>\\w+)	-
role.toPattern	Pattern for converting source paths to target paths	/target/${folder}/${file}	-
role.move	Whether role calls should move files or just copy	true	false

Actions

MakeDir

Creates a new directory in given file system. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Domain	Name of the file system to use	imageFs	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Path Path	Json path in payload for directory path to create	filePath	path

JSON Schema

List / ListPath

Lists files and directories for given path. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Domain	Name of the file system to use	imageFs	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Path Path	Json path in payload for directory path to list	filePath	path

JSON Schema

Delete / DeletePath

Deletes a file or directory in given file system. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Domain	Name of the file system to use	imageFs	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Path Path	Json path in payload for file/directory path to delete	filePath	path
Recursive	Whether deletion should include sub-directories	true	false

JSON Schema

Rename / RenamePath

Renames a file or directory in given file system. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Domain	Name of the file system to use	imageFs	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Path Path	Json path in payload for file/directory to rename	filePath	path
To Path	Json path in payload for new file/directory name	newPath	to

JSON Schema

CopyFile

Copies or moves a file from one file system to another. Event metadata fields applicable for this action are as follows:

Table

Field	Definition	Example	Default
Domain	Name of the source file system to use	imageFs	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
target	Name of the target file system	cdnFs	-
Path Path	Json path in payload for file/directory to copy	filePath	path
To Path	Json path in payload for target file/directory	newPath	to
Move	Whether file should be deleted from the source	true	false

JSON Schema

Write / WriteFile

Writes contents to a single file or a set of files for a given file system:

Table

Field	Definition	Example	Default
Domain	Name of the file system to write to	dataLakeFs	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Path Path	Json path in payload for directory path to list (from payload root)	parameters.id	path
Mode	Type of file(s) to output (sequence, single)	sequence	single
Prefix	Prefix to add to each file's name (for sequence mode output)	tracking/views	-
Suffix	Suffix to add to each file's name (for sequence mode output)	_out.json	-
Content	Event contents to write to file (for sequence mode, event, request or payload)	request	payload
Overwrite	Whether to overwrite or append contents to output (for single mode output)	true	false
Base64	Whether the input should be treated as base64 text and decoded for generating the file (e.g. image, PDF)	true	false

JSON Schema

Example

Input

{
    "customerId": "customer-1",
    "productId": "product-1",
    "pageId": "product-detail"
}

Event Metadata

For sequence output mode, this handler uses a path writer, which is responsible for generating unique sequence file paths/names for wrting contents to. The writer can be configured by adding path.* parameters to file system definition.

Using "[uuid]" in prefix or suffix allows generation of globally unique paths and file names, as this entry is replaced with a UUID value generated.

Read / ReadFile

Reads and returns contents of a file (in a cachable manner):

Table

Field	Definition	Example	Default
Domain	Name of the file system to read from	contentsFs	-

JSON Schema

With event metadata parameters as:

Table

Parameter	Definition	Example	Default
Path Path	Json path in payload for directory path to list	id	path
Format	Format of the file contents to retrieve (json,text)	json	text

JSON Schema

Roles

syncFile

Uses pulse records to trigger delete, copy or move of files from one file system to another, based on handler role parameters.