The FTPClient class is the main class for implementing FTP functionality into workflows.

The FTPClient class defines the FTPClient():FTPClient constructor.

The FTPClient class defines the following attributes.

Attribute

Returns

Description

connectTimeout

number

Socket connection timeout

cwd

String

Current working directory

output

String

Command output if any

replyCode

Number

Last reply code

soLinger

Number

Socket SO Linger (null if disabled)

state

String

Run state

tcpNoDelay

Boolean

Socket TCP no delay

timeout

Number

Socket timeout

The FTPClient class defines the following methods.

Method

Returns

Description

connect(String,number) : Object

Object

Connects the client to a host.

disconnect() : Object

Object

Logs out and disconnects the current session if open.

enableSSL(boolean) : Object

Object

Enables SSL.

executeCommand(String,String) : number

Number

Runs a command.

getFile(String,String) : Number

Number

Copies a file from a remote host to the Orchestrator server.

getStatus() : String

String

Provides the status information returned by the server.

getString(String) : String

String

Gets the contents of a remote file.

isAvailable() : boolean

Boolean

Checks the socket to test whether it is available for use.

isConnected() : boolean

Boolean

Provides information about whether the client is currently connected to a server.

listAll(String) : String[]

Array of String

Lists all files and directories in a path.

listDir(String) : String[]

Array of String

Lists directories in a path.

listFile(String) : String[]

Array of String

Lists files in a path.

login(String,String,String) : boolean

Boolean

Logs in to an FTP server.

putFile(String,String) : Number

Number

Copies a file from the Orchestrator server to a remote host.

putString(String,String) : Number

Number

Adds a string of content to a remote file.