AS3Receiver Module

Properties   Methods   Events   Config Settings   Errors  

The AS3Receiver module is used to process AS3 messages and generate receipts.

Syntax

IPWorksEDI.As3receiver

Remarks

The AS3Receiver class allows you to receive AS3 messages over FTP, as specified in [AS3] and RFC 3335. The class can act as a FTP client, decrypt and verify incoming messages, and generate receipts including Message Disposition Notifications (MDNs). The class is designed to interoperate easily with a standard FTP server.

BASIC OPERATION

You should first log in to the FTP server by invoking Logon. If you need to search the FTP server for requests you may set RemotePath, invoke ListDirectory, etc. When you find the desired files you may then download them invoking ReadRequest. Alternatively, if you acquire the AS3 data by other means you may simply set Request.

ReadRequest (or ParseHeaders) will determine information such as AS3From and AS3To, which will allow you to set the appropriate certificates. You may specify your certificate with the Certificate property, and your trading partner's (signing) certificate with the SignerCert property.

Then, invoke ProcessRequest to process the request and generate the MDN receipt as specified in [AS3]. If the request was processed successfully, EDIData will contain the transmitted EDI data. If a problem occurred, EDIData will not be populated and an exception will be thrown. In either case MDNReceipt will contain the RFC-compliant receipt, which should be returned to the client.

The MDNReceipt may be returned over the same FTP connection by invoking SendResponse. If it is necessary to create a new connection or send receipts to a different server you may Logoff and Logon at will.

To create log files, set LogDirectory prior to invoking ProcessRequest. This will log all incoming and outgoing data, and will also write the received EDI files to disk.

EXAMPLE AS3Receiver1.User = "myusername" AS3Receiver1.Password = "mypassword" AS3Receiver1.RemoteHost = "ftp.mytradingpartner.com" AS3Receiver1.Logon() // You may need to search the server for received files at this point AS3Receiver1.ReadRequest("1053-ji094986.as3") // At this point, you should check the values of AS2From and AS2To. AS3Receiver1.Certificate = new Certificate(CertStoreTypes.cstPFXFile, "\\my_server_directory\\my_pfx_file.pfx", "my password", "CN=Me"); AS3Receiver1.SignerCert = (...); AS3Receiver1.LogDirectory = "c:\\my_server_directory\\my_log_directory"; AS3Receiver1.ProcessRequest(); // It will probably be necessary to change the RemotePath or even logon // to a different server here. AS3Receiver1.SendResponse("1053-ji094986-mdn.as3"); Additional functionality allows the user to examine details of the client's request, to permit certain types of errors, or to customize the outgoing MDN. See the property and method list for details.

Property List

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

Method List

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

Event List

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

Config Settings

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

AS3From Property (AS3Receiver Module)

The identity of the sending system.

Syntax

• Swift
• Objective-C

public var as3From: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=AS3From) NSString* AS3From;

- (NSString*)AS3From;

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

AS3To Property (AS3Receiver Module)

The identity of the receiving system.

Syntax

• Swift
• Objective-C

public var as3To: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=AS3To) NSString* AS3To;

- (NSString*)AS3To;

Default Value

""

Remarks

May be company name, DUNS number, or anything agreed on by trading partners.

This property is read-only.

AS3VersionIncoming Property (AS3Receiver Module)

The version of AS3 being used.

Syntax

• Swift
• Objective-C

public var as3VersionIncoming: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=AS3VersionIncoming) NSString* AS3VersionIncoming;

- (NSString*)AS3VersionIncoming;

Default Value

"1.0"

Remarks

The version of AS3 being used on the incoming transmission. Should be "1.0".

This property is read-only.

AS3VersionOutgoing Property (AS3Receiver Module)

The version of AS3 being used.

Syntax

• Swift
• Objective-C

public var as3VersionOutgoing: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=AS3VersionOutgoing,setter=setAS3VersionOutgoing:) NSString* AS3VersionOutgoing;

- (NSString*)AS3VersionOutgoing;
- (void)setAS3VersionOutgoing :(NSString*)newAS3VersionOutgoing;

Default Value

"1.0"

Remarks

The version of AS3 being used on the outgoing transmission. Should be "1.0".

Attachments Property (AS3Receiver Module)

Collection of files attached to the current message.

Syntax

• Swift
• Objective-C

public var attachments: Array<EDIAttachment> {
  get {...}
}

@property (nonatomic,readonly,assign,getter=attachmentCount) int attachmentCount;

- (int)attachmentCount;

- (NSString*)attachmentContentType:(int)attachmentIndex;

- (NSString*)attachmentData:(int)attachmentIndex;

- (NSData*)attachmentDataB:(int)attachmentIndex;
- (NSString*)attachmentFilename:(int)attachmentIndex;

- (NSString*)attachmentHeaders:(int)attachmentIndex;

- (NSString*)attachmentName:(int)attachmentIndex;

 

Default Value

""

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

CertEncoded Property (AS3Receiver Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var certEncoded: String {
  get {...}
  set {...}
}

public var certEncodedB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certEncoded,setter=setCertEncoded:) NSString* certEncoded;

- (NSString*)certEncoded;
- (void)setCertEncoded :(NSString*)newCertEncoded;

@property (nonatomic,readwrite,assign,getter=certEncodedB,setter=setCertEncodedB:) NSData* certEncodedB;

- (NSData*)certEncodedB;
- (void)setCertEncodedB :(NSData*)newCertEncoded;

Default Value

""

Remarks

This is 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.

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setCertEncodedB(certEncoded: Data) throws
public func setCertEncoded(certEncoded: String) throws

CertStore Property (AS3Receiver Module)

This is the name of the certificate store for the client certificate.

Syntax

• Swift
• Objective-C

public var certStore: String {
  get {...}
  set {...}
}

public var certStoreB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certStore,setter=setCertStore:) NSString* certStore;

- (NSString*)certStore;
- (void)setCertStore :(NSString*)newCertStore;

@property (nonatomic,readwrite,assign,getter=certStoreB,setter=setCertStoreB:) NSData* certStoreB;

- (NSData*)certStoreB;
- (void)setCertStoreB :(NSData*)newCertStore;

Default Value

"MY"

Remarks

This is 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 are designations of the most common User and Machine certificate stores in Windows:

When the certificate store type is PFXFile, this property must be set to the name of the file. When the type is PFXBlob, the property must be set to the binary contents of a PFX file (i.e. PKCS12 certificate store).

CertStorePassword Property (AS3Receiver Module)

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

Syntax

• Swift
• Objective-C

public var certStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certStorePassword,setter=setCertStorePassword:) NSString* certStorePassword;

- (NSString*)certStorePassword;
- (void)setCertStorePassword :(NSString*)newCertStorePassword;

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.

CertStoreType Property (AS3Receiver Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var certStoreType: As3receiverCertStoreTypes {
  get {...}
  set {...}
}

public enum As3receiverCertStoreTypes: Int32 {
  case cstUser = 0
  case cstMachine = 1
  case cstPFXFile = 2
  case cstPFXBlob = 3
  case cstJKSFile = 4
  case cstJKSBlob = 5
  case cstPEMKeyFile = 6
  case cstPEMKeyBlob = 7
  case cstPublicKeyFile = 8
  case cstPublicKeyBlob = 9
  case cstSSHPublicKeyBlob = 10
  case cstP7BFile = 11
  case cstP7BBlob = 12
  case cstSSHPublicKeyFile = 13
  case cstPPKFile = 14
  case cstPPKBlob = 15
  case cstXMLFile = 16
  case cstXMLBlob = 17
  case cstJWKFile = 18
  case cstJWKBlob = 19
  case cstSecurityKey = 20
  case cstBCFKSFile = 21
  case cstBCFKSBlob = 22
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=certStoreType,setter=setCertStoreType:) int certStoreType;

- (int)certStoreType;
- (void)setCertStoreType :(int)newCertStoreType;

Default Value

0

Remarks

This is 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:

CertSubject Property (AS3Receiver Module)

This is the subject of the certificate used for client authentication.

Syntax

• Swift
• Objective-C

public var certSubject: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=certSubject,setter=setCertSubject:) NSString* certSubject;

- (NSString*)certSubject;
- (void)setCertSubject :(NSString*)newCertSubject;

Default Value

""

Remarks

This is the subject of the certificate used for client authentication.

This property must be set after all other certificate properites are set. When this property is set, a search is performed in the current certificate store certificate with 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 displayed below.

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

If an error occurs when setting this property an error will not be thrown. This property has a related method which will throw an error:

public func setCertSubject(certSubject: String) throws

CompressionFormat Property (AS3Receiver Module)

The compression format used on the incoming message.

Syntax

• Swift
• Objective-C

public var compressionFormat: As3receiverCompressionFormats {
  get {...}
}

public enum As3receiverCompressionFormats: Int32 {
  case cfNone = 0
  case cfZLIB = 1
}

@property (nonatomic,readonly,assign,getter=compressionFormat) int compressionFormat;

- (int)compressionFormat;

Default Value

0

Remarks

The compression format used on the incoming message, if any. Compressed messages will automatically be decompressed by the class.

This property is read-only.

Connected Property (AS3Receiver Module)

This shows whether the module is connected.

Syntax

• Swift
• Objective-C

public var connected: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=connected,setter=setConnected:) BOOL connected;

- (BOOL)connected;
- (void)setConnected :(BOOL)newConnected;

Default Value

False

Remarks

This property is used to determine whether or not the class is connected to the remote host.

Note: It is recommended to use the Connect or Disconnect method instead of setting this property.

EDIData Property (AS3Receiver Module)

The EDI data sent in Request .

Syntax

• Swift
• Objective-C

public var ediData: EDIData {
  get {...}
}

@property (nonatomic,readonly,assign,getter=EDIData) NSString* EDIData;

- (NSString*)EDIData;

@property (nonatomic,readonly,assign,getter=EDIDataB) NSData* EDIDataB;

- (NSData*)EDIDataB;
@property (nonatomic,readonly,assign,getter=EDIType) NSString* EDIType;

- (NSString*)EDIType;

@property (nonatomic,readonly,assign,getter=EDIFilename) NSString* EDIFilename;

- (NSString*)EDIFilename;

@property (nonatomic,readonly,assign,getter=EDIName) NSString* EDIName;

- (NSString*)EDIName;

 

Default Value

""

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

Firewall Property (AS3Receiver Module)

A set of properties related to firewall access.

Syntax

• Swift
• Objective-C

public var firewall: Firewall {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=firewallAutoDetect,setter=setFirewallAutoDetect:) BOOL firewallAutoDetect;

- (BOOL)firewallAutoDetect;
- (void)setFirewallAutoDetect :(BOOL)newFirewallAutoDetect;

@property (nonatomic,readwrite,assign,getter=firewallType,setter=setFirewallType:) int firewallType;

- (int)firewallType;
- (void)setFirewallType :(int)newFirewallType;

@property (nonatomic,readwrite,assign,getter=firewallHost,setter=setFirewallHost:) NSString* firewallHost;

- (NSString*)firewallHost;
- (void)setFirewallHost :(NSString*)newFirewallHost;

@property (nonatomic,readwrite,assign,getter=firewallPassword,setter=setFirewallPassword:) NSString* firewallPassword;

- (NSString*)firewallPassword;
- (void)setFirewallPassword :(NSString*)newFirewallPassword;

@property (nonatomic,readwrite,assign,getter=firewallPort,setter=setFirewallPort:) int firewallPort;

- (int)firewallPort;
- (void)setFirewallPort :(int)newFirewallPort;

@property (nonatomic,readwrite,assign,getter=firewallUser,setter=setFirewallUser:) NSString* firewallUser;

- (NSString*)firewallUser;
- (void)setFirewallUser :(NSString*)newFirewallUser;

 

Default Value

""

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

FTPCommand Property (AS3Receiver Module)

An FTP command to be sent directly to the FTP server.

Syntax

• Swift
• Objective-C

public var ftpCommand: String {  set {...}
}

@property (nonatomic,readwrite,assign,getter=FTPCommand,setter=setFTPCommand:) NSString* FTPCommand;

- (NSString*)FTPCommand;
- (void)setFTPCommand :(NSString*)newFTPCommand;

Default Value

""

Remarks

An FTP command to be sent directly to the FTP server.

This property is write-only.

FTPLastReply Property (AS3Receiver Module)

The last reply from the FTP server.

Syntax

• Swift
• Objective-C

public var ftpLastReply: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=FTPLastReply) NSString* FTPLastReply;

- (NSString*)FTPLastReply;

Default Value

""

Remarks

The last reply from the FTP server.

This property is read-only.

LocalHost Property (AS3Receiver Module)

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

Syntax

• Swift
• Objective-C

public var localHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=localHost,setter=setLocalHost:) NSString* localHost;

- (NSString*)localHost;
- (void)setLocalHost :(NSString*)newLocalHost;

Default Value

""

Remarks

The LocalHost 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 multi-homed hosts (machines with more than one IP interface) setting LocalHost to the value of an interface will make the class initiate connections (or accept in the case of server classs) only through that interface.

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 multi-homed 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.

LogDirectory Property (AS3Receiver Module)

The path to a directory for logging.

Syntax

• Swift
• Objective-C

public var logDirectory: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=logDirectory,setter=setLogDirectory:) NSString* logDirectory;

- (NSString*)logDirectory;
- (void)setLogDirectory :(NSString*)newLogDirectory;

Default Value

""

Remarks

Setting LogDirectory will instruct the component to log the details of each transmission to unique files in the specified directory. For each request processed, the class will log the original EDI data, the complete text of the outgoing request and the incoming response.

The class will write a file for each transmission, with extension ".log". In case of error an additional file will be written with extension ".err", and the error will be reported in both files. Raw AS3 messages created or downloaded by the class will be written with extension ".as3", and MDNs created or downloaded will be written with extension ".as3-mdn".

The filenames will be chosen automatically by the class. Each filename will be the system time, in the format YYYY-MM-DD-HH-MM-SS-MMMM, with extensions "-2", "-3", used in case files of those names already exist. After each transaction is processed LogFile will contain the name of the files just written, minus the extension ".log" or ".err".

If logs cannot be written an exception will be thrown.

LogFile Property (AS3Receiver Module)

The log file written.

Syntax

• Swift
• Objective-C

public var logFile: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=logFile) NSString* logFile;

- (NSString*)logFile;

Default Value

""

Remarks

In case LogDirectory is specified two log files will be written in the specified directory and LogFile will contain the path.

LogFile will in fact refer to several files with appropriate extensions. A diagnostic log will be written with filename LogFile + ".log", and any EDI data read will be written with filename LogFile + ".dat". Raw AS3 messages and MDNs will also be written with extensions ".as3" and ".as3-mdn".

This property is read-only.

MDNReceipt Property (AS3Receiver Module)

The MDN-based receipt generated by the module.

Syntax

• Swift
• Objective-C

public var mdnReceipt: MDNReceipt {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=MDNReceiptContent,setter=setMDNReceiptContent:) NSString* MDNReceiptContent;

- (NSString*)MDNReceiptContent;
- (void)setMDNReceiptContent :(NSString*)newMDNReceiptContent;

@property (nonatomic,readwrite,assign,getter=MDNReceiptContentB,setter=setMDNReceiptContentB:) NSData* MDNReceiptContentB;

- (NSData*)MDNReceiptContentB;
- (void)setMDNReceiptContentB :(NSData*)newMDNReceiptContent;
@property (nonatomic,readonly,assign,getter=MDNReceiptHeaderCount) int MDNReceiptHeaderCount;

- (int)MDNReceiptHeaderCount;

@property (nonatomic,readonly,assign,getter=MDNReceiptHeaderField) NSString* MDNReceiptHeaderField;

- (NSString*)MDNReceiptHeaderField;

@property (nonatomic,readwrite,assign,getter=MDNReceiptHeaderIndex,setter=setMDNReceiptHeaderIndex:) int MDNReceiptHeaderIndex;

- (int)MDNReceiptHeaderIndex;
- (void)setMDNReceiptHeaderIndex :(int)newMDNReceiptHeaderIndex;

@property (nonatomic,readwrite,assign,getter=MDNReceiptHeaders,setter=setMDNReceiptHeaders:) NSString* MDNReceiptHeaders;

- (NSString*)MDNReceiptHeaders;
- (void)setMDNReceiptHeaders :(NSString*)newMDNReceiptHeaders;

@property (nonatomic,readonly,assign,getter=MDNReceiptHeaderValue) NSString* MDNReceiptHeaderValue;

- (NSString*)MDNReceiptHeaderValue;

@property (nonatomic,readonly,assign,getter=MDNReceiptMDN) NSString* MDNReceiptMDN;

- (NSString*)MDNReceiptMDN;

@property (nonatomic,readonly,assign,getter=MDNReceiptMessage) NSString* MDNReceiptMessage;

- (NSString*)MDNReceiptMessage;

@property (nonatomic,readonly,assign,getter=MDNReceiptMICValue) NSString* MDNReceiptMICValue;

- (NSString*)MDNReceiptMICValue;

@property (nonatomic,readonly,assign,getter=MDNReceiptSigningProtocol) NSString* MDNReceiptSigningProtocol;

- (NSString*)MDNReceiptSigningProtocol;

 

Default Value

""

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

MDNTo Property (AS3Receiver Module)

The URL for the Message Disposition Notification (MDN).

Syntax

• Swift
• Objective-C

public var mdnTo: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=MDNTo,setter=setMDNTo:) NSString* MDNTo;

- (NSString*)MDNTo;
- (void)setMDNTo :(NSString*)newMDNTo;

Default Value

""

Remarks

MDNTo corresponds to the Disposition-Notification-To header of RequestHeaders. If nonempty, the client has requested that an MDN-based receipt be returned to the URL specified. This receipt will be generated in a call to ProcessRequest or CreateMDNReceipt, and may be sent by calling SendResponse.

The receipt and headers will be contained in MDNReceipt.

According to RFC specifications, MDNReceipt must be sent if requested by the client.

MessageId Property (AS3Receiver Module)

The message ID of the incoming message.

Syntax

• Swift
• Objective-C

public var messageId: String {
  get {...}
}

@property (nonatomic,readonly,assign,getter=messageId) NSString* messageId;

- (NSString*)messageId;

Default Value

""

Remarks

MessageId corresponds to the Message-Id header of Request, and will be used as the Original-Message-Id header of MDNReceipt.

This property is read-only.

Passive Property (AS3Receiver Module)

This controls whether or not to direct the server into a passive mode. It is recommended if behind a firewall.

Syntax

• Swift
• Objective-C

public var passive: Bool {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=passive,setter=setPassive:) BOOL passive;

- (BOOL)passive;
- (void)setPassive :(BOOL)newPassive;

Default Value

True

Remarks

This property controls whether or not to direct the server into a passive mode. Many firewalls will not allow the FTP server to open a connection from outside to the higher ports where the FTP client class expects them to be. If Passive is set to TRUE, the class will use the PASV command instead of the PORT command and thus will direct the server into a passive mode: connections are initiated only by the client.

Password Property (AS3Receiver Module)

This is the password used to log in.

Syntax

• Swift
• Objective-C

public var password: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=password,setter=setPassword:) NSString* password;

- (NSString*)password;
- (void)setPassword :(NSString*)newPassword;

Default Value

""

Remarks

This property contains the password used to log in. It must be set before the class connects to the FTP server.

RemoteHost Property (AS3Receiver Module)

This is the domain name or IP address of the FTP server.

Syntax

• Swift
• Objective-C

public var remoteHost: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=remoteHost,setter=setRemoteHost:) NSString* remoteHost;

- (NSString*)remoteHost;
- (void)setRemoteHost :(NSString*)newRemoteHost;

Default Value

""

Remarks

This property specifies the IP address (IP number in dotted internet format) or the domain name of the FTP server. It is set before a connection is attempted and cannot be changed once a connection is in progress.

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

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

RemotePath Property (AS3Receiver Module)

This is the current path in the FTP server.

Syntax

• Swift
• Objective-C

public var remotePath: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=remotePath,setter=setRemotePath:) NSString* remotePath;

- (NSString*)remotePath;
- (void)setRemotePath :(NSString*)newRemotePath;

Default Value

""

Remarks

This property shows the current working directory on the FTP server. It also can be used to change the working directory by setting it to an absolute directory path, or a relative path with respect to the existing value of this property.

If the first two bytes of the new path are "..", then a change to one level higher in the directory tree is performed.

Setting this property causes the class to send the appropriate command to the remote server only if it is connected.

Example 1. Changing Directory:

FTPControl.Logon() FTPControl.RemotePath = "/home/user"

RemotePort Property (AS3Receiver Module)

This is the port for the FTP service (default is 21).

Syntax

• Swift
• Objective-C

public var remotePort: Int32 {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=remotePort,setter=setRemotePort:) int remotePort;

- (int)remotePort;
- (void)setRemotePort :(int)newRemotePort;

Default Value

21

Remarks

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

For an implicit Secure Sockets Layer (SSL), use port 990 (please see the SSLStartMode property for more information).

Request Property (AS3Receiver Module)

The AS3 request to process.

Syntax

• Swift
• Objective-C

public var request: String {
  get {...}
  set {...}
}

public var requestB: Data {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=request,setter=setRequest:) NSString* request;

- (NSString*)request;
- (void)setRequest :(NSString*)newRequest;

@property (nonatomic,readwrite,assign,getter=requestB,setter=setRequestB:) NSData* requestB;

- (NSData*)requestB;
- (void)setRequestB :(NSData*)newRequest;

Default Value

""

Remarks

You may specify the request manually, or you may load the request from the FTP server by invoking ReadRequest.

The request may contain the AS3 headers, or these may be specified separately in RequestHeaders. Any methods which read or process the request will split the request into headers and body and populate Request and RequestHeaders appropriately.

RequestHeaders Property (AS3Receiver Module)

The headers in the AS3 request.

Syntax

• Swift
• Objective-C

public var requestHeaders: Array<Header> {
  get {...}
}

@property (nonatomic,readwrite,assign,getter=requestHeaderCount,setter=setRequestHeaderCount:) int requestHeaderCount;

- (int)requestHeaderCount;
- (void)setRequestHeaderCount :(int)newRequestHeaderCount;

- (NSString*)requestHeaderField:(int)requestHeaderIndex;
- (void)setRequestHeaderField:(int)requestHeaderIndex :(NSString*)newRequestHeaderField;

- (NSString*)requestHeaderValue:(int)requestHeaderIndex;
- (void)setRequestHeaderValue:(int)requestHeaderIndex :(NSString*)newRequestHeaderValue;

 

Default Value

""

Remarks

This property contains the user identifier to be used when logging in. It must be set before the class connects to the FTP server.

RequestHeadersString Property (AS3Receiver Module)

The headers in the AS3 request.

Syntax

• Swift
• Objective-C

public var requestHeadersString: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=requestHeadersString,setter=setRequestHeadersString:) NSString* requestHeadersString;

- (NSString*)requestHeadersString;
- (void)setRequestHeadersString :(NSString*)newRequestHeadersString;

Default Value

""

Remarks

The headers will be parsed from the request by calls to methods such as ParseHeaders, ParseRequest, or ProcessRequest is invoked.

ScanResult Property (AS3Receiver Module)

The result of invoking ParseRequest .

Syntax

• Swift
• Objective-C

public var scanResult: Int32 {
  get {...}
}

@property (nonatomic,readonly,assign,getter=scanResult) int scanResult;

- (int)scanResult;

Default Value

0

Remarks

ScanResult will contain information about any errors that occurred while invoking ParseRequest or ProcessRequest. ScanResult will contain 0 if no errors occurred, otherwise it will contain one or more of the following errors. If multiple errors are reported the results will be OR-ed together.

This property is read-only.

SignerCertEncoded Property (AS3Receiver Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

public var signerCertEncoded: String {
  get {...}
  set {...}
}

public var signerCertEncodedB: Data {
  get {...}
  set {...}
}