OFTPClient Class

Properties   Methods   Events   Config Settings   Errors  

The OFTPClient class implements the Odette File Transfer Protocol.

Class Name

IPWorksEDI_OFTPClient

Procedural Interface

 ipworksedi_oftpclient_open();
 ipworksedi_oftpclient_close($res);
 ipworksedi_oftpclient_register_callback($res, $id, $function);
 ipworksedi_oftpclient_get_last_error($res);
 ipworksedi_oftpclient_get_last_error_code($res);
 ipworksedi_oftpclient_set($res, $id, $index, $value);
 ipworksedi_oftpclient_get($res, $id, $index);
 ipworksedi_oftpclient_do_changedirection($res);
 ipworksedi_oftpclient_do_config($res, $configurationstring);
 ipworksedi_oftpclient_do_connect($res);
 ipworksedi_oftpclient_do_disconnect($res);
 ipworksedi_oftpclient_do_doevents($res);
 ipworksedi_oftpclient_do_exchangecertificate($res, $certificatestore, $certificateexchangetype);
 ipworksedi_oftpclient_do_importtrustedcerts($res);
 ipworksedi_oftpclient_do_interrupt($res);
 ipworksedi_oftpclient_do_logoff($res);
 ipworksedi_oftpclient_do_logon($res);
 ipworksedi_oftpclient_do_receivefiles($res);
 ipworksedi_oftpclient_do_reset($res);
 ipworksedi_oftpclient_do_sendendresponse($res, $virtualfilename, $virtualfiledate, $destination, $originator, $creator, $reasoncode, $reasontext, $filehash, $signature);
 ipworksedi_oftpclient_do_sendfile($res, $localfile, $virtualfilename);
 ipworksedi_oftpclient_do_validatecert($res);
 ipworksedi_oftpclient_do_validaterecipientcert($res);

Remarks

The OFTPClient component may be used to send and receive OFTP files to and from an OFTP server.

Receiving Files

The OFTPClient ReceiveFiles function requires certain server properties be set. You must set the RemoteHost property to the remote location of the desired OFTP server. You may also set a RemotePort if the server is not set to the default protocol port. For client authorization, you must set the ClientSSIDCode, ClientSFIDCode, and ClientPassword properties. And, for server authentication, you must set the ServerSSIDCode, ServerSFIDCode, and ServerPassword properties.

The class will connect to the OFTP server and download all files in the server's outgoing queue, and write these files to the directory specified by DownloadDirectory. The class creates a default location on the local machine based on the values of the DownloadDirectory and the Virtual Filename as received from the server. If a different location is preferred, you may set the LocalFile parameter of the StartTransfer event.

Sending Files

The OFTPClient SendFile function requires the same server and authentication properties to be set as the ReceiveFiles function.

The class will connect to the OFTP server and upload the file contained by the LocalFile parameter. It uses the name specified by VirtualFileName when sending to the server. If this is not specified, the filename of the local file is parsed and used as the virtual filename.

Property List

---

The following is the full list of the properties of the class with short descriptions. Click on the links for further details.

Method List

---

The following is the full list of the methods of the class with short descriptions. Click on the links for further details.

Event List

---

The following is the full list of the events fired by the class with short descriptions. Click on the links for further details.

Config Settings

---

The following is a list of config settings for the class with short descriptions. Click on the links for further details.

CertStore Property (IPWorksEDI_OFTPClient Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getCertStore();
public function setCertStore($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 16 );
ipworksedi_oftpclient_set($res, 16, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The CertStoreType property denotes the type of the certificate store specified by CertStore. If the store is password-protected, specify the password in CertStorePassword.

CertStore is used in conjunction with the CertSubject property to specify client certificates. If CertStore has a value, and CertSubject or CertEncoded is set, a search for a certificate is initiated. Please see the CertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

CertStorePassword Property (IPWorksEDI_OFTPClient Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getCertStorePassword();
public function setCertStorePassword($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 17 );
ipworksedi_oftpclient_set($res, 17, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

CertStoreType Property (IPWorksEDI_OFTPClient Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getCertStoreType();
public function setCertStoreType($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 18 );
ipworksedi_oftpclient_set($res, 18, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

CertSubject Property (IPWorksEDI_OFTPClient Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getCertSubject();
public function setCertSubject($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 26 );
ipworksedi_oftpclient_set($res, 26, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

CertEncoded Property (IPWorksEDI_OFTPClient Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getCertEncoded();
public function setCertEncoded($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 27 );
ipworksedi_oftpclient_set($res, 27, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The CertStore and CertSubject properties also may be used to specify a certificate.

When CertEncoded is set, a search is initiated in the current CertStore for the private key of the certificate. If the key is found, CertSubject is updated to reflect the full subject of the selected certificate; otherwise, CertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

ClientPassword Property (IPWorksEDI_OFTPClient Class)

The client's password.

Object Oriented Interface

public function getClientPassword();
public function setClientPassword($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 28 );
ipworksedi_oftpclient_set($res, 28, $value );

Default Value

''

Remarks

The password assigned to the client in the bilateral agreement. This property must be a string of no more than 8 characters long.

Data Type

String

ClientSFIDCode Property (IPWorksEDI_OFTPClient Class)

Client's SFID code.

Object Oriented Interface

public function getClientSFIDCode();
public function setClientSFIDCode($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 29 );
ipworksedi_oftpclient_set($res, 29, $value );

Default Value

''

Remarks

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

Data Type

String

ClientSSIDCode Property (IPWorksEDI_OFTPClient Class)

The client's SSID code.

Object Oriented Interface

public function getClientSSIDCode();
public function setClientSSIDCode($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 30 );
ipworksedi_oftpclient_set($res, 30, $value );

Default Value

''

Remarks

The identification code of the client. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:

Data Type

String

Compress Property (IPWorksEDI_OFTPClient Class)

Whether or not to compress the outgoing file.

Object Oriented Interface

public function getCompress();
public function setCompress($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 31 );
ipworksedi_oftpclient_set($res, 31, $value );

Default Value

false

Remarks

When sending a file to the trading partner, set this to true for the class to compress the file before sending. The file will first be compressed to a temporary file before being sent.

Note that this is only applicable when Version 2.0 of the protocol is used as indicated by Version.

This property is not available at design time.

Data Type

Boolean

Connected Property (IPWorksEDI_OFTPClient Class)

Shows whether the class is connected.

Object Oriented Interface

public function getConnected();

Procedural Interface

ipworksedi_oftpclient_get($res, 32 );

Default Value

false

Remarks

Use this property to determine whether the class is connected to the remote host or not.

Use the Connect and Disconnect methods to manage the connection.

This property is read-only and not available at design time.

Data Type

Boolean

DownloadDirectory Property (IPWorksEDI_OFTPClient Class)

Download directory.

Object Oriented Interface

public function getDownloadDirectory();
public function setDownloadDirectory($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 33 );
ipworksedi_oftpclient_set($res, 33, $value );

Default Value

'./'

Remarks

This property contains the location on disk of the folder the class will write received files to. The default for this property is "./", which is the current working directory.

Note: If this property is set to empty string data will not be written to disk and instead will be available through the Transfer event.

Data Type

String

EncryptionAlgorithm Property (IPWorksEDI_OFTPClient Class)

The encryption algorithm.

Object Oriented Interface

public function getEncryptionAlgorithm();
public function setEncryptionAlgorithm($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 34 );
ipworksedi_oftpclient_set($res, 34, $value );

Default Value

0

Remarks

In order to use encryption, you must set the VirtualFileSecurityLevel property. The supported algorithms for encryption are:

This property is not available at design time.

Data Type

Integer

FirewallAutoDetect Property (IPWorksEDI_OFTPClient Class)

Whether to automatically detect and use firewall system settings, if available.

Object Oriented Interface

public function getFirewallAutoDetect();
public function setFirewallAutoDetect($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 35 );
ipworksedi_oftpclient_set($res, 35, $value );

Default Value

false

Remarks

Whether to automatically detect and use firewall system settings, if available.

Data Type

Boolean

FirewallType Property (IPWorksEDI_OFTPClient Class)

The type of firewall to connect through.

Object Oriented Interface

public function getFirewallType();
public function setFirewallType($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 36 );
ipworksedi_oftpclient_set($res, 36, $value );

Default Value

0

Remarks

The type of firewall to connect through. The applicable values are as follows:

Data Type

Integer

FirewallHost Property (IPWorksEDI_OFTPClient Class)

The name or IP address of the firewall (optional).

Object Oriented Interface

public function getFirewallHost();
public function setFirewallHost($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 37 );
ipworksedi_oftpclient_set($res, 37, $value );

Default Value

''

Remarks

The name or IP address of the firewall (optional). If a FirewallHost is given, the requested connections will be authenticated through the specified firewall when connecting.

If this property is set to a Domain Name, a DNS request is initiated. Upon successful termination of the request, this property is set to the corresponding address. If the search is not successful, the class fails with an error.

Data Type

String

FirewallPassword Property (IPWorksEDI_OFTPClient Class)

A password if authentication is to be used when connecting through the firewall.

Object Oriented Interface

public function getFirewallPassword();
public function setFirewallPassword($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 38 );
ipworksedi_oftpclient_set($res, 38, $value );

Default Value

''

Remarks

A password if authentication is to be used when connecting through the firewall. If FirewallHost is specified, the FirewallUser and FirewallPassword properties are used to connect and authenticate to the given firewall. If the authentication fails, the class fails with an error.

Data Type

String

FirewallPort Property (IPWorksEDI_OFTPClient Class)

The Transmission Control Protocol (TCP) port for the firewall Host .

Object Oriented Interface

public function getFirewallPort();
public function setFirewallPort($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 39 );
ipworksedi_oftpclient_set($res, 39, $value );

Default Value

0

Remarks

The Transmission Control Protocol (TCP) port for the firewall FirewallHost. See the description of the FirewallHost property for details.

Note: This property is set automatically when FirewallType is set to a valid value. See the description of the FirewallType property for details.

Data Type

Integer

FirewallUser Property (IPWorksEDI_OFTPClient Class)

A username if authentication is to be used when connecting through a firewall.

Object Oriented Interface

public function getFirewallUser();
public function setFirewallUser($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 40 );
ipworksedi_oftpclient_set($res, 40, $value );

Default Value

''

Remarks

A username if authentication is to be used when connecting through a firewall. If FirewallHost is specified, this property and the FirewallPassword property are used to connect and authenticate to the given Firewall. If the authentication fails, the class fails with an error.

Data Type

String

LocalHost Property (IPWorksEDI_OFTPClient Class)

The name of the local host or user-assigned IP interface through which connections are initiated or accepted.

Object Oriented Interface

public function getLocalHost();
public function setLocalHost($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 41 );
ipworksedi_oftpclient_set($res, 41, $value );

Default Value

''

Remarks

This property contains the name of the local host as obtained by the gethostname() system call, or if the user has assigned an IP address, the value of that address.

In multihomed hosts (machines with more than one IP interface) setting LocalHost to the IP address of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface. It is recommended to provide an IP address rather than a hostname when setting this property to ensure the desired interface is used.

If the class is connected, the LocalHost property shows the IP address of the interface through which the connection is made in internet dotted format (aaa.bbb.ccc.ddd). In most cases, this is the address of the local host, except for multihomed hosts (machines with more than one IP interface).

Note: LocalHost is not persistent. You must always set it in code, and never in the property window.

Data Type

String

MaxRecordSize Property (IPWorksEDI_OFTPClient Class)

The maximum length of a given record.

Object Oriented Interface

public function getMaxRecordSize();
public function setMaxRecordSize($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 42 );
ipworksedi_oftpclient_set($res, 42, $value );

Default Value

0

Remarks

This value determines the maximum length for a record in the outgoing virtual file. When VirtualFileFormat has been set to ffUnstructured or ffText, this value must be zero. When ffFixed or ffVariable, this must be set to a value greater than 0, containing the maximum line length of the outgoing file.

Data Type

Integer

Overwrite Property (IPWorksEDI_OFTPClient Class)

Whether or not the class should overwrite files during transfer.

Object Oriented Interface

public function getOverwrite();
public function setOverwrite($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 43 );
ipworksedi_oftpclient_set($res, 43, $value );

Default Value

false

Remarks

This property is a value indicating whether or not the class should overwrite downloaded files. If Overwrite is false, an error will be thrown whenever the local file exists before a receive operation.

Data Type

Boolean

RecipientCertStore Property (IPWorksEDI_OFTPClient Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getRecipientCertStore();
public function setRecipientCertStore($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 59 );
ipworksedi_oftpclient_set($res, 59, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The RecipientCertStoreType property denotes the type of the certificate store specified by RecipientCertStore. If the store is password-protected, specify the password in RecipientCertStorePassword.

RecipientCertStore is used in conjunction with the RecipientCertSubject property to specify client certificates. If RecipientCertStore has a value, and RecipientCertSubject or RecipientCertEncoded is set, a search for a certificate is initiated. Please see the RecipientCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

This property is not available at design time.

Data Type

Binary String

RecipientCertStorePassword Property (IPWorksEDI_OFTPClient Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getRecipientCertStorePassword();
public function setRecipientCertStorePassword($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 60 );
ipworksedi_oftpclient_set($res, 60, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

This property is not available at design time.

Data Type

String

RecipientCertStoreType Property (IPWorksEDI_OFTPClient Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getRecipientCertStoreType();
public function setRecipientCertStoreType($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 61 );
ipworksedi_oftpclient_set($res, 61, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

This property is not available at design time.

Data Type

Integer

RecipientCertSubject Property (IPWorksEDI_OFTPClient Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getRecipientCertSubject();
public function setRecipientCertSubject($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 69 );
ipworksedi_oftpclient_set($res, 69, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

This property is not available at design time.

Data Type

String

RecipientCertEncoded Property (IPWorksEDI_OFTPClient Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getRecipientCertEncoded();
public function setRecipientCertEncoded($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 70 );
ipworksedi_oftpclient_set($res, 70, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The RecipientCertStore and RecipientCertSubject properties also may be used to specify a certificate.

When RecipientCertEncoded is set, a search is initiated in the current RecipientCertStore for the private key of the certificate. If the key is found, RecipientCertSubject is updated to reflect the full subject of the selected certificate; otherwise, RecipientCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

RemoteHost Property (IPWorksEDI_OFTPClient Class)

The domain name or IP address of the OFTP server.

Object Oriented Interface

public function getRemoteHost();
public function setRemoteHost($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 71 );
ipworksedi_oftpclient_set($res, 71, $value );

Default Value

''

Remarks

The RemoteHost property specifies the IP address (IP number in dotted internet format) or Domain Name of the OFTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

If the RemoteHost property is set to a Domain Name, a DNS request is initiated and upon successful termination of the request, the RemoteHost property is set to the corresponding address. If the search is not successful, an error is returned.

If the class is configured to use a SOCKS firewall, the value assigned to this property may be preceded with an "*". If this is the case, the host name is passed to the firewall unresolved and the firewall performs the DNS resolution.

Data Type

String

RemotePort Property (IPWorksEDI_OFTPClient Class)

The port for the OFTP service (default is 3305).

Object Oriented Interface

public function getRemotePort();
public function setRemotePort($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 72 );
ipworksedi_oftpclient_set($res, 72, $value );

Default Value

3305

Remarks

A valid port number (a value between 1 and 65535) is required for the connection to take place. The property must be set before a connection is attempted and cannot be changed once a connection is established. Any attempt to change this property while connected will fail with an error.

When UseSSL is set to True this property will be set to 6619.

This property is not available at design time.

Data Type

Integer

SecureAuthentication Property (IPWorksEDI_OFTPClient Class)

Whether or not the class should perform secure Odette authentication.

Object Oriented Interface

public function getSecureAuthentication();
public function setSecureAuthentication($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 73 );
ipworksedi_oftpclient_set($res, 73, $value );

Default Value

false

Remarks

If true, the class will perform secure authentication when connecting to the server. The secure authentication consists of encrypting and decrypting data sent to and from the server, and verifying that this occurred successfully. Secure authentication may be performed in plaintext or SSL mode.

Both Certificate and RecipientCert properties must be populated when this property is set to true.

This is only valid for version 2.0 of the protocol.

This property is not available at design time.

Data Type

Boolean

ServerPassword Property (IPWorksEDI_OFTPClient Class)

The server's password.

Object Oriented Interface

public function getServerPassword();
public function setServerPassword($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 74 );
ipworksedi_oftpclient_set($res, 74, $value );

Default Value

''

Remarks

The password assigned to the server in the bilateral agreement. This property must be a string of no more than 8 characters long.

Data Type

String

ServerSFIDCode Property (IPWorksEDI_OFTPClient Class)

Server's SFID code.

Object Oriented Interface

public function getServerSFIDCode();
public function setServerSFIDCode($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 75 );
ipworksedi_oftpclient_set($res, 75, $value );

Default Value

''

Remarks

The SFID code identifies the origin or destination party that is sending or receiving a file, while the SSID code identifies the party that a session is established with. If the SFID and SSID codes do not match, then the party the session is established with is acting as an intermediary, and the party identified by the SFID code is either the origin or final destination.

When acting as an intermediary the component will not perform any security services (i.e. sign, verify, encrypt, decrypt). Security services are to be performed by the origin or destination only. Data should simply be passed along by an intermediary.

Data Type

String

ServerSSIDCode Property (IPWorksEDI_OFTPClient Class)

The server's SSID code.

Object Oriented Interface

public function getServerSSIDCode();
public function setServerSSIDCode($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 76 );
ipworksedi_oftpclient_set($res, 76, $value );

Default Value

''

Remarks

The identification code of the server. This code may be less than, but no more than 25 characters long. Generally, SSID codes have the following format as specified in RFC 2204 that is based on ISO 6523:

Data Type

String

SignedReceipt Property (IPWorksEDI_OFTPClient Class)

Whether or not to require signed receipts.

Object Oriented Interface

public function getSignedReceipt();
public function setSignedReceipt($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 77 );
ipworksedi_oftpclient_set($res, 77, $value );

Default Value

false

Remarks

When sending a file to a trading partner, set this to true if the file receipt should be signed by the server. When this receipt is received by the class, it will be verified during processing.

NOTE: If the server does not attach the public certificate in the signed message, the server's public key must be specified in the RecipientCert property in order for verification to succeed.

This property is not available at design time.

Data Type

Boolean

SSLAcceptServerCertEffectiveDate Property (IPWorksEDI_OFTPClient Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLAcceptServerCertEffectiveDate();

Procedural Interface

ipworksedi_oftpclient_get($res, 78 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExpirationDate Property (IPWorksEDI_OFTPClient Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLAcceptServerCertExpirationDate();

Procedural Interface

ipworksedi_oftpclient_get($res, 79 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLAcceptServerCertExtendedKeyUsage Property (IPWorksEDI_OFTPClient Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLAcceptServerCertExtendedKeyUsage();

Procedural Interface

ipworksedi_oftpclient_get($res, 80 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprint Property (IPWorksEDI_OFTPClient Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprint();

Procedural Interface

ipworksedi_oftpclient_get($res, 81 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA1 Property (IPWorksEDI_OFTPClient Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA1();

Procedural Interface

ipworksedi_oftpclient_get($res, 82 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLAcceptServerCertFingerprintSHA256 Property (IPWorksEDI_OFTPClient Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertFingerprintSHA256();

Procedural Interface

ipworksedi_oftpclient_get($res, 83 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLAcceptServerCertIssuer Property (IPWorksEDI_OFTPClient Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertIssuer();

Procedural Interface

ipworksedi_oftpclient_get($res, 84 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKey Property (IPWorksEDI_OFTPClient Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKey();

Procedural Interface

ipworksedi_oftpclient_get($res, 85 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLAcceptServerCertPrivateKey may be available but not exportable. In this case, SSLAcceptServerCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLAcceptServerCertPrivateKeyAvailable Property (IPWorksEDI_OFTPClient Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_oftpclient_get($res, 86 );

Default Value

false

Remarks

Whether a SSLAcceptServerCertPrivateKey is available for the selected certificate. If SSLAcceptServerCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLAcceptServerCertPrivateKeyContainer Property (IPWorksEDI_OFTPClient Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLAcceptServerCertPrivateKeyContainer();

Procedural Interface

ipworksedi_oftpclient_get($res, 87 );

Default Value

''

Remarks

The name of the SSLAcceptServerCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKey Property (IPWorksEDI_OFTPClient Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKey();

Procedural Interface

ipworksedi_oftpclient_get($res, 88 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyAlgorithm Property (IPWorksEDI_OFTPClient Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_oftpclient_get($res, 89 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertPublicKeyLength Property (IPWorksEDI_OFTPClient Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLAcceptServerCertPublicKeyLength();

Procedural Interface

ipworksedi_oftpclient_get($res, 90 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertSerialNumber Property (IPWorksEDI_OFTPClient Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLAcceptServerCertSerialNumber();

Procedural Interface

ipworksedi_oftpclient_get($res, 91 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLAcceptServerCertSignatureAlgorithm Property (IPWorksEDI_OFTPClient Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLAcceptServerCertSignatureAlgorithm();

Procedural Interface

ipworksedi_oftpclient_get($res, 92 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLAcceptServerCertStore Property (IPWorksEDI_OFTPClient Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStore();
public function setSSLAcceptServerCertStore($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 93 );
ipworksedi_oftpclient_set($res, 93, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLAcceptServerCertStoreType property denotes the type of the certificate store specified by SSLAcceptServerCertStore. If the store is password-protected, specify the password in SSLAcceptServerCertStorePassword.

SSLAcceptServerCertStore is used in conjunction with the SSLAcceptServerCertSubject property to specify client certificates. If SSLAcceptServerCertStore has a value, and SSLAcceptServerCertSubject or SSLAcceptServerCertEncoded is set, a search for a certificate is initiated. Please see the SSLAcceptServerCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLAcceptServerCertStorePassword Property (IPWorksEDI_OFTPClient Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLAcceptServerCertStorePassword();
public function setSSLAcceptServerCertStorePassword($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 94 );
ipworksedi_oftpclient_set($res, 94, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLAcceptServerCertStoreType Property (IPWorksEDI_OFTPClient Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLAcceptServerCertStoreType();
public function setSSLAcceptServerCertStoreType($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 95 );
ipworksedi_oftpclient_set($res, 95, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLAcceptServerCertSubjectAltNames Property (IPWorksEDI_OFTPClient Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertSubjectAltNames();

Procedural Interface

ipworksedi_oftpclient_get($res, 96 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintMD5 Property (IPWorksEDI_OFTPClient Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintMD5();

Procedural Interface

ipworksedi_oftpclient_get($res, 97 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA1 Property (IPWorksEDI_OFTPClient Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA1();

Procedural Interface

ipworksedi_oftpclient_get($res, 98 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertThumbprintSHA256 Property (IPWorksEDI_OFTPClient Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertThumbprintSHA256();

Procedural Interface

ipworksedi_oftpclient_get($res, 99 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsage Property (IPWorksEDI_OFTPClient Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLAcceptServerCertUsage();

Procedural Interface

ipworksedi_oftpclient_get($res, 100 );

Default Value

''

Remarks

The text description of SSLAcceptServerCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLAcceptServerCertUsageFlags Property (IPWorksEDI_OFTPClient Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLAcceptServerCertUsageFlags();

Procedural Interface

ipworksedi_oftpclient_get($res, 101 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLAcceptServerCertUsageFlags is a combination of the following flags:

Please see the SSLAcceptServerCertUsage property for a text representation of SSLAcceptServerCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLAcceptServerCertVersion Property (IPWorksEDI_OFTPClient Class)

The certificate's version number.

Object Oriented Interface

public function getSSLAcceptServerCertVersion();

Procedural Interface

ipworksedi_oftpclient_get($res, 102 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLAcceptServerCertSubject Property (IPWorksEDI_OFTPClient Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLAcceptServerCertSubject();
public function setSSLAcceptServerCertSubject($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 103 );
ipworksedi_oftpclient_set($res, 103, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLAcceptServerCertEncoded Property (IPWorksEDI_OFTPClient Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLAcceptServerCertEncoded();
public function setSSLAcceptServerCertEncoded($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 104 );
ipworksedi_oftpclient_set($res, 104, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLAcceptServerCertStore and SSLAcceptServerCertSubject properties also may be used to specify a certificate.

When SSLAcceptServerCertEncoded is set, a search is initiated in the current SSLAcceptServerCertStore for the private key of the certificate. If the key is found, SSLAcceptServerCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLAcceptServerCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

SSLCertEffectiveDate Property (IPWorksEDI_OFTPClient Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksedi_oftpclient_get($res, 105 );

Default Value

''

Remarks

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

This property is read-only.

Data Type

String

SSLCertExpirationDate Property (IPWorksEDI_OFTPClient Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksedi_oftpclient_get($res, 106 );

Default Value

''

Remarks

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

This property is read-only.

Data Type

String

SSLCertExtendedKeyUsage Property (IPWorksEDI_OFTPClient Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksedi_oftpclient_get($res, 107 );

Default Value

''

Remarks

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

This property is read-only.

Data Type

String

SSLCertFingerprint Property (IPWorksEDI_OFTPClient Class)

The hex-encoded, 16-byte MD5 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksedi_oftpclient_get($res, 108 );

Default Value

''

Remarks

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02

This property is read-only.

Data Type

String

SSLCertFingerprintSHA1 Property (IPWorksEDI_OFTPClient Class)

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksedi_oftpclient_get($res, 109 );

Default Value

''

Remarks

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84

This property is read-only.

Data Type

String

SSLCertFingerprintSHA256 Property (IPWorksEDI_OFTPClient Class)

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate.

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksedi_oftpclient_get($res, 110 );

Default Value

''

Remarks

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: 6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53

This property is read-only.

Data Type

String

SSLCertIssuer Property (IPWorksEDI_OFTPClient Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksedi_oftpclient_get($res, 111 );

Default Value

''

Remarks

The issuer of the certificate. This property contains a string representation of the name of the issuing authority for the certificate.

This property is read-only.

Data Type

String

SSLCertPrivateKey Property (IPWorksEDI_OFTPClient Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksedi_oftpclient_get($res, 112 );

Default Value

''

Remarks

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

Note: The SSLCertPrivateKey may be available but not exportable. In this case, SSLCertPrivateKey returns an empty string.

This property is read-only.

Data Type

String

SSLCertPrivateKeyAvailable Property (IPWorksEDI_OFTPClient Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_oftpclient_get($res, 113 );

Default Value

false

Remarks

Whether a SSLCertPrivateKey is available for the selected certificate. If SSLCertPrivateKeyAvailable is True, the certificate may be used for authentication purposes (e.g., server authentication).

This property is read-only.

Data Type

Boolean

SSLCertPrivateKeyContainer Property (IPWorksEDI_OFTPClient Class)

The name of the PrivateKey container for the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksedi_oftpclient_get($res, 114 );

Default Value

''

Remarks

The name of the SSLCertPrivateKey container for the certificate (if available). This functionality is available only on Windows platforms.

This property is read-only.

Data Type

String

SSLCertPublicKey Property (IPWorksEDI_OFTPClient Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksedi_oftpclient_get($res, 115 );

Default Value

''

Remarks

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

This property is read-only.

Data Type

String

SSLCertPublicKeyAlgorithm Property (IPWorksEDI_OFTPClient Class)

The textual description of the certificate's public key algorithm.

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_oftpclient_get($res, 116 );

Default Value

''

Remarks

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertPublicKeyLength Property (IPWorksEDI_OFTPClient Class)

The length of the certificate's public key (in bits).

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksedi_oftpclient_get($res, 117 );

Default Value

0

Remarks

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

This property is read-only.

Data Type

Integer

SSLCertSerialNumber Property (IPWorksEDI_OFTPClient Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksedi_oftpclient_get($res, 118 );

Default Value

''

Remarks

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

This property is read-only.

Data Type

String

SSLCertSignatureAlgorithm Property (IPWorksEDI_OFTPClient Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksedi_oftpclient_get($res, 119 );

Default Value

''

Remarks

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

This property is read-only.

Data Type

String

SSLCertStore Property (IPWorksEDI_OFTPClient Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getSSLCertStore();
public function setSSLCertStore($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 120 );
ipworksedi_oftpclient_set($res, 120, $value );

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The SSLCertStoreType property denotes the type of the certificate store specified by SSLCertStore. If the store is password-protected, specify the password in SSLCertStorePassword.

SSLCertStore is used in conjunction with the SSLCertSubject property to specify client certificates. If SSLCertStore has a value, and SSLCertSubject or SSLCertEncoded is set, a search for a certificate is initiated. Please see the SSLCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

Data Type

Binary String

SSLCertStorePassword Property (IPWorksEDI_OFTPClient Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getSSLCertStorePassword();
public function setSSLCertStorePassword($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 121 );
ipworksedi_oftpclient_set($res, 121, $value );

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Data Type

String

SSLCertStoreType Property (IPWorksEDI_OFTPClient Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getSSLCertStoreType();
public function setSSLCertStoreType($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 122 );
ipworksedi_oftpclient_set($res, 122, $value );

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

Data Type

Integer

SSLCertSubjectAltNames Property (IPWorksEDI_OFTPClient Class)

Comma-separated lists of alternative subject names for the certificate.

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksedi_oftpclient_get($res, 123 );

Default Value

''

Remarks

Comma-separated lists of alternative subject names for the certificate.

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksEDI_OFTPClient Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksedi_oftpclient_get($res, 124 );

Default Value

''

Remarks

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA1 Property (IPWorksEDI_OFTPClient Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksedi_oftpclient_get($res, 125 );

Default Value

''

Remarks

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertThumbprintSHA256 Property (IPWorksEDI_OFTPClient Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksedi_oftpclient_get($res, 126 );

Default Value

''

Remarks

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

This property is read-only.

Data Type

String

SSLCertUsage Property (IPWorksEDI_OFTPClient Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksedi_oftpclient_get($res, 127 );

Default Value

''

Remarks

The text description of SSLCertUsageFlags.

This value will be one or more of the following strings and will be separated by commas:

• Digital Signature
• Non-Repudiation
• Key Encipherment
• Data Encipherment
• Key Agreement
• Certificate Signing
• CRL Signing
• Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

This property is read-only.

Data Type

String

SSLCertUsageFlags Property (IPWorksEDI_OFTPClient Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksedi_oftpclient_get($res, 128 );

Default Value

0

Remarks

The flags that show intended use for the certificate. The value of SSLCertUsageFlags is a combination of the following flags:

Please see the SSLCertUsage property for a text representation of SSLCertUsageFlags.

This functionality currently is not available when the provider is OpenSSL.

This property is read-only.

Data Type

Integer

SSLCertVersion Property (IPWorksEDI_OFTPClient Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksedi_oftpclient_get($res, 129 );

Default Value

''

Remarks

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

This property is read-only.

Data Type

String

SSLCertSubject Property (IPWorksEDI_OFTPClient Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getSSLCertSubject();
public function setSSLCertSubject($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 130 );
ipworksedi_oftpclient_set($res, 130, $value );

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

Data Type

String

SSLCertEncoded Property (IPWorksEDI_OFTPClient Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getSSLCertEncoded();
public function setSSLCertEncoded($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 131 );
ipworksedi_oftpclient_set($res, 131, $value );

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The SSLCertStore and SSLCertSubject properties also may be used to specify a certificate.

When SSLCertEncoded is set, a search is initiated in the current SSLCertStore for the private key of the certificate. If the key is found, SSLCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SSLCertSubject is set to an empty string.

This property is not available at design time.

Data Type

Binary String

Timeout Property (IPWorksEDI_OFTPClient Class)

This property includes the timeout for the class.

Object Oriented Interface

public function getTimeout();
public function setTimeout($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 132 );
ipworksedi_oftpclient_set($res, 132, $value );

Default Value

60

Remarks

If the Timeout property is set to 0, all operations return immediately, potentially failing with a WOULDBLOCK error if data cannot be sent immediately.

If Timeout is set to a positive value, data is sent in a blocking manner and the class will wait for the operation to complete before returning control. The class will handle any potential WOULDBLOCK errors internally and automatically retry the operation for a maximum of Timeout seconds.

The class will use DoEvents to enter an efficient wait loop during any potential waiting period, making sure that all system events are processed immediately as they arrive. This ensures that the host application does not freeze and remains responsive.

If Timeout expires, and the operation is not yet complete, the class fails with an error.

Note: By default, all timeouts are inactivity timeouts, that is, the timeout period is extended by Timeout seconds when any amount of data is successfully sent or received.

The default value for the Timeout property is 60 seconds.

Data Type

Integer

TrustedCertCount Property (IPWorksEDI_OFTPClient Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

public function getTrustedCertCount();
public function setTrustedCertCount($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 133 );
ipworksedi_oftpclient_set($res, 133, $value );

Default Value

0

Remarks

This property controls the size of the following arrays:

• TrustedCertEncoded
• TrustedCertStore
• TrustedCertStorePassword
• TrustedCertStoreType
• TrustedCertSubject

The array indices start at 0 and end at TrustedCertCount - 1.

This property is not available at design time.

Data Type

Integer

TrustedCertStore Property (IPWorksEDI_OFTPClient Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

public function getTrustedCertStore($trustedcertindex);
public function setTrustedCertStore($trustedcertindex, $value);

Procedural Interface

ipworksedi_oftpclient_get($res, 149 , $trustedcertindex);
ipworksedi_oftpclient_set($res, 149, $value , $trustedcertindex);

Default Value

'MY'

Remarks

The name of the certificate store for the client certificate.

The TrustedCertStoreType property denotes the type of the certificate store specified by TrustedCertStore. If the store is password-protected, specify the password in TrustedCertStorePassword.

TrustedCertStore is used in conjunction with the TrustedCertSubject property to specify client certificates. If TrustedCertStore has a value, and TrustedCertSubject or TrustedCertEncoded is set, a search for a certificate is initiated. Please see the TrustedCertSubject property for details.

Designations of certificate stores are platform dependent.

The following designations are the most common User and Machine certificate stores in Windows:

When the certificate store type is cstPFXFile, this property must be set to the name of the file. When the type is cstPFXBlob, the property must be set to the binary contents of a PFX file (i.e., PKCS#12 certificate store).

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Binary String

TrustedCertStorePassword Property (IPWorksEDI_OFTPClient Class)

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

Object Oriented Interface

public function getTrustedCertStorePassword($trustedcertindex);
public function setTrustedCertStorePassword($trustedcertindex, $value);

Procedural Interface

ipworksedi_oftpclient_get($res, 150 , $trustedcertindex);
ipworksedi_oftpclient_set($res, 150, $value , $trustedcertindex);

Default Value

''

Remarks

If the type of certificate store requires a password, this property is used to specify the password needed to open the certificate store.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

String

TrustedCertStoreType Property (IPWorksEDI_OFTPClient Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getTrustedCertStoreType($trustedcertindex);
public function setTrustedCertStoreType($trustedcertindex, $value);

Procedural Interface

ipworksedi_oftpclient_get($res, 151 , $trustedcertindex);
ipworksedi_oftpclient_set($res, 151, $value , $trustedcertindex);

Default Value

0

Remarks

The type of certificate store for this certificate.

The class supports both public and private keys in a variety of formats. When the cstAuto value is used, the class will automatically determine the type. This property can take one of the following values:

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Integer

TrustedCertSubject Property (IPWorksEDI_OFTPClient Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

public function getTrustedCertSubject($trustedcertindex);
public function setTrustedCertSubject($trustedcertindex, $value);

Procedural Interface

ipworksedi_oftpclient_get($res, 159 , $trustedcertindex);
ipworksedi_oftpclient_set($res, 159, $value , $trustedcertindex);

Default Value

''

Remarks

The subject of the certificate used for client authentication.

This property must be set after all other certificate properties are set. When this property is set, a search is performed in the current certificate store to locate a certificate with a matching subject.

If a matching certificate is found, the property is set to the full subject of the matching certificate.

If an exact match is not found, the store is searched for subjects containing the value of the property.

If a match is still not found, the property is set to an empty string, and no certificate is selected.

The special value "*" picks a random certificate in the certificate store.

The certificate subject is a comma-separated list of distinguished name fields and values. For instance, "CN=www.server.com, OU=test, C=US, E=support@nsoftware.com". Common fields and their meanings are as follows:

If a field value contains a comma, it must be quoted.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

String

TrustedCertEncoded Property (IPWorksEDI_OFTPClient Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

public function getTrustedCertEncoded($trustedcertindex);
public function setTrustedCertEncoded($trustedcertindex, $value);

Procedural Interface

ipworksedi_oftpclient_get($res, 160 , $trustedcertindex);
ipworksedi_oftpclient_set($res, 160, $value , $trustedcertindex);

Default Value

''

Remarks

The certificate (PEM/Base64 encoded). This property is used to assign a specific certificate. The TrustedCertStore and TrustedCertSubject properties also may be used to specify a certificate.

When TrustedCertEncoded is set, a search is initiated in the current TrustedCertStore for the private key of the certificate. If the key is found, TrustedCertSubject is updated to reflect the full subject of the selected certificate; otherwise, TrustedCertSubject is set to an empty string.

The $trustedcertindex parameter specifies the index of the item in the array. The size of the array is controlled by the TrustedCertCount property.

This property is not available at design time.

Data Type

Binary String

UseSSL Property (IPWorksEDI_OFTPClient Class)

Use SSL to access the RemoteHost .

Object Oriented Interface

public function getUseSSL();
public function setUseSSL($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 161 );
ipworksedi_oftpclient_set($res, 161, $value );

Default Value

false

Remarks

Use this property to determine whether the class uses SSL to connect with the RemoteHost.

This property is only valid when using version 2.0 of the protocol.

Note: Setting this property to True will set RemotePort to 6619.

This property is not available at design time.

Data Type

Boolean

Version Property (IPWorksEDI_OFTPClient Class)

Which version of the OFTP protocol the class is using.

Object Oriented Interface

public function getVersion();
public function setVersion($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 162 );
ipworksedi_oftpclient_set($res, 162, $value );

Default Value

3

Remarks

This property specifies which version of the OFTP protocol to use. Possible values are:

The default value is oftpVer20 (Version 2.0).

Note: Version 2.0 (oftpVer20) of the protocol must be used when using security functions. The following properties are only applicable when using Version 2.0:

• UseSSL
• SecureAuthentication
• VirtualFileSecurityLevel
• Compress

Data Type

Integer

VirtualFileDate Property (IPWorksEDI_OFTPClient Class)

The date/time stamp for the virtual file.

Object Oriented Interface

public function getVirtualFileDate();
public function setVirtualFileDate($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 163 );
ipworksedi_oftpclient_set($res, 163, $value );

Default Value

''

Remarks

Set this to the date/time stamp for the virtual file before sending. If this is not set when sending a file, the current date/time will be used. This property will accept various date formats, but will return the following format only: "MM/dd/yyyy HH:mm:ss".

Supported date formats:

• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• d MMM yy HH:mm:ss zzz
• d MMM yyyy HH:mm:ss zzz
• dd-MMM-yyyy HH:mm:ss
• ddd, d MMM yy HH:mm:ss zz
• ddd, d MMM yyyy HH:mm:ss zz
• ddd, d MMM yy HH:mm:ss zzz
• ddd, d MMM yyyy HH:mm:ss zzz
• ddd, d MMM yy HH:mm:ss z
• ddd, d MMM yyyy HH:mm:ss z
• ddd, dd MMM yyyy HH:mm:ss 'GMT'
• dddd, MMMM dd, yyyy h:mm:ss tt
• dddd, MMMM dd yyyy h:mm tt
• yyMMddHHmmssZ
• yyyyMMddHHmmssZ
• yyMMddHHmmsszzzz
• yyyyMMddHHmmsszzzz
• yyyyMMddHHmmssffff
• MM/dd/yyyy HH:mm:ss

Data Type

String

VirtualFileFormat Property (IPWorksEDI_OFTPClient Class)

The structure of the outgoing file.

Object Oriented Interface

public function getVirtualFileFormat();
public function setVirtualFileFormat($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 164 );
ipworksedi_oftpclient_set($res, 164, $value );

Default Value

0

Remarks

The following values are valid file formats for outgoing virtual files:

Note: When either VirtualFileSecurityLevel has been set to a value other than slNone or Compress has been set to true, all files become ffUnstructured except ffVariable files.

This property is not available at design time.

Data Type

Integer

VirtualFileSecurityLevel Property (IPWorksEDI_OFTPClient Class)

The level of security for the file.

Object Oriented Interface

public function getVirtualFileSecurityLevel();
public function setVirtualFileSecurityLevel($value);

Procedural Interface

ipworksedi_oftpclient_get($res, 165 );
ipworksedi_oftpclient_set($res, 165, $value );

Default Value

0

Remarks

When sending files, set this value to the level of security for the next virtual file to send. After receiving a file, this will be set to the level of security of the last file received.

When encrypting a file, RecipientCert must be set, and when signing a file, the Certificate must be set.

The file will be processed to a temporary file before being sent.

This is only valid for version 2.0 of the protocol.

This property is not available at design time.

Data Type

Integer

ChangeDirection Method (IPWorksEDI_OFTPClient Class)

Sends a Change Direction (CD) command.

Object Oriented Interface

public function doChangeDirection();

Procedural Interface

ipworksedi_oftpclient_do_changedirection($res);

Remarks

This method sends a Change Direction (CD) command to the remote host when called. In normal operation this should not be used. This should only be used if a condition arises where you must manually change the speaker when communicating with the remote host.

Config Method (IPWorksEDI_OFTPClient Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksedi_oftpclient_do_config($res, $configurationstring);

Remarks

Config is a generic method available in every class. It is used to set and retrieve configuration settings for the class.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

Connect Method (IPWorksEDI_OFTPClient Class)

This method connects to the FTP server without logging in.

Object Oriented Interface

public function doConnect();

Procedural Interface

ipworksedi_oftpclient_do_connect($res);

Remarks

This method establishes a connection with the RemoteHost but does not log in. In most cases, it is recommended to use the Logon method, which will both establish a connection and log in to the server.

This method may be useful in cases in which it is desirable to separate the connection and logon operations, for instance, confirming that a host is available by first creating the connection.

Disconnect Method (IPWorksEDI_OFTPClient Class)

This method disconnects from the server without first logging off.

Object Oriented Interface

public function doDisconnect();

Procedural Interface

ipworksedi_oftpclient_do_disconnect($res);

Remarks

This method immediately disconnects from the server without first logging off.

In most cases, the Logoff method should be used to log off and disconnect from the server. Call the Disconnect method in cases in which it is desirable to immediately disconnect without first logging off.

DoEvents Method (IPWorksEDI_OFTPClient Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksedi_oftpclient_do_doevents($res);

Remarks

When DoEvents is called, the class processes any available events. If no events are available, it waits for a preset period of time, and then returns.

ExchangeCertificate Method (IPWorksEDI_OFTPClient Class)

Exchange a certificate with the remote host.

Object Oriented Interface

public function doExchangeCertificate($certificatestore, $certificateexchangetype);

Procedural Interface

ipworksedi_oftpclient_do_exchangecertificate($res, $certificatestore, $certificateexchangetype);

Remarks

If the remote host supports the certificate exchange feature of OFTP 2.0 this method may be used to send and/or request certificates.

The CertificateStore parameter specifies the location of the certificate to be exchanged. In most cases this will be the path to a .cer file on disk. If the certificate is in another format or is installed to the Windows certificate store please see ExchangeCertStoreType and ExchangeCertSubject for more information.

The CertificateExchangeType parameter determines the type of request. Possible values are:

When the remote host sends a certificate to the class the received certificate will be provided through the CertificateReceived event.

ImportTrustedCerts Method (IPWorksEDI_OFTPClient Class)

Imports a list of trusted CA certificates.

Object Oriented Interface

public function doImportTrustedCerts();

Procedural Interface

ipworksedi_oftpclient_do_importtrustedcerts($res);

Remarks

When ImportTrustedCerts is called the class will import the CA certificates from the source specified by TrustedCertsData into the TrustedCerts collection.

The class will then validate the trust of certificates when they are loaded.

If trusted CA certificates are not imported no validation will occur (default).

See also FailOnUntrustedCert.

Interrupt Method (IPWorksEDI_OFTPClient Class)

This method interrupts the current action.

Object Oriented Interface

public function doInterrupt();

Procedural Interface

ipworksedi_oftpclient_do_interrupt($res);

Remarks

This method interrupts the current action. If you use SendFile to upload a file, the class will run synchronously until the upload is completed. This method will allow you to stop the file from uploading without disconnecting from the host.

Logoff Method (IPWorksEDI_OFTPClient Class)

Logoff from the OFTP server.

Object Oriented Interface

public function doLogoff();

Procedural Interface

ipworksedi_oftpclient_do_logoff($res);

Remarks

Logoff from the OFTP server. If that fails, the connection is terminated by the local host.

Logon Method (IPWorksEDI_OFTPClient Class)

Logon to the OFTP RemoteHost using the current client credentials.

Object Oriented Interface

public function doLogon();

Procedural Interface

ipworksedi_oftpclient_do_logon($res);

Remarks

Logon to the OFTP server using the current ClientSSIDCode, ClientSFIDCode, and ClientPassword. The component will also check the corresponding server credentials, ServerSSIDCode, ServerSFIDCode, and ServerPassword.

ReceiveFiles Method (IPWorksEDI_OFTPClient Class)

Receive any files queued to be sent from the server.

Object Oriented Interface

public function doReceiveFiles();

Procedural Interface

ipworksedi_oftpclient_do_receivefiles($res);

Remarks

This method connects to the server, and receives any files the server has in its outgoing queue to this particular partner. The files are downloaded to the directory specified by the DownloadDirectory property.

Reset Method (IPWorksEDI_OFTPClient Class)

Resets the state of the control.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_oftpclient_do_reset($res);

Remarks

Reset resets the state of the class. All properties will be set to their default values.

SendEndResponse Method (IPWorksEDI_OFTPClient Class)

Sends an EERP/NERP asynchronously.

Object Oriented Interface

public function doSendEndResponse($virtualfilename, $virtualfiledate, $destination, $originator, $creator, $reasoncode, $reasontext, $filehash, $signature);

Procedural Interface

ipworksedi_oftpclient_do_sendendresponse($res, $virtualfilename, $virtualfiledate, $destination, $originator, $creator, $reasoncode, $reasontext, $filehash, $signature);

Remarks

This method sends an EERP/NERP. By default the class will automatically respond with an EERP/NERP when receiving a file. To respond asynchronously instead this method may be used.

To respond asynchronously first set the SendEndResponse parameter of the EndTransfer event to False. This instructs the class to not send a response automatically. Within the EndTransfer event you must also save the values that are required parameters for this method. This includes FileHash, VirtualFileDate, and VirtualFileName. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

Destination should be set to the SFID of the remote host.

Originator should be set to the SFID of the local system. In the case that the class is being used as part of a gateway process to forward traffic to another OFTP host this may be set to the SFID of that host instead.

Creator should be set to the SFID of the local system.

Signature is only applicable if the application is acting as a routing application. In all other cases this should be set to empty string. In the case where the application is acting as a routing application the end response is being forwarded to another entity for processing. The Signature should be set to the value received in the EndResponse event (if populated).

ReasonCode and ReasonText are used to specify error information. If ReasonCode is set to 0 the class will send an EERP. If ReasonCode is set to any non-zero value the class will send a NERP. Common values are:

SendFile Method (IPWorksEDI_OFTPClient Class)

Send the specified file to the server.

Object Oriented Interface

public function doSendFile($localfile, $virtualfilename);

Procedural Interface

ipworksedi_oftpclient_do_sendfile($res, $localfile, $virtualfilename);

Remarks

This method connects to the server, and uploads the specified file to the server. The LocalFile parameter contains the path and name of the file to send to the server. The VirtualFileName parameter contains the virtual file name of the file being sent. If this parameter is left as an empty string, the component will use the filename contained in the LocalFile parameter by default.

Note: When SetUploadStream has been called with a valid input stream, the data will be uploaded from there instead of the LocalFile.

ValidateCert Method (IPWorksEDI_OFTPClient Class)

Validates the certificate with private key.

Object Oriented Interface

public function doValidateCert();

Procedural Interface

ipworksedi_oftpclient_do_validatecert($res);

Remarks

This method optionally validates the certificate specified by Certificate. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call ImportTrustedCerts to load the trusted certification information.

When this method is called the class:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

ValidateRecipientCert Method (IPWorksEDI_OFTPClient Class)

Validates the recipient certificate.

Object Oriented Interface

public function doValidateRecipientCert();

Procedural Interface

ipworksedi_oftpclient_do_validaterecipientcert($res);

Remarks

This method optionally validates the certificate specified by RecipientCert. It is not required to validate the certificate from a technical perspective, but may be desired to ensure the recipient's certificate is valid and issued by a trusted authority.

Before calling this method call ImportTrustedCerts to load the trusted certification information.

When this method is called the class:

• Validates the certificate has not expired
• Validates the certificate was issued by a CA in the TrustedCerts collection. If the certificate is self-signed this step is skipped.
• Validates the certificate has not been revoked. Note that the revocation check will only make use of the CRL distribution point identified in the certificate's extension. If the certificate does not contain a CRL distribution point extension this step is skipped.

AcceptFile Event (IPWorksEDI_OFTPClient Class)

Fired when the client receives a file.

Object Oriented Interface

public function fireAcceptFile($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 1, array($this, 'fireAcceptFile'));

Parameter List

 'virtualfilename'
 'virtualfiledate'
 'destination'
 'originator'
 'accept'
 'filename'
 'overwrite'
 'errorcode'
 'errordescription'

Remarks

This event controls the behavior when the client receives a file.

VirtualFileName holds the name of the file being received.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination identifies the receiver (SFID) code in the send file request. If the file was intended for this server this will match the value in ServerSFIDCode

Originator identifies the sender (SFID) code in the send file request.

Accept is true by default, and must be set to False in order to reject the file.

Filename will be populated with the full path and filename that will be written. It may be changed within this event to specify a new location. The Filename is determined by combining the path specified in OFTPConnectionDownloadDirectory and the name received from the client.

Overwrite is false by default, but may be set to true to overwrite existing files on disk.

ErrorCode controls the error returned to the client when Accept is set to False. If this is not set the class will use a value of 99 to indicate a general error.

ErrorDescription may also be set to include an error message. If this is not set the class will automatically include an error message based on the ErrorCode specified. Common error codes and their corresponding error messages are listed below.

CertificateReceived Event (IPWorksEDI_OFTPClient Class)

Fired when a certificate is received from the remote host.

Object Oriented Interface

public function fireCertificateReceived($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 2, array($this, 'fireCertificateReceived'));

Parameter List

 'certificatefilename'
 'certificateexchangetype'

Remarks

This event provides information about the certificate file that was sent by the remote host.

When the remote host sends a certificate using the Certificate Exchange feature of OFTP 2.0, this event provides information about it. The certificate file will be written to the DownloadDirectory. After the file is written to DownloadDirectory this event will fire.

The CertificateFilemame parameter holds the filename of the received certificate.

The CertificateExchangeType parameter identifies the type of request associated with the certificate. Possible values are:

EndResponse Event (IPWorksEDI_OFTPClient Class)

Fired every time an end response is received from the server.

Object Oriented Interface

public function fireEndResponse($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 3, array($this, 'fireEndResponse'));

Parameter List

 'virtualfilename'
 'virtualfiledate'
 'destination'
 'originator'
 'creator'
 'reasoncode'
 'reasontext'
 'filehash'
 'signature'
 'direction'

Remarks

This event contains information received from an either an End-To-End Response or a Negative End Response received from the server.

An End-To-End Response will not contain values for the ReasonCode, ReasonText, or Creator parameters.

VirtualFileName specifies the name of the file.

VirtualFileDate holds the VirtualFileDate value in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Destination is the SFID of the destination system (this class).

Originator identifies the system that originated the end response. This is typically the same as Creator and holds the remote system's SFID.

Creator is the SFID of the remote system.

Direction specifies whether the end response is being received or sent. Possible values are:

By default the class will only fire this event for received end responses. To configure the class to fire the event for both send and received end responses set FireEndResponseOnSend to True.

FileHash is populated if the OFTP Version is 2.0 and a signed receipt was originally requested. FileHash may also be specified with the expected value in the case where an asynchronous EndResponse is received. The expected value may be obtained from the EndTransfer event when initially sending the file.

Signature is only applicable when the OFTP version is 2.0 and the application is acting as a routing application where the end response will be forwarded on to another entity. In this case Signature will be populated if the end response is signed. This should be stored and supplied when forwarding the response with the SendEndResponse method.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

EndTransfer Event (IPWorksEDI_OFTPClient Class)

Fired when a file finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 4, array($this, 'fireEndTransfer'));

Parameter List

 'direction'
 'localfile'
 'virtualfilename'
 'virtualfiledate'
 'destination'
 'originator'
 'reasoncode'
 'reasontext'
 'filesize'
 'filehash'
 'sendendresponse'

Remarks

The EndTransfer event is fired when a file is sent or received by the class.

The FileSize parameter gives the size of the file that was sent or received.

The Direction parameter shows whether the client or the server is sending the data.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

SendEndResponse indicates whether the EERP/NERP for this request should be sent synchronously or asynchronously. When this parameter is True (default) the class will automatically respond with an EERP/NERP synchronously. To respond asynchronously set this parameter to False. You may then use the SendEndResponse method to send the response at a later time. See SendEndResponse for more details. Note: VirtualFileDateFormat must be set to a format that includes the necessary level of accuracy.

FileHash holds the hash of the file being transmitted. This is only applicable when the OFTP version is 2.0 and the sender requested a signed receipt. When receiving files this value should be saved if you wish to respond asynchronously using SendEndResponse. See SendEndResponse for more details.

LocalFile holds the full path to the file that will be written.

ReasonCode and ReasonText identify the error if a Negative End Response (NERP) was received. A value of 0 indicates there was no an error and the response is an End-To-End Response (EERP). Common values are:

Error Event (IPWorksEDI_OFTPClient Class)

Fired when information is available about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 5, array($this, 'fireError'));

Parameter List

 'errorcode'
 'description'

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the class fails with an error.

The ErrorCode parameter contains an error code, and the Description parameter contains a textual description of the error. For a list of valid error codes and their descriptions, please refer to the Error Codes section.

Log Event (IPWorksEDI_OFTPClient Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 6, array($this, 'fireLog'));

Parameter List

 'loglevel'
 'message'
 'logtype'

Remarks

This event fires once for each log message generated by the class. The verbosity is controlled by the LogLevel setting.

LogLevel indicates the level of message. Possible values are:

Message is the log entry.

LogType identifies the type of log entry. Possible values are:

• "Info"
• "OFTP"

PITrail Event (IPWorksEDI_OFTPClient Class)

Fired when any protocol level communication occurs.

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 7, array($this, 'firePITrail'));

Parameter List

 'direction'
 'data'
 'commandid'
 'commanddescription'

Remarks

This event provides information about the protocol level communication between the client and server.

The Direction parameter specifies who sent the command.

The CommandId and CommandDescription parameters specify which command was sent. The table below shows possible values.

The Data parameter contains the raw OFTP packet.

SSLServerAuthentication Event (IPWorksEDI_OFTPClient Class)

Fired after the server presents its certificate to the client.

Object Oriented Interface

public function fireSSLServerAuthentication($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 8, array($this, 'fireSSLServerAuthentication'));

Parameter List

 'certencoded'
 'certsubject'
 'certissuer'
 'status'
 'accept'

Remarks

During this event, the client can decide whether or not to continue with the connection process. The Accept parameter is a recommendation on whether to continue or close the connection. This is just a suggestion: application software must use its own logic to determine whether or not to continue.

When Accept is False, Status shows why the verification failed (otherwise, Status contains the string OK). If it is decided to continue, you can override and accept the certificate by setting the Accept parameter to True.

SSLStatus Event (IPWorksEDI_OFTPClient Class)

Fired when secure connection progress messages are available.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 9, array($this, 'fireSSLStatus'));

Parameter List

 'message'

Remarks

The event is fired for informational and logging purposes only. This event tracks the progress of the connection.

StartTransfer Event (IPWorksEDI_OFTPClient Class)

Fired when a document starts transferring.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 10, array($this, 'fireStartTransfer'));

Parameter List

 'direction'
 'localfile'
 'virtualfilename'
 'virtualfiledate'
 'destination'
 'originator'

Remarks

This event fires when a file transfer begins.

Direction specifies if the client or server sent the file.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

Transfer Event (IPWorksEDI_OFTPClient Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_oftpclient_register_callback($res, 11, array($this, 'fireTransfer'));

Parameter List

 'direction'
 'localfile'
 'virtualfilename'
 'virtualfiledate'
 'destination'
 'originator'
 'bytestransferred'
 'text'

Remarks

The Text parameter contains the portion of the document text being retrieved. It is empty if data is being posted to the server.

The BytesTransferred parameter contains the number of bytes transferred in this Direction since the beginning of the document text.

The Direction parameter shows whether the client (0) or the server (1) is sending the data.

VirtualFileName holds the filename.

VirtualFileDate holds the date associated with the file in the format specified by VirtualFileDateFormat. The default value is "MM/dd/yyyy HH:mm:ss".

Originator identifies the sender (SFID) code in the send file request.

Destination identifies the receiver (SFID) code in the send file request.

LocalFile holds the full path to the file that will be written.

Config Settings (OFTPClient Class)

The class accepts one or more of the following configuration settings. Configuration settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

OFTPClient Config Settings

Base Config Settings

Trappable Errors (OFTPClient Class)

OFTPClient Errors

TCPClient Errors

TCP/IP Errors