flux.file

Interface FtpCommandAction

All Superinterfaces:

Action, java.lang.Cloneable, RuntimeDataMap, java.io.Serializable

public interface FtpCommandAction
extends Action

Executes a sequence of commands on an FTP, SFTP, or FTPS host. Arguments to FTP commands can be substituted at runtime using Flux's usual global, date, and runtime property substitution capabilities. For example, to transmit a zip file named after today's date, the FTP command would be put ${date d-MMM-yyyy}.zip

The FTP Command Action returns its result in the flow context variable "RESULT". The following table contains more information on accessing and using the result.

Flow Context Variable	Field	Java Type	Description
RESULT	row	java.util.List<java.lang.String>	A List containing the String response from the FTP server for each FTP command the action executes. Responses are returned in the same order as the FTP commands listed on the action.

Author:

Copyright 2000-2025 Flux Corporation. All rights reserved.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	FtpCommandAction.FtpCommandActionResult The result when an FTP command action finishes execution.

Method Summary

Modifier and Type	Method and Description
java.util.List<java.lang.String>	getCommands() Returns the sequence of FTP commands to be executed.
FtpHost	getHost() Returns the FTP, SFTP, or FTPS host on which the specified commands will be executed.
void	setCommands(java.util.List<java.lang.String> commands) Sets the sequence of FTP commands to be executed.
void	setHost(FtpHost host) Sets the FTP, SFTP, or FTPS host on which the specified commands will be executed.

Methods inherited from interface flux.Action

addFlow, addFlow, addSignalFlow, clone, execute, getDescription, getFlows, getHiddenVariableNames, getJoinExpression, getName, getPostscript, getPostscriptLanguage, getPrescript, getPrescriptLanguage, getResultInfo, getSignalsToMonitor, getTimeoutBusinessInterval, getTimeoutBusinessIntervalNamespace, getTimeoutExpression, getVariableManager, isEndOfRun, isJoinPoint, isSkippable, isStartAction, isStartOfRun, isTransactionBreak, removeFlow, reset, setDescription, setElseFlow, setEndOfRun, setErrorFlow, setErrorFlowWithoutRollback, setErrorFlowWithRollback, setJoinExpression, setJoinPoint, setName, setPostscript, setPostscriptLanguage, setPrescript, setPrescriptLanguage, setSignalsToMonitor, setSkippable, setStartAction, setStartOfRun, setTimeoutBusinessInterval, setTimeoutBusinessIntervalNamespace, setTimeoutExpression, setTimeoutFlow, setTransactionBreak, verify, verifyOnClient

Methods inherited from interface flux.runtimedatamap.RuntimeDataMap

getRuntimeDataMap, setRuntimeDataMap

Method Detail

getCommands

java.util.List<java.lang.String> getCommands()

Returns the sequence of FTP commands to be executed. Supported FTP commands are listed below. Arguments to FTP commands can be substituted at runtime using Flux's usual global, date, and runtime property substitution capabilities. For example, to transmit a zip file named after today's date, the FTP command would be put ${date d-MMM-yyyy}.zip.

• cd remote-directory
• delete remote-file
• get remote-file [local-target-file]
• lcd local-directory
• ls
• mdelete regular-expression-to-match-remote-files
• mget regular-expression-to-match-remote-files
• mkdir remote-directory
• mput regular-expression-to-match-remote-files
• put local-file [remote-target-file]
• pwd
• quote command
• rename remote-old-filename remote-new-filename
• rmdir remote-directory

Returns:

The sequence of FTP commands to be executed. Does not return null.

getHost

FtpHost getHost()

Returns the FTP, SFTP, or FTPS host on which the specified commands will be executed.

Returns:

The FTP, SFTP, or FTPS host on which the specified commands will be executed.

setCommands

void setCommands(java.util.List<java.lang.String> commands)
          throws java.lang.IllegalArgumentException

Sets the sequence of FTP commands to be executed. Supported FTP commands are listed below. Arguments to FTP commands can be substituted at runtime using Flux's usual global, date, and runtime property substitution capabilities. For example, to transmit a zip file named after today's date, the FTP command would be put ${date d-MMM-yyyy}.zip.

• cd remote-directory
• delete remote-file
• get remote-file [local-target-file]
• lcd local-directory
• ls
• mdelete regular-expression-to-match-remote-files
• mget regular-expression-to-match-remote-files
• mkdir remote-directory
• mput regular-expression-to-match-remote-files
• put local-file [remote-target-file]
• pwd
• quote command
• rename remote-old-filename remote-new-filename
• rmdir remote-directory

Parameters:

commands - The sequence of FTP commands to be executed.

Throws:

java.lang.IllegalArgumentException - If the syntax of an FTP command is wrong.

setHost

void setHost(FtpHost host)

Sets the FTP, SFTP, or FTPS host on which the specified commands will be executed.

Parameters:

host - The FTP, SFTP, or FTPS host on which the specified commands will be executed.