FtpRequest

Method Summary
boolean	changeFolder(String folder) Changes to the specified folder.
boolean	connect(String connectorName) Connects using a pre-configured FTP/FTPS/SFTP Connector.
boolean	connect(String type, String host, int port, String username, String password, String defaultFolder, String connectionType, int lowDataPort, int highDataPort) Connects using the specified parameters. This method is a convenience method for development purposes. For security best practices, don't store remote server credentials in the Pal.
boolean	createFolder(String folder) Creates a folder in the current folder
boolean	deleteFile(String filename) Deletes the specified file.
boolean	deleteFolder(String folder, boolean recursive) Deletes the specified folder (and all subfolder if recursive is true).
	disconnect() Terminates the connection.
String	getCurrentFolder() Returns current directory
File	getFile(String filename, boolean deleteRemoteFile) Gets the specified file.
File[]	getFiles(int limit, boolean deleteRemoteFile) Gets the specified files in the current directory (limit = max files to retrieve).
UnknownFile	getUnknownFile(String filename, boolean deleteRemoteFile) Gets the specified file. Returns null if its size exceeds the max size allowed by the key.
DataList	listFiles(int limit) Lists the files and folders in this folder. Type will be 'file' or 'folder'.
boolean	putFile(File file) Puts the specified file in the current remote directory. 4MB is the minimum limit. Files over 4MB are controlled by the activation key max export setting.
	setPrivateKey(String key, String keyPassword) Supplies a private key for connecting to a server. Call this before calling connect(). This will over-ride any private key in a connector.
String	toString() Returns a description of this object.
	useLegacy(boolean legacy) ⚠Deprecated since 12-02-2020. This method provides transitional functionality and will be removed. Indicates whether or not to use legacy libraries for connectivity.

Method Detail

---

boolean changeFolder(String folder)

Changes to the specified folder.

Parameters:

• String   folder Required parameter.

Returns:  boolean

Since: 05-25-2011

---

boolean connect(String connectorName)

Connects using a pre-configured FTP/FTPS/SFTP Connector.

Parameters:

• String   connectorName Required parameter.

Returns:  boolean

Since: 05-25-2011

---

boolean connect(String type, String host, int port, String username, String password, String defaultFolder, String connectionType, int lowDataPort, int highDataPort)

Connects using the specified parameters. This method is a convenience method for development purposes. For security best practices, don't store remote server credentials in the Pal.

Parameters:

• String   type Required parameter. Allowed values: ftp, ftps, sftp.
• String   host Required parameter.
• int   port Required parameter.
• String   username
• String   password
• String   defaultFolder
• String   connectionType Allowed values: explicit, implicit.
• int   lowDataPort
• int   highDataPort

Returns:  boolean

Since: 05-25-2011

---

boolean createFolder(String folder)

Creates a folder in the current folder

Parameters:

• String   folder Required parameter.

Returns:  boolean

Since: 09-01-2016

---

boolean deleteFile(String filename)

Deletes the specified file.

Parameters:

• String   filename Required parameter.

Returns:  boolean

Since: 05-25-2011

---

boolean deleteFolder(String folder, boolean recursive)

Deletes the specified folder (and all subfolder if recursive is true).

Parameters:

• String   folder Required parameter.
• boolean   recursive

Returns:  boolean

Since: 09-01-2016

---

disconnect()

Terminates the connection.

Since: 05-25-2011

---

String getCurrentFolder()

Returns current directory

Returns:  String

Since: 05-25-2011

---

File getFile(String filename, boolean deleteRemoteFile)

Gets the specified file.

Parameters:

• String   filename Required parameter.
• boolean   deleteRemoteFile Required parameter.

Returns:  File

Since: 05-25-2011

---

File[] getFiles(int limit, boolean deleteRemoteFile)

Gets the specified files in the current directory (limit = max files to retrieve).

Parameters:

• int   limit Required parameter. Maximum allowed size of parameter: 100
• boolean   deleteRemoteFile

Returns:  File[]

Since: 05-25-2011

---

UnknownFile getUnknownFile(String filename, boolean deleteRemoteFile)

Gets the specified file. Returns null if its size exceeds the max size allowed by the key.

Parameters:

• String   filename Required parameter.
• boolean   deleteRemoteFile Required parameter.

Returns:  UnknownFile

Since: 03-28-2018

---

DataList listFiles(int limit)

Lists the files and folders in this folder. Type will be 'file' or 'folder'.

Parameters:

• int   limit

Returns:  DataList

DataList Name: files
DataList Fields: filename, fileSize, date, type

Since: 05-25-2011

---

boolean putFile(File file)

Puts the specified file in the current remote directory. 4MB is the minimum limit. Files over 4MB are controlled by the activation key max export setting.

Parameters:

• File   file Required parameter.

Returns:  boolean

Since: 05-25-2011

---

setPrivateKey(String key, String keyPassword)

Supplies a private key for connecting to a server. Call this before calling connect(). This will over-ride any private key in a connector.

Parameters:

• String   key  - Key in PEM format.
• String   keyPassword  - Password for the key. Optional, pass null if no password.

Since: 08-18-2016

---

String toString()

Returns a description of this object.

Returns:  String

Since: 05-25-2011

---

useLegacy(boolean legacy)

Indicates whether or not to use legacy libraries for connectivity.

Parameters:

• boolean   legacy Required parameter.

Since: 12-02-2020

This method has been deprecated since 12-02-2020. This method provides transitional functionality and will be removed.