Method Detailboolean changeFolder(String folder) Changes to the specified folder.
Parameters:
Returns: boolean Since: 05-25-2011 boolean connect(String connectorName) Connects using a pre-configured FTP/FTPS/SFTP Connector.
Parameters:
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:
Returns: boolean Since: 05-25-2011 boolean createFolder(String folder) Creates a folder in the current folder
Parameters:
Returns: boolean Since: 09-01-2016 boolean deleteFile(String filename) Deletes the specified file. Returns false if the file does not exist or cannot be deleted.
Parameters:
Returns: boolean Since: 05-25-2011 boolean deleteFolder(String folder, boolean recursive) Deletes the specified folder (and all subfolder if recursive is true). Returns false if the folder does not exist or cannot be deleted.
Parameters:
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:
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, 0 = no limit).
Parameters:
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:
Returns: UnknownFile Since: 03-28-2018 DataList listFiles(int limit) Lists the files and folders in this folder. Type will be 'file' or 'folder'. The entries '.' and '..' are included in the list. Names that are not Latin-1 (for example Cyrillic or Japanese) are supported on SFTP and on FTP/FTPS servers that support UTF-8.
Parameters:
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:
Returns: boolean Since: 05-25-2011 setConnectTimeout(int connectTimeout) Sets how long to wait for the server to accept the connection, in seconds. Call this before calling connect(). Default is 10 seconds, the maximum is 30. A host name that does not resolve or a server that refuses the connection fails at once; this limit applies to a server that does not answer at all.
Parameters:
Since: 11-18-2026 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:
Since: 08-18-2016 String toString() Returns a description of this object. Returns: String Since: 05-25-2011 useLegacy(boolean legacy) No longer supported: the legacy connectivity libraries have been removed. Calling this method throws an exception.
Parameters:
Since: 12-02-2020 This method has been deprecated since 12-02-2020. The legacy libraries have been removed. This method now throws an exception; remove the call. |
|||||||||||||||||||||||||||||||||||||
| Copyright © 2006 - 2026, ContractPal, Inc. All rights reserved. | API Date: Nov 18, 2026 11:49 PM |