EnsLib.FTP.Common
abstract class EnsLib.FTP.Common extends EnsLib.FTP.CommonSSH
Adapter that receives files via the FTP protocol.Property Inventory
Method Inventory
- Connect()
- CreateTimestamp()
- Disconnect()
- FileListClose()
- FileListExecute()
- FileListFetch()
- OnKeepalive()
- TestConnection()
Parameters
Properties
It is possible for a server to provide the filename list in RAW and for it to support UTF8. In this case it might be necessary to set the Command Translate Table to RAW to override the the detected UTF8
The values shown in the list are the internal table names.
If the protocol is FTP it is possible to use the setting SSL Configuration to configure FTP over SSL
If the protocol is SFTP then:
- the UsePASV and ServerListStyle values will be ignored.
- the FTPPort value should ordinarily be set to 22.
- you must supply a Credentials value
- if you supply values for both SFTPPublicKeyFile and SFTPPrivateKeyFile the adapter will attempt key pair authentication. It will do this in conjunction with the username and password supplied via the Credentials setting, using the password in the Credentials as the passphrase for the private key.
- if you don't supply both KeyFile values the adapter will attempt only username/password authentication based on the Credentials setting.
If this setting is blank then the protocol will be FTP - File Transfer Protocol subject to:
In order to support prior version compatibility a setting value of !SFTP for SSL Configuration will result in using
the SFTP - SSH File Transfer Protocol irrespective of this Protocol setting.
If enabled it matches based on the rules layed out in section 3.1 of RFC 2818.
This is for FTPS, meaning an encrypted connection to a normal FTP server.
If you append an asterisk (*) to the configuration name you enter, this adapter will use legacy FTPS mode. FTPS is defined by RFC4217 but some servers operate with a non-compliant variant which simply assumes that the command channel should use TLS. Earlier versions of this adapter worked only with this sort of non-compliant server. Append an asterisk to the SSL configuration name if you need to (continue to) work with this sort of server.
For prior version compatibility a value of !SFTP is still supported to indicate the protocol is SFTP.
The recommendation is to use the Protocol setting to indicate SFTP.
This feature requires OpenSSL v1.1.x+.
Methods
Queries
Inherited Members
Inherited Properties
- %SFTPPassphraseCredentialsObj
- ConnectTimeout
- FTPPort
- FTPServer
- SFTPAuthenticationMethods
- SFTPFileAccessMode
- SFTPInteractiveDTL
- SFTPLocalCharset
- SFTPPassphraseCredentials
- SFTPPrivateKeyFile
- SFTPPublicKeyFile
- SFTPRemoteCharset
- SFTPSetFileAccessModeByClient
- StayConnected
- TranslateTable
Inherited Methods
- %AddToSaveSet()
- %ClassIsLatestVersion()
- %ClassName()
- %ConstructClone()
- %DispatchClassMethod()
- %DispatchGetModified()
- %DispatchGetProperty()
- %DispatchMethod()
- %DispatchSetModified()
- %DispatchSetMultidimProperty()
- %DispatchSetProperty()
- %Extends()
- %GetParameter()
- %IsA()
- %IsModified()
- %New()
- %NormalizeObject()
- %ObjectModified()
- %OriginalNamespace()
- %PackageName()
- %RemoveFromSaveSet()
- %SerializeObject()
- %SetModified()
- %ValidateObject()
- AuthenticateSSH()
- ConnectSSH()
- FileListSSHClose()
- FileListSSHExecute()
- FileListSSHFetch()
- SFTPPassphraseCredentialsSet()
- System()
- TestConnectionSSH()