Home > Class Reference > ENSLIB namespace > EnsLib.FTP.CommonSSH
Private  Storage   

EnsLib.FTP.CommonSSH


abstract class EnsLib.FTP.CommonSSH extends
%RegisteredObject

Adapter that receives files via the FTP protocol.

Inventory


Parameters Properties Methods Queries Indices ForeignKeys Triggers
1 16 20 1


Summary


Properties
ConnectTimeout FTPPort FTPServer SFTPFileAccessMode
SFTPPrivateKeyFile SFTPPublicKeyFile StayConnected TranslateTable

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
ConnectSSH FileListSSHClose FileListSSHExecute FileListSSHFetch
System TestConnectionSSH

Subclasses
EnsLib.FTP.Common

Parameters


• parameter SETTINGS = "FTPServer:Basic,FTPPort:Basic,Credentials:Basic:credentialsSelector,FilePath:Basic,Charset::selector?context={Ens.ContextSearch/CharacterSets},StayConnected:Connection,ConnectTimeout:Connection,SFTPPublicKeyFile:SFTP,SFTPPrivateKeyFile:SFTP,SFTPFileAccessMode:SFTP";

Properties


• property ConnectTimeout as %Numeric(MINVAL=0) [ InitialExpression = 5 ];
Number of seconds to wait on each connection attempt
• property FTPPort as %Integer;
TCP Port on the FTP Server to connect to. For FTP the standard port is 21 and for SFTP it is 22. Leave this field blank to use the appropriate standard value.
• property FTPServer as %String(MAXLEN=1000);
FTP Server to connect to
• property SFTPFileAccessMode as %String [ InitialExpression = "0600" ];
SFTP File Access Mode specifies the access permissions to assign to the file on the remote system when transferred.
It can be specified as either octal e.g. 0600 or symbolic such as u+rw,g+r
The default is 0600. If specifying octal 4 digits are required.
For symbolic and specifying all use 'ugo' and not 'a' e.g ugo+rw.
• property SFTPPrivateKeyFile as %String(MAXLEN=1000);
File path to a file containing the SSH private key certificate
• property SFTPPublicKeyFile as %String(MAXLEN=1000);
File path to a file containing the SSH public key certificate
• property StayConnected as %Numeric(MINVAL=-1) [ InitialExpression = -1 ];
If non-zero, stay connected to the remote system between handling Requests until idle for this number of seconds. A value of -1 means never disconnect.
• property TranslateTable as %String;
The translate table to be used when reading or writing files.

Methods


• method ConnectSSH(pTimeout As %Numeric = 15, pInbound As %Boolean = 0, pSFTPPort As %Integer) as %Status
• classmethod FileListSSHClose(QHandle As %Binary) as %Status
• classmethod FileListSSHExecute(ByRef QHandle As %Binary, adapter As Ens.Adapter, directory As %String, wildcards As %String, dirsOrNoDirs As %Boolean = 0, semaphoreSpec As %String = "") as %Status
• classmethod FileListSSHFetch(ByRef QHandle As %Binary, ByRef Row As %List, ByRef AtEnd As %Integer = 0) as %Status
• method System(ByRef System As %String) as %Boolean
• method TestConnectionSSH(pInbound)

Queries


• query FileListSSH(adapter As Ens.Adapter, directory As %String(MAXLEN=""), wildcards As %String, dirsOrNoDirs As %Boolean = 0, semaphoreSpec As %String = "")
Selects Name As %String, Type As %String, Size As %BigInt, DateCreated As %TimeStamp, DateModified As %TimeStamp, ItemName As %String, ItemDir As %String, SemaphoreName As %String
This query is a shadow of the FileSet query in %Library.File, using an interface to the Adapter and skipping directories The dirsOrNoDirs argument if 0 (the default) will exclude directory entries, or if 1 will return directory entries only.