OFTPServer Class

Properties   Methods   Events   Config Settings   Errors  

The OFTPServer class implements the server side of the Odette File Transfer Protocol.

Class Name

IPWorksEDI_OFTPServer

Procedural Interface

 ipworksedi_oftpserver_open();
 ipworksedi_oftpserver_close($res);
 ipworksedi_oftpserver_register_callback($res, $id, $function);
 ipworksedi_oftpserver_get_last_error($res);
 ipworksedi_oftpserver_get_last_error_code($res);
 ipworksedi_oftpserver_set($res, $id, $index, $value);
 ipworksedi_oftpserver_get($res, $id, $index);
 ipworksedi_oftpserver_do_changedirection($res, $connectionid);
 ipworksedi_oftpserver_do_config($res, $configurationstring);
 ipworksedi_oftpserver_do_disconnect($res, $connectionid);
 ipworksedi_oftpserver_do_doevents($res);
 ipworksedi_oftpserver_do_exchangecertificate($res, $connectionid, $clientsfidcode, $certificatestore, $certificateexchangetype);
 ipworksedi_oftpserver_do_importtrustedcerts($res);
 ipworksedi_oftpserver_do_interrupt($res, $connectionid);
 ipworksedi_oftpserver_do_logoff($res, $connectionid);
 ipworksedi_oftpserver_do_reset($res);
 ipworksedi_oftpserver_do_sendendresponse($res, $connectionid, $virtualfilename, $virtualfiledate, $destination, $originator, $creator, $reasoncode, $reasontext, $filehash, $signature);
 ipworksedi_oftpserver_do_sendfile($res, $connectionid, $clientsfidcode, $filename, $virtualfilename);
 ipworksedi_oftpserver_do_shutdown($res);
 ipworksedi_oftpserver_do_startlistening($res);
 ipworksedi_oftpserver_do_stoplistening($res);
 ipworksedi_oftpserver_do_validatecert($res);
 ipworksedi_oftpserver_do_validaterecipientcert($res, $connectionid);

Remarks

The OFTPServer component implements an OFTP server. It is a lightweight server that supports version 1.2, 1.3, 1.4, and 2.0 of OFTP.

Sending and Receiving Files

To use the class first decide if you will support TLS/SSL connections or not. If UseSSL is set to true, all clients will be expected to connect in TLS/SSL. If UseSSL is set to false (default), all clients are expected to connect in plaintext. If UseSSL is true, only clients that support Version 2.0 of the protocol can connect.

Once you have decided whether or not to support TLS/SSL, specify the port you wish the server to listen on in LocalPort. By default this value is 3305.

Next, specify values for ServerSSIDCode, ServerSFIDCode, ServerPassword.

Then set Listening to true to start listening for incoming requests.

When a client connects, you will have an opportunity to authenticate the client before continuing the connection. This is done when the AcceptConnection event fires. Within this event you can validate that the connecting client has access based on rules you determine. If you wish to reject the connection set the Accept parameter to false. Within this event you can also specify the directory to which files sent by the client to the server are saved. It is necessary to specify the directory within this event, as the client can start sending files as soon as the connection is complete. To specify the download directory set the OFTPConnectionDownloadDirectory property. For instance: oftpserver1.SetOFTPConnectionDownloadDirectory(e->ConnectionId, "C:\\Downloads");

When the connection is complete, the client may send files. If the client does send a file the AcceptFile event will fire and you will have the opportunity to reject the file by setting the Accept parameter of the event. In addition you will have a chance to change the filename by setting the Filename parameter if desired.

After the client has sent all the files it is configured to send, it will pass control to the server. At that time the ReadyToSend event will fire, and the OFTPConnectionReadyToSend property will be set to true. After this, you can either end the session with the client by calling Logoff or send files to the client. To send files to the client simply call the SendFile method with the specified parameters.

TLS/SSL Notes

When UseSSL is set to true, the server must be configured with a TLS/SSL certificate before it is started. Set SSLCert to a valid certificate with corresponding private key before setting Listening to true. This may be a PFX file, PEM key, or a certificate in a windows certificate store. See the SSLCert property for more information.

After SSLCert is set to a valid certificate and Listening is set to true, when a client connects the SSLStatus event will fire during the TLS/SSL negotiation. This is purely informational, if there is an error the Error event will fire.

If you want to require TLS/SSL client authentication, set SSLAuthenticateClients to true before setting Listening to true. This will force clients to present a certificate during TLS/SSL negotiation to be used for authorization. In this case the SSLClientAuthentication event will fire and you must set the Accept parameter within the event to true in order to accept the client's certificate and proceed with the connection.

Example Code

MyOftpserver server; server.SetServerSSIDCode("SERVERSSID"); server.SetServerSFIDCode("SERVERSFID"); server.SetServerPassword("SERVER"); server.SetListening(true); ... //Within the main loop of the application call server.DoEvents() in a loop //to process events. //When the ReadyToSend event fires the server can then send files to the client. To do this call the SendFile method. //Alternatively, monitor server.GetOFTPConnectionReadyToSend(<ConnectionId>) to determine when files can be sent. class MyOFTPServer : public OFTPServer { public: MyOFTPServer() {} virtual int FireAcceptConnection(OFTPServerAcceptConnectionEventParams* e) { clientConnectionId = e->ConnectionId; clientSSIDCode = strdup(e->ClientSSIDCode); this->SetOFTPConnectionDownloadDirectory(e->ConnectionId, INCOMING_DIR); return 0; } virtual int FireAcceptFile(OFTPServerAcceptFileEventParams* e) { //e->Accept = False; //To reject a file set e->Accept to false return 0; } virtual int FirePITrail(OFTPServerPITrailEventParams* e) { char logmsg[MAX_PATH]; if (e->Direction == 0) { sprintf(logmsg, "CLIENT: %s : %s", e->CommandId, e->CommandDescription); } else { sprintf(logmsg, "SERVER: %s : %s", e->CommandId, e->CommandDescription); } printf(logmsg); return 0; } virtual int FireError(OFTPServerErrorEventParams* e) { printf("[%d] %s\n", e->ErrorCode,strdup(e->Description)); return 0; } };

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_OFTPServer Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 16 );
ipworksedi_oftpserver_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_OFTPServer 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_oftpserver_get($res, 17 );
ipworksedi_oftpserver_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_OFTPServer Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 18 );
ipworksedi_oftpserver_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_OFTPServer Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 26 );
ipworksedi_oftpserver_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_OFTPServer Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 27 );
ipworksedi_oftpserver_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

ConnectionBacklog Property (IPWorksEDI_OFTPServer Class)

This property includes the maximum number of pending connections maintained by the Transmission Control Protocol (TCP)/IP subsystem.

Object Oriented Interface

public function getConnectionBacklog();
public function setConnectionBacklog($value);

Procedural Interface

ipworksedi_oftpserver_get($res, 28 );
ipworksedi_oftpserver_set($res, 28, $value );

Default Value

5

Remarks

This property contains the maximum number of pending connections maintained by the TCP/IP subsystem. This value reflects the SOMAXCONN option for the main listening socket. The default value for most systems is 5. You may set this property to a larger value if the server is expected to receive a large number of connections, and queuing them is desirable.

This property is not available at design time.

Data Type

Integer

OFTPConnectionCount Property (IPWorksEDI_OFTPServer Class)

The number of records in the OFTPConnection arrays.

Object Oriented Interface

public function getOFTPConnectionCount();

Procedural Interface

ipworksedi_oftpserver_get($res, 29 );

Default Value

0

Remarks

This property controls the size of the following arrays:

• OFTPConnectionCompress
• OFTPConnectionConnected
• OFTPConnectionConnectionId
• OFTPConnectionDownloadDirectory
• OFTPConnectionEncryptionAlgorithm
• OFTPConnectionLocalAddress
• OFTPConnectionMaxRecordSize
• OFTPConnectionReadyToSend
• OFTPConnectionRecipientCertStore
• OFTPConnectionRecipientCertStorePassword
• OFTPConnectionRecipientCertStoreType
• OFTPConnectionRecipientCertSubject
• OFTPConnectionRemoteHost
• OFTPConnectionRemotePort
• OFTPConnectionSFIDCode
• OFTPConnectionSignedReceipt
• OFTPConnectionSSIDCode
• OFTPConnectionTimeout
• OFTPConnectionVersion
• OFTPConnectionVirtualFileDate
• OFTPConnectionVirtualFileFormat
• OFTPConnectionVirtualFileSecurityLevel

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

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

Data Type

Integer

OFTPConnectionCompress Property (IPWorksEDI_OFTPServer Class)

Whether or not compression is used on the outgoing or incoming file.

Object Oriented Interface

public function getOFTPConnectionCompress($connectionid);
public function setOFTPConnectionCompress($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 30 , $connectionid);
ipworksedi_oftpserver_set($res, 30, $value , $connectionid);

Default Value

false

Remarks

Whether or not compression is used on the outgoing or incoming file.

When sending files to the client, if Compress is true the file will be compressed.

When receiving files, query this property to determine whether the file received from the client was compressed or not.

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

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

This property is not available at design time.

Data Type

Boolean

OFTPConnectionConnected Property (IPWorksEDI_OFTPServer Class)

This property indicates the status of individual connections.

Object Oriented Interface

public function getOFTPConnectionConnected($connectionid);

Procedural Interface

ipworksedi_oftpserver_get($res, 31 , $connectionid);

Default Value

false

Remarks

This property indicates the status of individual connections.

When true, the connection is established. Use the Disconnect method to disconnect an existing connection.

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

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

Data Type

Boolean

OFTPConnectionConnectionId Property (IPWorksEDI_OFTPServer Class)

This property contains an identifier generated by the class to identify each connection.

Object Oriented Interface

public function getOFTPConnectionConnectionId($connectionid);

Procedural Interface

ipworksedi_oftpserver_get($res, 32 , $connectionid);

Default Value

0

Remarks

This property contains an identifier generated by the class to identify each connection. This identifier is unique to this connection.

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

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

Data Type

Integer

OFTPConnectionDownloadDirectory Property (IPWorksEDI_OFTPServer Class)

The directory to which files will be saved.

Object Oriented Interface

public function getOFTPConnectionDownloadDirectory($connectionid);
public function setOFTPConnectionDownloadDirectory($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 33 , $connectionid);
ipworksedi_oftpserver_set($res, 33, $value , $connectionid);

Default Value

''

Remarks

The directory to which files will be saved.

This specifies the directory where files received by the server will be saved. This must be set before the client begins sending files. Set this in the Connected, AcceptConnection, or ConnectionRequest events, for instance: oftpserver1.SetOFTPConnectionDownloadDirectory(123456789, "C:\\Downloads");

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

This property is not available at design time.

Data Type

String

OFTPConnectionEncryptionAlgorithm Property (IPWorksEDI_OFTPServer Class)

The encryption algorithm used when sending files to the client.

Object Oriented Interface

public function getOFTPConnectionEncryptionAlgorithm($connectionid);
public function setOFTPConnectionEncryptionAlgorithm($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 34 , $connectionid);
ipworksedi_oftpserver_set($res, 34, $value , $connectionid);

Default Value

0

Remarks

The encryption algorithm used when sending files to the client.

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

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

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

This property is not available at design time.

Data Type

Integer

OFTPConnectionLocalAddress Property (IPWorksEDI_OFTPServer Class)

This property shows the IP address of the interface through which the connection is passing.

Object Oriented Interface

public function getOFTPConnectionLocalAddress($connectionid);

Procedural Interface

ipworksedi_oftpserver_get($res, 35 , $connectionid);

Default Value

''

Remarks

This property shows the IP address of the interface through which the connection is passing.

OFTPConnectionLocalAddress is important for multihomed hosts so that it can be used to find the particular network interface through which an individual connection is going.

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

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

Data Type

String

OFTPConnectionMaxRecordSize Property (IPWorksEDI_OFTPServer Class)

This value determines the maximum length for a record in the outgoing virtual file.

Object Oriented Interface

public function getOFTPConnectionMaxRecordSize($connectionid);
public function setOFTPConnectionMaxRecordSize($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 36 , $connectionid);
ipworksedi_oftpserver_set($res, 36, $value , $connectionid);

Default Value

0

Remarks

This value determines the maximum length for a record in the outgoing virtual file. When OFTPConnectionVirtualFileFormat 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.

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

This property is not available at design time.

Data Type

Integer

OFTPConnectionReadyToSend Property (IPWorksEDI_OFTPServer Class)

Specifies whether or not the server can send to the client.

Object Oriented Interface

public function getOFTPConnectionReadyToSend($connectionid);

Procedural Interface

ipworksedi_oftpserver_get($res, 37 , $connectionid);

Default Value

false

Remarks

Specifies whether or not the server can send to the client.

When the client passes control to the server, this property will be true. Additionally the ReadyToSend event will fire at this time. This must be true before sending files to the client.

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

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

Data Type

Boolean

OFTPConnectionRecipientCertStore Property (IPWorksEDI_OFTPServer Class)

The name of the certificate store for the recipient certificate.

Object Oriented Interface

public function getOFTPConnectionRecipientCertStore($connectionid);
public function setOFTPConnectionRecipientCertStore($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 38 , $connectionid);
ipworksedi_oftpserver_set($res, 38, $value , $connectionid);

Default Value

'MY'

Remarks

The name of the certificate store for the recipient certificate.

The OFTPConnectionRecipientCertStoreType property specifies the type of the certificate store specified by OFTPConnectionRecipientCertStore. If the store is password protected, specify the password in OFTPConnectionRecipientCertStorePassword.

OFTPConnectionRecipientCertStore is used in conjunction with the OFTPConnectionRecipientCertSubject property in order to specify client certificates. If OFTPConnectionRecipientCertStore has a value, and OFTPConnectionRecipientCertSubject is set, a search for a certificate is initiated. Please refer to the OFTPConnectionRecipientCertSubject 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).

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

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

This property is not available at design time.

Data Type

Binary String

OFTPConnectionRecipientCertStorePassword Property (IPWorksEDI_OFTPServer Class)

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

Object Oriented Interface

public function getOFTPConnectionRecipientCertStorePassword($connectionid);
public function setOFTPConnectionRecipientCertStorePassword($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 39 , $connectionid);
ipworksedi_oftpserver_set($res, 39, $value , $connectionid);

Default Value

''

Remarks

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

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

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

This property is not available at design time.

Data Type

String

OFTPConnectionRecipientCertStoreType Property (IPWorksEDI_OFTPServer Class)

The type of certificate store for this certificate.

Object Oriented Interface

public function getOFTPConnectionRecipientCertStoreType($connectionid);
public function setOFTPConnectionRecipientCertStoreType($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 40 , $connectionid);
ipworksedi_oftpserver_set($res, 40, $value , $connectionid);

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:

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

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

This property is not available at design time.

Data Type

Integer

OFTPConnectionRecipientCertSubject Property (IPWorksEDI_OFTPServer Class)

The subject of the recipient certificate.

Object Oriented Interface

public function getOFTPConnectionRecipientCertSubject($connectionid);
public function setOFTPConnectionRecipientCertSubject($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 41 , $connectionid);
ipworksedi_oftpserver_set($res, 41, $value , $connectionid);

Default Value

''

Remarks

The subject of the recipient certificate.

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.

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

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

This property is not available at design time.

Data Type

String

OFTPConnectionRemoteHost Property (IPWorksEDI_OFTPServer Class)

This property shows the IP address of the remote host through which the connection is coming.

Object Oriented Interface

public function getOFTPConnectionRemoteHost($connectionid);

Procedural Interface

ipworksedi_oftpserver_get($res, 42 , $connectionid);

Default Value

''

Remarks

This property shows the IP address of the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

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.

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

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

Data Type

String

OFTPConnectionRemotePort Property (IPWorksEDI_OFTPServer Class)

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

Object Oriented Interface

public function getOFTPConnectionRemotePort($connectionid);

Procedural Interface

ipworksedi_oftpserver_get($res, 43 , $connectionid);

Default Value

0

Remarks

This property shows the Transmission Control Protocol (TCP) port on the remote host through which the connection is coming.

The connection must be valid or an error will be fired.

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

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

Data Type

Integer

OFTPConnectionSFIDCode Property (IPWorksEDI_OFTPServer Class)

The connected client's SFID code.

Object Oriented Interface

public function getOFTPConnectionSFIDCode($connectionid);
public function setOFTPConnectionSFIDCode($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 44 , $connectionid);
ipworksedi_oftpserver_set($res, 44, $value , $connectionid);

Default Value

''

Remarks

The connected client's SFID code.

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.

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

This property is not available at design time.

Data Type

String

OFTPConnectionSignedReceipt Property (IPWorksEDI_OFTPServer Class)

Indicates whether a signed receipt is requested.

Object Oriented Interface

public function getOFTPConnectionSignedReceipt($connectionid);
public function setOFTPConnectionSignedReceipt($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 45 , $connectionid);
ipworksedi_oftpserver_set($res, 45, $value , $connectionid);

Default Value

false

Remarks

Indicates whether a signed receipt is requested.

When sending files, if this is set to true a signed receipt will be requested. In that case OFTPConnectionRecipientCertStoreType, OFTPConnectionRecipientCertStore, and OFTPConnectionRecipientCertSubject must be set to specify the public certificate that will be used to verify the signature on the receipt returned by the client after SendFile is called. The class will automatically verify the signature on the returned receipt.

When receiving files, query this property to determine if the client requested a signed receipt. If true, the Certificate property must be set to a certificate with private key in order to sign the receipt that will be returned to the client. The class will sign and deliver the receipt automatically.

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

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

This property is not available at design time.

Data Type

Boolean

OFTPConnectionSSIDCode Property (IPWorksEDI_OFTPServer Class)

The connected client's SSID code.

Object Oriented Interface

public function getOFTPConnectionSSIDCode($connectionid);
public function setOFTPConnectionSSIDCode($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 46 , $connectionid);
ipworksedi_oftpserver_set($res, 46, $value , $connectionid);

Default Value

''

Remarks

The connected client's SSID code.

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

This property is not available at design time.

Data Type

String

OFTPConnectionTimeout Property (IPWorksEDI_OFTPServer Class)

A timeout for the class.

Object Oriented Interface

public function getOFTPConnectionTimeout($connectionid);
public function setOFTPConnectionTimeout($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 47 , $connectionid);
ipworksedi_oftpserver_set($res, 47, $value , $connectionid);

Default Value

0

Remarks

A timeout for the class.

If the OFTPConnectionTimeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If OFTPConnectionTimeout is set to a positive value, the class will wait for the operation to complete before returning control.

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 OFTPConnectionTimeout is specified by the DefaultTimeout property.

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

This property is not available at design time.

Data Type

Integer

OFTPConnectionVersion Property (IPWorksEDI_OFTPServer Class)

This holds the version of OFTP supported by the client.

Object Oriented Interface

public function getOFTPConnectionVersion($connectionid);

Procedural Interface

ipworksedi_oftpserver_get($res, 48 , $connectionid);

Default Value

0

Remarks

This holds the version of OFTP supported by the client. This value cannot be changed. All communication with the client is performed using the version returned by this property. Possible values are:

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

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

Data Type

Integer

OFTPConnectionVirtualFileDate Property (IPWorksEDI_OFTPServer Class)

Set this to the date/time stamp for the virtual file before sending.

Object Oriented Interface

public function getOFTPConnectionVirtualFileDate($connectionid);
public function setOFTPConnectionVirtualFileDate($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 49 , $connectionid);
ipworksedi_oftpserver_set($res, 49, $value , $connectionid);

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

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

This property is not available at design time.

Data Type

String

OFTPConnectionVirtualFileFormat Property (IPWorksEDI_OFTPServer Class)

The structure of the outgoing or incoming file.

Object Oriented Interface

public function getOFTPConnectionVirtualFileFormat($connectionid);
public function setOFTPConnectionVirtualFileFormat($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 50 , $connectionid);
ipworksedi_oftpserver_set($res, 50, $value , $connectionid);

Default Value

0

Remarks

The structure of the outgoing or incoming file.

When sending files, set this property to specify the format to apply to outgoing files.

When receiving files, query this property to determine the structure of the file received from the client.

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

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

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

This property is not available at design time.

Data Type

Integer

OFTPConnectionVirtualFileSecurityLevel Property (IPWorksEDI_OFTPServer Class)

Specifies security options for the outgoing or incoming file.

Object Oriented Interface

public function getOFTPConnectionVirtualFileSecurityLevel($connectionid);
public function setOFTPConnectionVirtualFileSecurityLevel($connectionid, $value);

Procedural Interface

ipworksedi_oftpserver_get($res, 51 , $connectionid);
ipworksedi_oftpserver_set($res, 51, $value , $connectionid);

Default Value

0

Remarks

Specifies security options for the outgoing or incoming file.

When receiving files, query this property to determine the security level of the file received from the client.

When sending files to the client, this property will be used to determine what security options apply to the outgoing file. Possible values are:

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

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

This property is not available at design time.

Data Type

Integer

DefaultTimeout Property (IPWorksEDI_OFTPServer Class)

An initial timeout value to be used by incoming connections.

Object Oriented Interface

public function getDefaultTimeout();
public function setDefaultTimeout($value);

Procedural Interface

ipworksedi_oftpserver_get($res, 52 );
ipworksedi_oftpserver_set($res, 52, $value );

Default Value

60

Remarks

If the DefaultTimeout property is set to 0, all operations will run uninterrupted until successful completion or an error condition is encountered.

If DefaultTimeout is set to a positive value, the class will wait for the operation to complete before returning control.

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 DefaultTimeout property is 60 (seconds).

Data Type

Integer

Listening Property (IPWorksEDI_OFTPServer Class)

This property indicates whether the class is listening for incoming connections on LocalPort.

Object Oriented Interface

public function getListening();

Procedural Interface

ipworksedi_oftpserver_get($res, 53 );

Default Value

false

Remarks

This property indicates whether the class is listening for connections on the port specified by the LocalPort property. Use the StartListening and StopListening methods to control whether the class is listening.

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

Data Type

Boolean

LocalHost Property (IPWorksEDI_OFTPServer 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_oftpserver_get($res, 54 );
ipworksedi_oftpserver_set($res, 54, $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

LocalPort Property (IPWorksEDI_OFTPServer Class)

The TCP port in the local host where the class listens.

Object Oriented Interface

public function getLocalPort();
public function setLocalPort($value);

Procedural Interface

ipworksedi_oftpserver_get($res, 55 );
ipworksedi_oftpserver_set($res, 55, $value );

Default Value

3305

Remarks

This property must be set before OFTPServer starts listening. If its value is 0, then the TCP/IP subsystem picks a port number at random. The port number can be found by checking the value of this property after OFTPServer is in listening mode (after successfully assigning True to the Listening property).

The service port is not shared among servers (i.e. there can be only one OFTPServer 'listening' on a particular port at one time).

The default value for plaintext communication is 3305. If UseSSL is set to true, set this value to 6619 (the default port for SSL communication).

Data Type

Integer

ServerPassword Property (IPWorksEDI_OFTPServer Class)

The server's password.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 56 );
ipworksedi_oftpserver_set($res, 56, $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_OFTPServer Class)

Server's SFID code.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 57 );
ipworksedi_oftpserver_set($res, 57, $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_OFTPServer Class)

The server's SSID code.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 58 );
ipworksedi_oftpserver_set($res, 58, $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

SSLAuthenticateClients Property (IPWorksEDI_OFTPServer Class)

If set to True, the server asks the client(s) for a certificate.

Object Oriented Interface

public function getSSLAuthenticateClients();
public function setSSLAuthenticateClients($value);

Procedural Interface

ipworksedi_oftpserver_get($res, 59 );
ipworksedi_oftpserver_set($res, 59, $value );

Default Value

false

Remarks

This property is used in conjunction with the SSLClientAuthentication event. Please refer to the documentation of the SSLClientAuthentication event for details.

Data Type

Boolean

SSLCertEffectiveDate Property (IPWorksEDI_OFTPServer Class)

The date on which this certificate becomes valid.

Object Oriented Interface

public function getSSLCertEffectiveDate();

Procedural Interface

ipworksedi_oftpserver_get($res, 60 );

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_OFTPServer Class)

The date on which the certificate expires.

Object Oriented Interface

public function getSSLCertExpirationDate();

Procedural Interface

ipworksedi_oftpserver_get($res, 61 );

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_OFTPServer Class)

A comma-delimited list of extended key usage identifiers.

Object Oriented Interface

public function getSSLCertExtendedKeyUsage();

Procedural Interface

ipworksedi_oftpserver_get($res, 62 );

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_OFTPServer Class)

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

Object Oriented Interface

public function getSSLCertFingerprint();

Procedural Interface

ipworksedi_oftpserver_get($res, 63 );

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_OFTPServer Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA1();

Procedural Interface

ipworksedi_oftpserver_get($res, 64 );

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_OFTPServer Class)

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

Object Oriented Interface

public function getSSLCertFingerprintSHA256();

Procedural Interface

ipworksedi_oftpserver_get($res, 65 );

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_OFTPServer Class)

The issuer of the certificate.

Object Oriented Interface

public function getSSLCertIssuer();

Procedural Interface

ipworksedi_oftpserver_get($res, 66 );

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_OFTPServer Class)

The private key of the certificate (if available).

Object Oriented Interface

public function getSSLCertPrivateKey();

Procedural Interface

ipworksedi_oftpserver_get($res, 67 );

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_OFTPServer Class)

Whether a PrivateKey is available for the selected certificate.

Object Oriented Interface

public function getSSLCertPrivateKeyAvailable();

Procedural Interface

ipworksedi_oftpserver_get($res, 68 );

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_OFTPServer Class)

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

Object Oriented Interface

public function getSSLCertPrivateKeyContainer();

Procedural Interface

ipworksedi_oftpserver_get($res, 69 );

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_OFTPServer Class)

The public key of the certificate.

Object Oriented Interface

public function getSSLCertPublicKey();

Procedural Interface

ipworksedi_oftpserver_get($res, 70 );

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_OFTPServer Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyAlgorithm();

Procedural Interface

ipworksedi_oftpserver_get($res, 71 );

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_OFTPServer Class)

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

Object Oriented Interface

public function getSSLCertPublicKeyLength();

Procedural Interface

ipworksedi_oftpserver_get($res, 72 );

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_OFTPServer Class)

The serial number of the certificate encoded as a string.

Object Oriented Interface

public function getSSLCertSerialNumber();

Procedural Interface

ipworksedi_oftpserver_get($res, 73 );

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_OFTPServer Class)

The text description of the certificate's signature algorithm.

Object Oriented Interface

public function getSSLCertSignatureAlgorithm();

Procedural Interface

ipworksedi_oftpserver_get($res, 74 );

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_OFTPServer Class)

The name of the certificate store for the client certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 75 );
ipworksedi_oftpserver_set($res, 75, $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_OFTPServer 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_oftpserver_get($res, 76 );
ipworksedi_oftpserver_set($res, 76, $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_OFTPServer Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 77 );
ipworksedi_oftpserver_set($res, 77, $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_OFTPServer Class)

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

Object Oriented Interface

public function getSSLCertSubjectAltNames();

Procedural Interface

ipworksedi_oftpserver_get($res, 78 );

Default Value

''

Remarks

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

This property is read-only.

Data Type

String

SSLCertThumbprintMD5 Property (IPWorksEDI_OFTPServer Class)

The MD5 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintMD5();

Procedural Interface

ipworksedi_oftpserver_get($res, 79 );

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_OFTPServer Class)

The SHA-1 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA1();

Procedural Interface

ipworksedi_oftpserver_get($res, 80 );

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_OFTPServer Class)

The SHA-256 hash of the certificate.

Object Oriented Interface

public function getSSLCertThumbprintSHA256();

Procedural Interface

ipworksedi_oftpserver_get($res, 81 );

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_OFTPServer Class)

The text description of UsageFlags .

Object Oriented Interface

public function getSSLCertUsage();

Procedural Interface

ipworksedi_oftpserver_get($res, 82 );

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_OFTPServer Class)

The flags that show intended use for the certificate.

Object Oriented Interface

public function getSSLCertUsageFlags();

Procedural Interface

ipworksedi_oftpserver_get($res, 83 );

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_OFTPServer Class)

The certificate's version number.

Object Oriented Interface

public function getSSLCertVersion();

Procedural Interface

ipworksedi_oftpserver_get($res, 84 );

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_OFTPServer Class)

The subject of the certificate used for client authentication.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 85 );
ipworksedi_oftpserver_set($res, 85, $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_OFTPServer Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 86 );
ipworksedi_oftpserver_set($res, 86, $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

TrustedCertCount Property (IPWorksEDI_OFTPServer Class)

The number of records in the TrustedCert arrays.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 87 );
ipworksedi_oftpserver_set($res, 87, $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_OFTPServer 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_oftpserver_get($res, 103 , $trustedcertindex);
ipworksedi_oftpserver_set($res, 103, $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_OFTPServer 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_oftpserver_get($res, 104 , $trustedcertindex);
ipworksedi_oftpserver_set($res, 104, $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_OFTPServer Class)

The type of certificate store for this certificate.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 105 , $trustedcertindex);
ipworksedi_oftpserver_set($res, 105, $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_OFTPServer 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_oftpserver_get($res, 113 , $trustedcertindex);
ipworksedi_oftpserver_set($res, 113, $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_OFTPServer Class)

The certificate (PEM/Base64 encoded).

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 114 , $trustedcertindex);
ipworksedi_oftpserver_set($res, 114, $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_OFTPServer Class)

Use SSL to access the RemoteHost .

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_get($res, 115 );
ipworksedi_oftpserver_set($res, 115, $value );

Default Value

false

Remarks

Use this property to determine whether the class uses SSL when clients connect.

This property is only valid when using version 2.0 of the protocol. If set to true, all clients that connect must use version 2.0.

This property is not available at design time.

Data Type

Boolean

ChangeDirection Method (IPWorksEDI_OFTPServer Class)

Sends a Change Direction (CD) command.

Object Oriented Interface

public function doChangeDirection($connectionid);

Procedural Interface

ipworksedi_oftpserver_do_changedirection($res, $connectionid);

Remarks

This method sends a Change Direction (CD) command to the client 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 client. For instance: component.ChangeDirection(MyConnectionId);

Config Method (IPWorksEDI_OFTPServer Class)

Sets or retrieves a configuration setting.

Object Oriented Interface

public function doConfig($configurationstring);

Procedural Interface

ipworksedi_oftpserver_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.

Disconnect Method (IPWorksEDI_OFTPServer Class)

This method disconnects the specified client.

Object Oriented Interface

public function doDisconnect($connectionid);

Procedural Interface

ipworksedi_oftpserver_do_disconnect($res, $connectionid);

Remarks

Calling this method will disconnect the client specified by the ConnectionId parameter.

DoEvents Method (IPWorksEDI_OFTPServer Class)

This method processes events from the internal message queue.

Object Oriented Interface

public function doEvents();

Procedural Interface

ipworksedi_oftpserver_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_OFTPServer Class)

Exchange a certificate with the remote host.

Object Oriented Interface

public function doExchangeCertificate($connectionid, $clientsfidcode, $certificatestore, $certificateexchangetype);

Procedural Interface

ipworksedi_oftpserver_do_exchangecertificate($res, $connectionid, $clientsfidcode, $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:

ImportTrustedCerts Method (IPWorksEDI_OFTPServer Class)

Imports a list of trusted CA certificates.

Object Oriented Interface

public function doImportTrustedCerts();

Procedural Interface

ipworksedi_oftpserver_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_OFTPServer Class)

This method interrupts a synchronous send to the remote host.

Object Oriented Interface

public function doInterrupt($connectionid);

Procedural Interface

ipworksedi_oftpserver_do_interrupt($res, $connectionid);

Remarks

This property is called using the Connection Id if you wish to interrupt a connection and stop a file from uploading without disconnecting the client connected to the class. If you use SendFile to upload a file, the class will run synchronously on that Connection Id until it is completed.

Logoff Method (IPWorksEDI_OFTPServer Class)

Ends a session with the connection client.

Object Oriented Interface

public function doLogoff($connectionid);

Procedural Interface

ipworksedi_oftpserver_do_logoff($res, $connectionid);

Remarks

This method will attempt to end the session with the client if the client has acknowledged it is finished sending files to the server. If the client still wishes to process commands, the method will give control back to the client and OFTPConnectionReadyToSend will be false. When OFTPConnectionReadyToSend is true, calling this method will end the session.

Reset Method (IPWorksEDI_OFTPServer Class)

Resets the state of the control.

Object Oriented Interface

public function doReset();

Procedural Interface

ipworksedi_oftpserver_do_reset($res);

Remarks

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

SendEndResponse Method (IPWorksEDI_OFTPServer Class)

Sends an EERP/NERP asynchronously.

Object Oriented Interface

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

Procedural Interface

ipworksedi_oftpserver_do_sendendresponse($res, $connectionid, $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_OFTPServer Class)

Sends a file to the specified client.

Object Oriented Interface

public function doSendFile($connectionid, $clientsfidcode, $filename, $virtualfilename);

Procedural Interface

ipworksedi_oftpserver_do_sendfile($res, $connectionid, $clientsfidcode, $filename, $virtualfilename);

Remarks

This method sends a file to the client specified by the ConnectionId parameter.

After the ReadyToSend event fires or when the OFTPConnectionReadyToSend property is true, this method can be used to send a file to the connected client specified by the ConnectionId parameter.

The ClientSFIDCode corresponds to the destination.

FileName must be the full path to the file which will be sent.

VirtualFileName may be specified to indicate the name of the file that the client will see when receiving the file.

If ConnectionsUploadStream is set, pass empty string as the value for the FileName parameter.

When this method is called, the class will fire the StartTransfer, Transfer, and EndTransfer events that can be monitored to check the status of the send. The SendFile method will not return until either the transfer is complete or an error was encountered.

Shutdown Method (IPWorksEDI_OFTPServer Class)

This method shuts down the server.

Object Oriented Interface

public function doShutdown();

Procedural Interface

ipworksedi_oftpserver_do_shutdown($res);

Remarks

This method shuts down the server. Calling this method is equivalent to calling StopListening and then breaking every client connection by calling Disconnect.

StartListening Method (IPWorksEDI_OFTPServer Class)

This method starts listening for incoming connections.

Object Oriented Interface

public function doStartListening();

Procedural Interface

ipworksedi_oftpserver_do_startlistening($res);

Remarks

This method begins listening for incoming connections on the port specified by LocalPort. Once listening, events will fire as new clients connect and data are transferred.

To stop listening for new connections, call StopListening. To stop listening for new connections and to disconnect all existing clients, call Shutdown.

StopListening Method (IPWorksEDI_OFTPServer Class)

This method stops listening for new connections.

Object Oriented Interface

public function doStopListening();

Procedural Interface

ipworksedi_oftpserver_do_stoplistening($res);

Remarks

This method stops listening for new connections. After being called, any new connection attempts will be rejected. Calling this method does not disconnect existing connections.

To stop listening and to disconnect all existing clients, call Shutdown instead.

ValidateCert Method (IPWorksEDI_OFTPServer Class)

Validates the certificate with private key.

Object Oriented Interface

public function doValidateCert();

Procedural Interface

ipworksedi_oftpserver_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_OFTPServer Class)

Validates the recipient certificate.

Object Oriented Interface

public function doValidateRecipientCert($connectionid);

Procedural Interface

ipworksedi_oftpserver_do_validaterecipientcert($res, $connectionid);

Remarks

This method optionally validates the certificate specified by OFTPConnectionRecipientCertSubject. 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.

AcceptConnection Event (IPWorksEDI_OFTPServer Class)

Fired when a client connects.

Object Oriented Interface

public function fireAcceptConnection($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 1, array($this, 'fireAcceptConnection'));

Parameter List

 'connectionid'
 'clientssidcode'
 'clientpassword'
 'clientversion'
 'serverversion'
 'accept'
 'errorcode'
 'errordescription'

Remarks

This event fires when a new OFTP connection is made to the server. Use the parameters of this event to verify the identify of the client identified by the ConnectionId. By default the connection will be accepted. To reject the connection set Accept to false.

ClientVersion specifies the OFTP protocol version the client supports. By default the class will use the version requested by the client for the connection. If you wish to restrict connections to a specific OFTP protocol version use this value when determining whether or not to accept the connection. When rejecting the connection based on the OFTP protocol version use ErrorCode 10. Possible values are:

ServerVersion specifies the OFTP protocol version the server will use for the connection. By default this will be the same as ClientVersion. This may be set to a different version which will be sent back to the client. Possible values are:

When rejecting a connection the ErrorCode and ErrorDescription may optionally be set. Possible common values are:

AcceptFile Event (IPWorksEDI_OFTPServer Class)

Fired when the client sends a file.

Object Oriented Interface

public function fireAcceptFile($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 2, array($this, 'fireAcceptFile'));

Parameter List

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

Remarks

This event controls the behavior when the client sends a file to the server.

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_OFTPServer Class)

Fired when a certificate is received from the remote host.

Object Oriented Interface

public function fireCertificateReceived($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 3, array($this, 'fireCertificateReceived'));

Parameter List

 'connectionid'
 '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:

ConnectionId identifies the connected client.

Connected Event (IPWorksEDI_OFTPServer Class)

This event is fired immediately after a connection completes (or fails).

Object Oriented Interface

public function fireConnected($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 4, array($this, 'fireConnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

Remarks

If the connection is made normally, StatusCode is 0, and Description is "OK".

If the connection fails, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

ConnectionRequest Event (IPWorksEDI_OFTPServer Class)

This event is fired when a request for connection comes from a remote host.

Object Oriented Interface

public function fireConnectionRequest($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 5, array($this, 'fireConnectionRequest'));

Parameter List

 'address'
 'port'
 'accept'

Remarks

This event indicates an incoming connection. The connection is accepted by default. Address and Port will contain information about the remote host requesting the inbound connection. If you want to refuse it, you can set the Accept parameter to False.

Disconnected Event (IPWorksEDI_OFTPServer Class)

This event is fired when a connection is closed.

Object Oriented Interface

public function fireDisconnected($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 6, array($this, 'fireDisconnected'));

Parameter List

 'connectionid'
 'statuscode'
 'description'

Remarks

If the connection is broken normally, StatusCode is 0, and Description is "OK".

If the connection is broken for any other reason, StatusCode has the error code returned by the system. Description contains a description of this code. The value of StatusCode is equal to the value of the system error.

Please refer to the Error Codes section for more information.

EndResponse Event (IPWorksEDI_OFTPServer Class)

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

Object Oriented Interface

public function fireEndResponse($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 7, array($this, 'fireEndResponse'));

Parameter List

 'connectionid'
 '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:

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:

ConnectionId identifies the connected client.

EndTransfer Event (IPWorksEDI_OFTPServer Class)

Fired when a file finishes transferring.

Object Oriented Interface

public function fireEndTransfer($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 8, array($this, 'fireEndTransfer'));

Parameter List

 'connectionid'
 '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:

ConnectionId identifies the connected client.

Error Event (IPWorksEDI_OFTPServer Class)

Information about errors during data delivery.

Object Oriented Interface

public function fireError($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 9, array($this, 'fireError'));

Parameter List

 'connectionid'
 'errorcode'
 'description'

Remarks

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

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

ConnectionId contains the Id of the connection to which this error applies.

Log Event (IPWorksEDI_OFTPServer Class)

Fires once for each log message.

Object Oriented Interface

public function fireLog($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 10, array($this, 'fireLog'));

Parameter List

 'connectionid'
 'loglevel'
 'message'
 'logtype'

Remarks

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

ConnectionId identifies the connected client.

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_OFTPServer Class)

Fired when any protocol level communication occurs.

Object Oriented Interface

public function firePITrail($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 11, array($this, 'firePITrail'));

Parameter List

 'connectionid'
 '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.

ReadyToSend Event (IPWorksEDI_OFTPServer Class)

Fired when the class is ready to send data.

Object Oriented Interface

public function fireReadyToSend($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 12, array($this, 'fireReadyToSend'));

Parameter List

 'connectionid'

Remarks

The ReadyToSend event indicates that the connected client is in a state where it can accept files sent from the server. When a client connects initially it will not be ready to receive files. After the client sends files (if any) to the server it will pass control to the server. At that time the ReadyToSend event will fire. In addition the OFTPConnectionReadyToSend property will be set to true for the connection.

After this event fires SendFile can be called to send files to the connected client.

SSLClientAuthentication Event (IPWorksEDI_OFTPServer Class)

This event is fired when the client presents its credentials to the server.

Object Oriented Interface

public function fireSSLClientAuthentication($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 13, array($this, 'fireSSLClientAuthentication'));

Parameter List

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

Remarks

This event enables the server to decide whether or not to continue. The Accept parameter is a recommendation on whether to continue or to 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").

SSLConnectionRequest Event (IPWorksEDI_OFTPServer Class)

This event fires when a Secure Sockets Layer (SSL) connection is requested.

Object Oriented Interface

public function fireSSLConnectionRequest($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 14, array($this, 'fireSSLConnectionRequest'));

Parameter List

 'connectionid'
 'supportedciphersuites'
 'supportedsignaturealgs'
 'certstoretype'
 'certstore'
 'certpassword'
 'certsubject'

Remarks

This event fires when an SSL connection is requested and SSLProvider is set to Internal. This event provides an opportunity to select an alternative certificate to the connecting client. This event does not fire when SSLProvider is set to Platform.

This event allows the class to be configured to use both RSA and ECDSA certificates depending on the connecting client's capabilities.

ConnectionId is the connection Id of the client requesting the connection.

SupportedCipherSuites is a comma-separated list of cipher suites that the client supports.

SupportedSignatureAlgs is a comma-separated list of certificate signature algorithms that the client supports.

CertStoreType is the store type of the alternate certificate to use for this connection. 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:

CertStore is the store name or location of the alternate certificate to use for this connection.

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).

CertPassword is the password of the certificate store containing the alternate certificate to use for this connection.

CertSubject is the subject of the alternate certificate to use for this connection.

The special value * matches any subject and will select the first certificate in the 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.

SSLStatus Event (IPWorksEDI_OFTPServer Class)

This event is fired to show the progress of the secure connection.

Object Oriented Interface

public function fireSSLStatus($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 15, array($this, 'fireSSLStatus'));

Parameter List

 'connectionid'
 'message'

Remarks

The event is fired for informational and logging purposes only. It is used to track the progress of the connection.

StartTransfer Event (IPWorksEDI_OFTPServer Class)

Fired when a document starts transferring.

Object Oriented Interface

public function fireStartTransfer($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 16, array($this, 'fireStartTransfer'));

Parameter List

 'connectionid'
 '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.

ConnectionId identifies the connected client.

Transfer Event (IPWorksEDI_OFTPServer Class)

Fired while a document transfers (delivers document).

Object Oriented Interface

public function fireTransfer($param);

Procedural Interface

ipworksedi_oftpserver_register_callback($res, 17, array($this, 'fireTransfer'));

Parameter List

 'connectionid'
 '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.

ConnectionId identifies the connected client.

Config Settings (OFTPServer Class)

OFTPServer Config Settings

TCPServer Config Settings

SSL Config Settings

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert ...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert ...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

-----BEGIN CERTIFICATE-----
MIIEKzCCAxOgAwIBAgIRANTET4LIkxdH6P+CFIiHvTowDQYJKoZIhvcNAQELBQAw
... Intermediate Cert...
eWHV5OW1K53o/atv59sOiW5K3crjFhsBOd5Q+cJJnU+SWinPKtANXMht+EDvYY2w
F0I1XhM+pKj7FjDr+XNj
-----END CERTIFICATE-----
\r \n
-----BEGIN CERTIFICATE-----
MIIEFjCCAv6gAwIBAgIQetu1SMxpnENAnnOz1P+PtTANBgkqhkiG9w0BAQUFADBp
... Root Cert...
d8q23djXZbVYiIfE9ebr4g3152BlVCHZ2GyPdjhIuLeH21VbT/dyEHHA
-----END CERTIFICATE-----

Base Config Settings

Trappable Errors (OFTPServer Class)

OFTPServer Errors

TCPServer Errors

TCP/IP Errors