AS2ProfileMgr Module

Properties   Methods   Events   Config Settings   Errors  

The AS2ProfileMgr module is used to manage self and trading partner profiles used for AS2 communication.

Syntax

IPWorksEDI.As2profilemgr

Remarks

AS2 communication require management of several configuration settings such as encryption certificate, signing certificate and TLS/SSL certificates. Both for your self and your trading partners.

The AS2ProfileMgr class allows you to manage such settings using simple XML files, furthermore these configuration files can be directly fed to the AS2Sender and AS2Receiver Class as a convenient way to set communication parameters.

To use the AS2ProfileMgr you should first set DataDir to configure the directory that it will use to store the profiles. You can then set the properties to be retained and save them by invoking SaveProfile, alternatively you could retrieve previously saved settings using LoadProfile.

When a new trading partner profile is saved a sub-directory named after the trading partner is created within DataDir and the file partner.cfg is saved in it. If CreateDirStruct is set to true, the following sub-directories are created within the partner directory. These can be helpful in managing other data for the trading partner.

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.

AsyncMDNURL Property (AS2ProfileMgr Module)

The URL for posting Async MDNs.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=asyncMDNURL,setter=setAsyncMDNURL:) NSString* asyncMDNURL;

- (NSString*)asyncMDNURL;
- (void)setAsyncMDNURL :(NSString*)newAsyncMDNURL;

Default Value

""

Remarks

This is the URL to which your trading partners would post Async MDNs, if you choose to get asynchronous notifications. The choice of receiving asynchronous notifications can be made on a per partner basis and is reflected in RequestMDNSynchronous.

CreateDirStruct Property (AS2ProfileMgr Module)

Option to create file management directories.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=createDirStruct,setter=setCreateDirStruct:) BOOL createDirStruct;

- (BOOL)createDirStruct;
- (void)setCreateDirStruct :(BOOL)newCreateDirStruct;

Default Value

True

Remarks

Set CreateDirStruct to false if you would like AS2ProfileMgr not to create file management directories. These are created for a trading partner when SaveProfile is invoked.

DataDir Property (AS2ProfileMgr Module)

The directory that the AS2ProfileMgr uses to store self and trading partner profiles.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=dataDir,setter=setDataDir:) NSString* dataDir;

- (NSString*)dataDir;
- (void)setDataDir :(NSString*)newDataDir;

Default Value

""

Remarks

AS2ProfileMgr uses DataDir to store self and trading partner configuration. The self profile is stored in the XML file me.cfg and the trading partner profiles are stored in the XML file partner.cfg. The partner.cfg is stored in a separate sub-directory for each trading partner. The sub-directory name is derived from the parameter PartnerOrganization of SaveProfile.

DirDeleted Property (AS2ProfileMgr Module)

The directory used to store deleted files.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)dirDeleted;

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing deleted files would have been created. The path to this directory can be read from DirDeleted after invoking LoadProfile.

This property is read-only.

DirIncoming Property (AS2ProfileMgr Module)

The directory used to store incoming files.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)dirIncoming;

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing incoming files would have been created. The path to this directory can be read from DirIncoming after invoking LoadProfile.

This property is read-only.

DirLogs Property (AS2ProfileMgr Module)

The directory used to store log files.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)dirLogs;

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing log files would have been created. The path to this directory can be read from DirLogs after invoking LoadProfile.

This property is read-only.

DirOutgoing Property (AS2ProfileMgr Module)

The directory used to store outgoing files.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)dirOutgoing;

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing outgoing files would have been created. The path to this directory can be read from DirOutgoing after invoking LoadProfile.

This property is read-only.

DirPending Property (AS2ProfileMgr Module)

The directory used to store files waiting for Async MDN.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)dirPending;

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing files waiting for Async MDN would have been created. The path to this directory can be read from DirPending after invoking LoadProfile.

This property is read-only.

DirPendingInfo Property (AS2ProfileMgr Module)

The directory used to store files containing data to verify Async MDN.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)dirPendingInfo;

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing files containing data for Async MDN verification would have been created. The path to this directory can be read from DirPendingInfo after invoking LoadProfile.

This property is read-only.

DirSent Property (AS2ProfileMgr Module)

The directory used to store sent files.

Syntax

• Swift
• Objective-C

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

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

- (NSString*)dirSent;

Default Value

""

Remarks

If CreateDirStruct was true when SaveProfile was invoked a directory for storing sent files would have been created. The path to this directory can be read from DirSent after invoking LoadProfile.

This property is read-only.

Email Property (AS2ProfileMgr Module)

Your email address.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=email,setter=setEmail:) NSString* email;

- (NSString*)email;
- (void)setEmail :(NSString*)newEmail;

Default Value

""

Remarks

Email is used to store your email address. The email address is used to request a MDN. It is simply used as a token to request a MDN, it does not imply that the MDN would be sent to this address. Please refer to the property MDNTo in AS2Sender for details.

After invoking LoadProfile, the Email will contain your currently configured email address, alternatively Email may be set and saved by invoking SaveProfile.

EncryptionCertEncoded Property (AS2ProfileMgr Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=encryptionCertEncoded,setter=setEncryptionCertEncoded:) NSString* encryptionCertEncoded;

- (NSString*)encryptionCertEncoded;
- (void)setEncryptionCertEncoded :(NSString*)newEncryptionCertEncoded;

@property (nonatomic,readwrite,assign,getter=encryptionCertEncodedB,setter=setEncryptionCertEncodedB:) NSData* encryptionCertEncodedB;

- (NSData*)encryptionCertEncodedB;
- (void)setEncryptionCertEncodedB :(NSData*)newEncryptionCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The EncryptionCertStore and EncryptionCertSubject properties also may be used to specify a certificate.

When EncryptionCertEncoded is set, a search is initiated in the current EncryptionCertStore for the private key of the certificate. If the key is found, EncryptionCertSubject is updated to reflect the full subject of the selected certificate; otherwise, EncryptionCertSubject 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 setEncryptionCertEncodedB(encryptionCertEncoded: Data) throws
public func setEncryptionCertEncoded(encryptionCertEncoded: String) throws

EncryptionCertStore Property (AS2ProfileMgr Module)

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

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=encryptionCertStore,setter=setEncryptionCertStore:) NSString* encryptionCertStore;

- (NSString*)encryptionCertStore;
- (void)setEncryptionCertStore :(NSString*)newEncryptionCertStore;

@property (nonatomic,readwrite,assign,getter=encryptionCertStoreB,setter=setEncryptionCertStoreB:) NSData* encryptionCertStoreB;

- (NSData*)encryptionCertStoreB;
- (void)setEncryptionCertStoreB :(NSData*)newEncryptionCertStore;

Default Value

"MY"

Remarks

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

The EncryptionCertStoreType property denotes the type of the certificate store specified by EncryptionCertStore. If the store is password protected, specify the password in EncryptionCertStorePassword.

EncryptionCertStore is used in conjunction with the EncryptionCertSubject property to specify client certificates. If EncryptionCertStore has a value, and EncryptionCertSubject or EncryptionCertEncoded is set, a search for a certificate is initiated. Please see the EncryptionCertSubject 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).

EncryptionCertStorePassword Property (AS2ProfileMgr 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 encryptionCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=encryptionCertStorePassword,setter=setEncryptionCertStorePassword:) NSString* encryptionCertStorePassword;

- (NSString*)encryptionCertStorePassword;
- (void)setEncryptionCertStorePassword :(NSString*)newEncryptionCertStorePassword;

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.

EncryptionCertStoreType Property (AS2ProfileMgr Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var encryptionCertStoreType: As2profilemgrEncryptionCertStoreTypes {
  get {...}
  set {...}
}

public enum As2profilemgrEncryptionCertStoreTypes: 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 cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=encryptionCertStoreType,setter=setEncryptionCertStoreType:) int encryptionCertStoreType;

- (int)encryptionCertStoreType;
- (void)setEncryptionCertStoreType :(int)newEncryptionCertStoreType;

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:

EncryptionCertSubject Property (AS2ProfileMgr Module)

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

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=encryptionCertSubject,setter=setEncryptionCertSubject:) NSString* encryptionCertSubject;

- (NSString*)encryptionCertSubject;
- (void)setEncryptionCertSubject :(NSString*)newEncryptionCertSubject;

Default Value

""

Remarks

This is 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 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 setEncryptionCertSubject(encryptionCertSubject: String) throws

OptionCompress Property (AS2ProfileMgr Module)

Preference to compress outgoing data.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=optionCompress,setter=setOptionCompress:) BOOL optionCompress;

- (BOOL)optionCompress;
- (void)setOptionCompress :(BOOL)newOptionCompress;

Default Value

False

Remarks

OptionCompress is used to store your preference of compressing the data sent to your trading partner.

After invoking LoadProfile, the OptionCompress will contain your compression preference for your trading partner, alternatively OptionCompress may be set and saved by invoking SaveProfile.

OptionEncrypt Property (AS2ProfileMgr Module)

Preference to encrypt outgoing data.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=optionEncrypt,setter=setOptionEncrypt:) BOOL optionEncrypt;

- (BOOL)optionEncrypt;
- (void)setOptionEncrypt :(BOOL)newOptionEncrypt;

Default Value

False

Remarks

OptionEncrypt is used to store your preference of encrypting data sent to your trading partner. If OptionEncrypt is set to true EncryptionCert must be specified.

After invoking LoadProfile, the OptionEncrypt will contain your encryption preference for your trading partner, alternatively OptionEncrypt may be set and saved by invoking SaveProfile.

OptionSign Property (AS2ProfileMgr Module)

Preference to sign outgoing data.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=optionSign,setter=setOptionSign:) BOOL optionSign;

- (BOOL)optionSign;
- (void)setOptionSign :(BOOL)newOptionSign;

Default Value

False

Remarks

OptionSign is used to store your preference of signing the data sent to your trading partner.

After invoking LoadProfile, the OptionSign will contain your signing preference for your trading partner, alternatively OptionSign may be set and saved by invoking SaveProfile.

Organization Property (AS2ProfileMgr Module)

The name of your, or your trading partner's organization.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=organization,setter=setOrganization:) NSString* organization;

- (NSString*)organization;
- (void)setOrganization :(NSString*)newOrganization;

Default Value

""

Remarks

Generally, Organization is used to store your, or your trading partner's AS2 identifier. It is used to configure or verify AS2From and AS2To in AS2Sender and AS2Receiver classs.

Invoking LoadProfile reads the AS2 identifier into Organization, alternatively you can save the AS2 identifier by setting Organization and invoking SaveProfile.

PartnerCount Property (AS2ProfileMgr Module)

The number of partners found in DataDir .

Syntax

• Swift
• Objective-C

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

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

- (int)partnerCount;

Default Value

0

Remarks

This property returns the number of partners found in DataDir. This proprety is populated after calling ListPartners.

This property is read-only.

RequestMDN Property (AS2ProfileMgr Module)

Preference to receive MDNs from trading partner.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=requestMDN,setter=setRequestMDN:) BOOL requestMDN;

- (BOOL)requestMDN;
- (void)setRequestMDN :(BOOL)newRequestMDN;

Default Value

False

Remarks

RequireMDN is used to store your preference of receiving MDNs for the messages you send to your trading partner.

After invoking LoadProfile, the RequireMDN will contain your preference of receiving MDNs, alternatively RequireMDN may be set and saved by invoking SaveProfile.

RequestMDNSigned Property (AS2ProfileMgr Module)

Preference to request for signed MDNs.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=requestMDNSigned,setter=setRequestMDNSigned:) BOOL requestMDNSigned;

- (BOOL)requestMDNSigned;
- (void)setRequestMDNSigned :(BOOL)newRequestMDNSigned;

Default Value

True

Remarks

MDNRequestSigned is used to store your preference of requesting signed MDNs from your trading partner.

After invoking LoadProfile, the MDNRequestSigned will contain your preference of requesting signed MDNs, alternatively MDNRequestSigned may be set and saved by invoking SaveProfile.

RequestMDNSynchronous Property (AS2ProfileMgr Module)

Preference to request for synchronous MDNs.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=requestMDNSynchronous,setter=setRequestMDNSynchronous:) BOOL requestMDNSynchronous;

- (BOOL)requestMDNSynchronous;
- (void)setRequestMDNSynchronous :(BOOL)newRequestMDNSynchronous;

Default Value

True

Remarks

MDNRequestSynchronous is used to store your preference of requesting synchronous MDNs from your trading partner.

After invoking LoadProfile, the MDNRequestSynchronous will contain your preference of requesting synchronous MDNs, alternatively MDNRequestSynchronous may be set and saved by invoking SaveProfile.

RequireEncrypt Property (AS2ProfileMgr Module)

Preference to receive encrypted messages.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=requireEncrypt,setter=setRequireEncrypt:) BOOL requireEncrypt;

- (BOOL)requireEncrypt;
- (void)setRequireEncrypt :(BOOL)newRequireEncrypt;

Default Value

False

Remarks

RequireEncrypt is used to store your preference of receiving encrypted messages from your trading partner.

After invoking LoadProfile, the RequireEncrypt will contain your preference of receiving encrypted messages, alternatively RequireEncrypt may be set and saved by invoking SaveProfile.

RequireSign Property (AS2ProfileMgr Module)

Preference to receive signed messages.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=requireSign,setter=setRequireSign:) BOOL requireSign;

- (BOOL)requireSign;
- (void)setRequireSign :(BOOL)newRequireSign;

Default Value

False

Remarks

RequireSign is used to store your preference of receiving signed messages from your trading partner.

After invoking LoadProfile, the RequireSign will contain your preference of receiving signed messages, alternatively RequireSign may be set and saved by invoking SaveProfile.

SigningCertEncoded Property (AS2ProfileMgr Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=signingCertEncoded,setter=setSigningCertEncoded:) NSString* signingCertEncoded;

- (NSString*)signingCertEncoded;
- (void)setSigningCertEncoded :(NSString*)newSigningCertEncoded;

@property (nonatomic,readwrite,assign,getter=signingCertEncodedB,setter=setSigningCertEncodedB:) NSData* signingCertEncodedB;

- (NSData*)signingCertEncodedB;
- (void)setSigningCertEncodedB :(NSData*)newSigningCertEncoded;

Default Value

""

Remarks

This is the certificate (PEM/base64 encoded). This property is used to assign a specific certificate. The SigningCertStore and SigningCertSubject properties also may be used to specify a certificate.

When SigningCertEncoded is set, a search is initiated in the current SigningCertStore for the private key of the certificate. If the key is found, SigningCertSubject is updated to reflect the full subject of the selected certificate; otherwise, SigningCertSubject 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 setSigningCertEncodedB(signingCertEncoded: Data) throws
public func setSigningCertEncoded(signingCertEncoded: String) throws

SigningCertStore Property (AS2ProfileMgr Module)

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

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=signingCertStore,setter=setSigningCertStore:) NSString* signingCertStore;

- (NSString*)signingCertStore;
- (void)setSigningCertStore :(NSString*)newSigningCertStore;

@property (nonatomic,readwrite,assign,getter=signingCertStoreB,setter=setSigningCertStoreB:) NSData* signingCertStoreB;

- (NSData*)signingCertStoreB;
- (void)setSigningCertStoreB :(NSData*)newSigningCertStore;

Default Value

"MY"

Remarks

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

The SigningCertStoreType property denotes the type of the certificate store specified by SigningCertStore. If the store is password protected, specify the password in SigningCertStorePassword.

SigningCertStore is used in conjunction with the SigningCertSubject property to specify client certificates. If SigningCertStore has a value, and SigningCertSubject or SigningCertEncoded is set, a search for a certificate is initiated. Please see the SigningCertSubject 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).

SigningCertStorePassword Property (AS2ProfileMgr 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 signingCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=signingCertStorePassword,setter=setSigningCertStorePassword:) NSString* signingCertStorePassword;

- (NSString*)signingCertStorePassword;
- (void)setSigningCertStorePassword :(NSString*)newSigningCertStorePassword;

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.

SigningCertStoreType Property (AS2ProfileMgr Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var signingCertStoreType: As2profilemgrSigningCertStoreTypes {
  get {...}
  set {...}
}

public enum As2profilemgrSigningCertStoreTypes: 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 cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=signingCertStoreType,setter=setSigningCertStoreType:) int signingCertStoreType;

- (int)signingCertStoreType;
- (void)setSigningCertStoreType :(int)newSigningCertStoreType;

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:

SigningCertSubject Property (AS2ProfileMgr Module)

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

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=signingCertSubject,setter=setSigningCertSubject:) NSString* signingCertSubject;

- (NSString*)signingCertSubject;
- (void)setSigningCertSubject :(NSString*)newSigningCertSubject;

Default Value

""

Remarks

This is 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 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 setSigningCertSubject(signingCertSubject: String) throws

SSLCertEncoded Property (AS2ProfileMgr Module)

This is the certificate (PEM/base64 encoded).

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=SSLCertEncoded,setter=setSSLCertEncoded:) NSString* SSLCertEncoded;

- (NSString*)SSLCertEncoded;
- (void)setSSLCertEncoded :(NSString*)newSSLCertEncoded;

@property (nonatomic,readwrite,assign,getter=SSLCertEncodedB,setter=setSSLCertEncodedB:) NSData* SSLCertEncodedB;

- (NSData*)SSLCertEncodedB;
- (void)setSSLCertEncodedB :(NSData*)newSSLCertEncoded;

Default Value

""

Remarks

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

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 setSSLCertEncodedB(sslCertEncoded: Data) throws
public func setSSLCertEncoded(sslCertEncoded: String) throws

SSLCertStore Property (AS2ProfileMgr Module)

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

Syntax

• Swift
• Objective-C

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

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

@property (nonatomic,readwrite,assign,getter=SSLCertStore,setter=setSSLCertStore:) NSString* SSLCertStore;

- (NSString*)SSLCertStore;
- (void)setSSLCertStore :(NSString*)newSSLCertStore;

@property (nonatomic,readwrite,assign,getter=SSLCertStoreB,setter=setSSLCertStoreB:) NSData* SSLCertStoreB;

- (NSData*)SSLCertStoreB;
- (void)setSSLCertStoreB :(NSData*)newSSLCertStore;

Default Value

"MY"

Remarks

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

SSLCertStorePassword Property (AS2ProfileMgr 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 sslCertStorePassword: String {
  get {...}
  set {...}
}

@property (nonatomic,readwrite,assign,getter=SSLCertStorePassword,setter=setSSLCertStorePassword:) NSString* SSLCertStorePassword;

- (NSString*)SSLCertStorePassword;
- (void)setSSLCertStorePassword :(NSString*)newSSLCertStorePassword;

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.

SSLCertStoreType Property (AS2ProfileMgr Module)

This is the type of certificate store for this certificate.

Syntax

• Swift
• Objective-C

public var sslCertStoreType: As2profilemgrSSLCertStoreTypes {
  get {...}
  set {...}
}

public enum As2profilemgrSSLCertStoreTypes: 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 cstPKCS11 = 23
  case cstAuto = 99
}

@property (nonatomic,readwrite,assign,getter=SSLCertStoreType,setter=setSSLCertStoreType:) int SSLCertStoreType;

- (int)SSLCertStoreType;
- (void)setSSLCertStoreType :(int)newSSLCertStoreType;

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:

SSLCertSubject Property (AS2ProfileMgr Module)

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

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=SSLCertSubject,setter=setSSLCertSubject:) NSString* SSLCertSubject;

- (NSString*)SSLCertSubject;
- (void)setSSLCertSubject :(NSString*)newSSLCertSubject;

Default Value

""

Remarks

This is 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 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 setSSLCertSubject(sslCertSubject: String) throws

URL Property (AS2ProfileMgr Module)

The URL for posting EDI data.

Syntax

• Swift
• Objective-C

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

@property (nonatomic,readwrite,assign,getter=URL,setter=setURL:) NSString* URL;

- (NSString*)URL;
- (void)setURL :(NSString*)newURL;

Default Value

""

Remarks

URL is the URL provided by your trading partner for posting EDI Data. Please refer to the URL property in AS2Sender for details.

In the case of "self" profile i.e. when the parameter partnerIdentifier is "self" in LoadProfile or SaveProfile, URL refers to the URL that your trading partners use to post data to you.

After invoking LoadProfile, the URL will contain the URL of your trading partner, alternatively URL may be set and saved by invoking SaveProfile.

Config Method (AS2ProfileMgr Module)

Sets or retrieves a configuration setting.

Syntax

• Swift
• Objective-C

public func config(configurationString: String) throws -> String

- (NSString*)config:(NSString*)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.

DeleteProfile Method (AS2ProfileMgr Module)

Deletes the configuration of the specified partner.

Syntax

• Swift
• Objective-C

public func deleteProfile(partnerOrganization: String) throws -> Void

- (void)deleteProfile:(NSString*)partnerOrganization;

Remarks

The profile of the partner identified by partnerIdentifier is deleted. This method also deletes the directory in which the partner profile is stored, consequently deleting file management directories of the partner.

If the partnerOrganization specified is "self", the self profile i.e. me.cfg, is cleared.

GetProperty Method (AS2ProfileMgr Module)

Gets the property propName .

Syntax

• Swift
• Objective-C

public func getProperty(propName: String) throws -> String

- (NSString*)getProperty:(NSString*)propName;

Remarks

GetProperty can be used to query any property from "self" or partner profile. It is specially useful in retrieving properties not interpreted by AS2Sender AS2Receiver classs and thus not exposed as AS2ProfileMgr properties.

GetProperty returns null if property propName was not read by LoadProfile.

GetTPInfo Method (AS2ProfileMgr Module)

Gets the profile of the specified partner as a XML TPInfo.

Syntax

• Swift
• Objective-C

public func getTPInfo(partnerOrganization: String) throws -> String

- (NSString*)getTPInfo:(NSString*)partnerOrganization;

Remarks

If the parameter partnerOrganization is "self", GetTPInfo returns a XML string representing the "self" profile otherwise it returns a XML string of partner profile. These strings can be directly fed to AS2Sender and AS2Receiver using the method SetTPInfo.

ListPartners Method (AS2ProfileMgr Module)

Lists trading partners known to the AS2ProfileMgr .

Syntax

• Swift
• Objective-C

public func listPartners() throws -> Void

- (void)listPartners;

Remarks

Invoking ListPartners causes the event Partner to be fired for each trading partner profile found by the AS2ProfileMgr class.

After this method returns PartnerCount is populated with the number of found partners.

ListProperties Method (AS2ProfileMgr Module)

Lists the properties read from self or partner profile.

Syntax

• Swift
• Objective-C

public func listProperties() throws -> Void

- (void)listProperties;

Remarks

Invoking ListProperties causes the event Property to be fired for each property read by LoadProfile.

LoadProfile Method (AS2ProfileMgr Module)

Loads the profile of the trading partner identified by partnerOrganization .

Syntax

• Swift
• Objective-C

public func loadProfile(partnerOrganization: String) throws -> Void

- (void)loadProfile:(NSString*)partnerOrganization;

Remarks

If the partnerOrganization is not "self", the properties of AS2ProfileMgr are read from the XML file partner.cfg. The file is expected to be in a sub-directory within DataDir. The name of the sub-directory is derived from partnerOrganization.

Although all properties are read from the partner profile, the following are interpreted by AS2Sender and AS2Receiver classs.

Partner Settings

• Organization
• URL
• OptionSign
• OptionEncrypt
• OptionCompress
• RequireSign
• RequireEncrypt
• RequestMDN
• RequestMDNSigned
• RequestMDNSynchronous
• EncryptionCert
• SigningCert
• SSLCert

If the partnerOrganization specified is "self", the properties of AS2ProfileMgr are read from the XML file me.cfg. The file is expected to be in DataDir.

Although all properties are read from the self profile, the following are interpreted by AS2Sender and AS2Receiver classs.

My Settings

• Organization
• URL
• Email
• EncryptionCert
• SigningCert
• SSLCert
• AsyncMDNURL

Note: "self" cannot be the name of a trading partner organization.

Reset Method (AS2ProfileMgr Module)

Resets the state of the control.

Syntax

• Swift
• Objective-C

public func reset() throws -> Void

- (void)reset;

Remarks

Resets all properties. After invoking this method the class may be reused as if it were newly created.

SaveProfile Method (AS2ProfileMgr Module)

Saves the profile of the trading partner identified by partnerOrganization .

Syntax

• Swift
• Objective-C

public func saveProfile(partnerOrganization: String) throws -> Void

- (void)saveProfile:(NSString*)partnerOrganization;

Remarks

If the partnerOrganization is not "self", the properties of AS2ProfileMgr are saved to the XML file partner.cfg placed in a sub-directory within DataDir. The name of the sub-directory is derived from partnerOrganization. In addition to saving the partner profile, SaveProfile also creates the following directories if CreateDirStruct is set to true.

Although any number of properties may be saved to the partner profile, the following are interpreted by AS2Sender and AS2Receiver classes.

Partner Settings

• Organization
• URL
• OptionSign
• OptionEncrypt
• OptionCompress
• RequireSign
• RequireEncrypt
• RequestMDN
• RequestMDNSigned
• RequestMDNSynchronous
• EncryptionCert
• SigningCert
• SSLCert

If the partnerOrganization specified is "self", the properties of AS2ProfileMgr are saved to the XML file me.cfg placed in DataDir.

Although any number of properties may be saved to the self profile, the following are interpreted by AS2Sender and AS2Receiver classes.

My Settings

• Organization
• URL
• Email
• EncryptionCert
• SigningCert
• SSLCert
• AsyncMDNURL

Note: "self" cannot be the name of a trading partner organization.

SetProperty Method (AS2ProfileMgr Module)

Sets the property propName to propValue .

Syntax

• Swift
• Objective-C

public func setProperty(propName: String, propValue: String) throws -> Void

- (void)setProperty:(NSString*)propName :(NSString*)propValue;

Remarks

SetProperty can be used to set any property in self or partner profile. It is specially useful in setting properties not interpreted by AS2Sender AS2Receiverclasss and thus not exposed as AS2ProfileMgr properties.

Error Event (AS2ProfileMgr Module)

Information about errors during data delivery.

Syntax

• Swift
• Objective-C

func onError(errorCode: Int32, description: String)

- (void)onError:(int)errorCode :(NSString*)description;

Remarks

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

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.

Partner Event (AS2ProfileMgr Module)

Fired when ListPartners is invoked.

Syntax

• Swift
• Objective-C

func onPartner(partnerIdentifier: String, partnerURL: String)

- (void)onPartner:(NSString*)partnerIdentifier :(NSString*)partnerURL;

Remarks

This event is fired when ListPartners is called. It fires for each partner found by the AS2ProfileMgr in DataDir. The parameter partnerIdentifier is same as provided to SaveProfile to save the partner profile. The URL provided by the trading partner to post AS2 messages can be read from partnerURL.

PartnerDirectory Event (AS2ProfileMgr Module)

Fired before accessing partner.cfg of a trading partner.

Syntax

• Swift
• Objective-C

func onPartnerDirectory(name: String, directory: inout String)

- (void)onPartnerDirectory:(NSString*)name :(NSString**)directory;

Remarks

This event is fired every time partner.cfg needs to be accessed i.e when LoadProfile or GetTPInfo are invoked with partner name not being "self". The Name provides the partner name and Directory indicates the directory in which partner profile is expected. Setting Directory to a different path will make the component look for partner.cfg in that directory. Note: PartnerDirectory event is not fired when ListPartners is invoked.

Property Event (AS2ProfileMgr Module)

Fired when ListProperties is invoked.

Syntax

• Swift
• Objective-C

func onProperty(propName: String, propValue: String)

- (void)onProperty:(NSString*)propName :(NSString*)propValue;

Remarks

This event is fired when ListProperties is called. It fires for each property read by LoadProfile. The parameters propName and propValue provide property name and value respectively.

Config Settings (AS2ProfileMgr Module)

Base Config Settings

Trappable Errors (AS2ProfileMgr Module)

AS2ProfileMgr Errors