AS2ProfileMgr Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

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

AsyncMDNURL Property (AS2ProfileMgr Class)

The URL for posting Async MDNs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetAsyncMDNURL();
int SetAsyncMDNURL(const char* lpszAsyncMDNURL);

Unicode (Windows)
LPWSTR GetAsyncMDNURL();
INT SetAsyncMDNURL(LPCWSTR lpszAsyncMDNURL);

char* ipworksedi_as2profilemgr_getasyncmdnurl(void* lpObj);
int ipworksedi_as2profilemgr_setasyncmdnurl(void* lpObj, const char* lpszAsyncMDNURL);

QString GetAsyncMDNURL();
int SetAsyncMDNURL(QString qsAsyncMDNURL);

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.

Data Type

String

CreateDirStruct Property (AS2ProfileMgr Class)

Option to create file management directories.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetCreateDirStruct();
int SetCreateDirStruct(int bCreateDirStruct);

Unicode (Windows)
BOOL GetCreateDirStruct();
INT SetCreateDirStruct(BOOL bCreateDirStruct);

int ipworksedi_as2profilemgr_getcreatedirstruct(void* lpObj);
int ipworksedi_as2profilemgr_setcreatedirstruct(void* lpObj, int bCreateDirStruct);

bool GetCreateDirStruct();
int SetCreateDirStruct(bool bCreateDirStruct);

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.

Data Type

Boolean

DataDir Property (AS2ProfileMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDataDir();
int SetDataDir(const char* lpszDataDir);

Unicode (Windows)
LPWSTR GetDataDir();
INT SetDataDir(LPCWSTR lpszDataDir);

char* ipworksedi_as2profilemgr_getdatadir(void* lpObj);
int ipworksedi_as2profilemgr_setdatadir(void* lpObj, const char* lpszDataDir);

QString GetDataDir();
int SetDataDir(QString qsDataDir);

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.

Data Type

String

DirDeleted Property (AS2ProfileMgr Class)

The directory used to store deleted files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDirDeleted();

Unicode (Windows)
LPWSTR GetDirDeleted();

char* ipworksedi_as2profilemgr_getdirdeleted(void* lpObj);

QString GetDirDeleted();

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.

Data Type

String

DirIncoming Property (AS2ProfileMgr Class)

The directory used to store incoming files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDirIncoming();

Unicode (Windows)
LPWSTR GetDirIncoming();

char* ipworksedi_as2profilemgr_getdirincoming(void* lpObj);

QString GetDirIncoming();

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.

Data Type

String

DirLogs Property (AS2ProfileMgr Class)

The directory used to store log files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDirLogs();

Unicode (Windows)
LPWSTR GetDirLogs();

char* ipworksedi_as2profilemgr_getdirlogs(void* lpObj);

QString GetDirLogs();

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.

Data Type

String

DirOutgoing Property (AS2ProfileMgr Class)

The directory used to store outgoing files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDirOutgoing();

Unicode (Windows)
LPWSTR GetDirOutgoing();

char* ipworksedi_as2profilemgr_getdiroutgoing(void* lpObj);

QString GetDirOutgoing();

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.

Data Type

String

DirPending Property (AS2ProfileMgr Class)

The directory used to store files waiting for Async MDN.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDirPending();

Unicode (Windows)
LPWSTR GetDirPending();

char* ipworksedi_as2profilemgr_getdirpending(void* lpObj);

QString GetDirPending();

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.

Data Type

String

DirPendingInfo Property (AS2ProfileMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDirPendingInfo();

Unicode (Windows)
LPWSTR GetDirPendingInfo();

char* ipworksedi_as2profilemgr_getdirpendinginfo(void* lpObj);

QString GetDirPendingInfo();

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.

Data Type

String

DirSent Property (AS2ProfileMgr Class)

The directory used to store sent files.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetDirSent();

Unicode (Windows)
LPWSTR GetDirSent();

char* ipworksedi_as2profilemgr_getdirsent(void* lpObj);

QString GetDirSent();

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.

Data Type

String

Email Property (AS2ProfileMgr Class)

Your email address.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetEmail();
int SetEmail(const char* lpszEmail);

Unicode (Windows)
LPWSTR GetEmail();
INT SetEmail(LPCWSTR lpszEmail);

char* ipworksedi_as2profilemgr_getemail(void* lpObj);
int ipworksedi_as2profilemgr_setemail(void* lpObj, const char* lpszEmail);

QString GetEmail();
int SetEmail(QString qsEmail);

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.

Data Type

String

EncryptionCert Property (AS2ProfileMgr Class)

Certificate used for encryption or decryption.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetEncryptionCert();
int SetEncryptionCert(IPWorksEDICertificate* val);

int ipworksedi_as2profilemgr_getencryptioncertstore(void* lpObj, char** lpEncryptionCertStore, int* lenEncryptionCertStore);
int ipworksedi_as2profilemgr_setencryptioncertstore(void* lpObj, const char* lpEncryptionCertStore, int lenEncryptionCertStore);

char* ipworksedi_as2profilemgr_getencryptioncertstorepassword(void* lpObj);
int ipworksedi_as2profilemgr_setencryptioncertstorepassword(void* lpObj, const char* lpszEncryptionCertStorePassword);

int ipworksedi_as2profilemgr_getencryptioncertstoretype(void* lpObj);
int ipworksedi_as2profilemgr_setencryptioncertstoretype(void* lpObj, int iEncryptionCertStoreType);

char* ipworksedi_as2profilemgr_getencryptioncertsubject(void* lpObj);
int ipworksedi_as2profilemgr_setencryptioncertsubject(void* lpObj, const char* lpszEncryptionCertSubject);

int ipworksedi_as2profilemgr_getencryptioncertencoded(void* lpObj, char** lpEncryptionCertEncoded, int* lenEncryptionCertEncoded);
int ipworksedi_as2profilemgr_setencryptioncertencoded(void* lpObj, const char* lpEncryptionCertEncoded, int lenEncryptionCertEncoded);

QByteArray GetEncryptionCertStore();
int SetEncryptionCertStore(QByteArray qbaEncryptionCertStore);

QString GetEncryptionCertStorePassword();
int SetEncryptionCertStorePassword(QString qsEncryptionCertStorePassword);

int GetEncryptionCertStoreType();
int SetEncryptionCertStoreType(int iEncryptionCertStoreType);

QString GetEncryptionCertSubject();
int SetEncryptionCertSubject(QString qsEncryptionCertSubject);

QByteArray GetEncryptionCertEncoded();
int SetEncryptionCertEncoded(QByteArray qbaEncryptionCertEncoded);

Remarks

EncryptionCert for a trading partner, can be set to the path of a file containing the base64 encoded encryption certificate or to the contents of the file itself. It is used by the AS2Sender to encrypt outgoing data. It is also used by AS2Receiver to verify signatures on incoming data if a separate SigningCert is not specified.

While specifying self profile, EncryptionCert should be a pfx file containing a single certificate, private key pair. In this case EncryptionCertPassword must also be specified. EncryptionCert from self profile is used by AS2Receiver to decrypt incoming data. It is also used by AS2Sender to sign outgoing data if a separate SigningCert is not specified.

After invoking LoadProfile, the EncryptionCert will contain the currently saved encryption certificate, alternatively EncryptionCert may be set and saved by invoking SaveProfile.

Data Type

IPWorksEDICertificate

OptionCompress Property (AS2ProfileMgr Class)

Preference to compress outgoing data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOptionCompress();
int SetOptionCompress(int bOptionCompress);

Unicode (Windows)
BOOL GetOptionCompress();
INT SetOptionCompress(BOOL bOptionCompress);

int ipworksedi_as2profilemgr_getoptioncompress(void* lpObj);
int ipworksedi_as2profilemgr_setoptioncompress(void* lpObj, int bOptionCompress);

bool GetOptionCompress();
int SetOptionCompress(bool bOptionCompress);

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.

Data Type

Boolean

OptionEncrypt Property (AS2ProfileMgr Class)

Preference to encrypt outgoing data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOptionEncrypt();
int SetOptionEncrypt(int bOptionEncrypt);

Unicode (Windows)
BOOL GetOptionEncrypt();
INT SetOptionEncrypt(BOOL bOptionEncrypt);

int ipworksedi_as2profilemgr_getoptionencrypt(void* lpObj);
int ipworksedi_as2profilemgr_setoptionencrypt(void* lpObj, int bOptionEncrypt);

bool GetOptionEncrypt();
int SetOptionEncrypt(bool bOptionEncrypt);

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.

Data Type

Boolean

OptionSign Property (AS2ProfileMgr Class)

Preference to sign outgoing data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetOptionSign();
int SetOptionSign(int bOptionSign);

Unicode (Windows)
BOOL GetOptionSign();
INT SetOptionSign(BOOL bOptionSign);

int ipworksedi_as2profilemgr_getoptionsign(void* lpObj);
int ipworksedi_as2profilemgr_setoptionsign(void* lpObj, int bOptionSign);

bool GetOptionSign();
int SetOptionSign(bool bOptionSign);

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.

Data Type

Boolean

Organization Property (AS2ProfileMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetOrganization();
int SetOrganization(const char* lpszOrganization);

Unicode (Windows)
LPWSTR GetOrganization();
INT SetOrganization(LPCWSTR lpszOrganization);

char* ipworksedi_as2profilemgr_getorganization(void* lpObj);
int ipworksedi_as2profilemgr_setorganization(void* lpObj, const char* lpszOrganization);

QString GetOrganization();
int SetOrganization(QString qsOrganization);

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.

Data Type

String

PartnerCount Property (AS2ProfileMgr Class)

The number of partners found in DataDir .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetPartnerCount();

Unicode (Windows)
INT GetPartnerCount();

int ipworksedi_as2profilemgr_getpartnercount(void* lpObj);

int GetPartnerCount();

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 and not available at design time.

Data Type

Integer

RequestMDN Property (AS2ProfileMgr Class)

Preference to receive MDNs from trading partner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestMDN();
int SetRequestMDN(int bRequestMDN);

Unicode (Windows)
BOOL GetRequestMDN();
INT SetRequestMDN(BOOL bRequestMDN);

int ipworksedi_as2profilemgr_getrequestmdn(void* lpObj);
int ipworksedi_as2profilemgr_setrequestmdn(void* lpObj, int bRequestMDN);

bool GetRequestMDN();
int SetRequestMDN(bool bRequestMDN);

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.

Data Type

Boolean

RequestMDNSigned Property (AS2ProfileMgr Class)

Preference to request for signed MDNs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestMDNSigned();
int SetRequestMDNSigned(int bRequestMDNSigned);

Unicode (Windows)
BOOL GetRequestMDNSigned();
INT SetRequestMDNSigned(BOOL bRequestMDNSigned);

int ipworksedi_as2profilemgr_getrequestmdnsigned(void* lpObj);
int ipworksedi_as2profilemgr_setrequestmdnsigned(void* lpObj, int bRequestMDNSigned);

bool GetRequestMDNSigned();
int SetRequestMDNSigned(bool bRequestMDNSigned);

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.

Data Type

Boolean

RequestMDNSynchronous Property (AS2ProfileMgr Class)

Preference to request for synchronous MDNs.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequestMDNSynchronous();
int SetRequestMDNSynchronous(int bRequestMDNSynchronous);

Unicode (Windows)
BOOL GetRequestMDNSynchronous();
INT SetRequestMDNSynchronous(BOOL bRequestMDNSynchronous);

int ipworksedi_as2profilemgr_getrequestmdnsynchronous(void* lpObj);
int ipworksedi_as2profilemgr_setrequestmdnsynchronous(void* lpObj, int bRequestMDNSynchronous);

bool GetRequestMDNSynchronous();
int SetRequestMDNSynchronous(bool bRequestMDNSynchronous);

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.

Data Type

Boolean

RequireEncrypt Property (AS2ProfileMgr Class)

Preference to receive encrypted messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequireEncrypt();
int SetRequireEncrypt(int bRequireEncrypt);

Unicode (Windows)
BOOL GetRequireEncrypt();
INT SetRequireEncrypt(BOOL bRequireEncrypt);

int ipworksedi_as2profilemgr_getrequireencrypt(void* lpObj);
int ipworksedi_as2profilemgr_setrequireencrypt(void* lpObj, int bRequireEncrypt);

bool GetRequireEncrypt();
int SetRequireEncrypt(bool bRequireEncrypt);

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.

Data Type

Boolean

RequireSign Property (AS2ProfileMgr Class)

Preference to receive signed messages.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int GetRequireSign();
int SetRequireSign(int bRequireSign);

Unicode (Windows)
BOOL GetRequireSign();
INT SetRequireSign(BOOL bRequireSign);

int ipworksedi_as2profilemgr_getrequiresign(void* lpObj);
int ipworksedi_as2profilemgr_setrequiresign(void* lpObj, int bRequireSign);

bool GetRequireSign();
int SetRequireSign(bool bRequireSign);

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.

Data Type

Boolean

SigningCert Property (AS2ProfileMgr Class)

Certificate used for signing or signature validation.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSigningCert();
int SetSigningCert(IPWorksEDICertificate* val);

int ipworksedi_as2profilemgr_getsigningcertstore(void* lpObj, char** lpSigningCertStore, int* lenSigningCertStore);
int ipworksedi_as2profilemgr_setsigningcertstore(void* lpObj, const char* lpSigningCertStore, int lenSigningCertStore);

char* ipworksedi_as2profilemgr_getsigningcertstorepassword(void* lpObj);
int ipworksedi_as2profilemgr_setsigningcertstorepassword(void* lpObj, const char* lpszSigningCertStorePassword);

int ipworksedi_as2profilemgr_getsigningcertstoretype(void* lpObj);
int ipworksedi_as2profilemgr_setsigningcertstoretype(void* lpObj, int iSigningCertStoreType);

char* ipworksedi_as2profilemgr_getsigningcertsubject(void* lpObj);
int ipworksedi_as2profilemgr_setsigningcertsubject(void* lpObj, const char* lpszSigningCertSubject);

int ipworksedi_as2profilemgr_getsigningcertencoded(void* lpObj, char** lpSigningCertEncoded, int* lenSigningCertEncoded);
int ipworksedi_as2profilemgr_setsigningcertencoded(void* lpObj, const char* lpSigningCertEncoded, int lenSigningCertEncoded);

QByteArray GetSigningCertStore();
int SetSigningCertStore(QByteArray qbaSigningCertStore);

QString GetSigningCertStorePassword();
int SetSigningCertStorePassword(QString qsSigningCertStorePassword);

int GetSigningCertStoreType();
int SetSigningCertStoreType(int iSigningCertStoreType);

QString GetSigningCertSubject();
int SetSigningCertSubject(QString qsSigningCertSubject);

QByteArray GetSigningCertEncoded();
int SetSigningCertEncoded(QByteArray qbaSigningCertEncoded);

Remarks

SigningCert for a trading partner, can be set to a filename containing the Base64 encoded signing certificate or to the contents of such file. It is used by the AS2Receiver to verify the signature on incoming data. If SigningCert is not specified EncryptionCert is used for signature verification as well.

While specifying "self" profile, SigningCert should be a pfx file containing a single certificate - private key pair. In such case SigningCertPassword must also be specified. SigningCert from "self" profile is used by AS2Sender to sign outgoing data. If SigningCert is not specified the EncryptionCert is used for signing as well.

After invoking LoadProfile, the SigningCert will contain the currently saved signing certificate, alternatively SigningCert may be set and saved by invoking SaveProfile.

Data Type

IPWorksEDICertificate

SSLCert Property (AS2ProfileMgr Class)

Certificate used for secure communication over SSL.

Syntax

• C++
• C
• Qt

IPWorksEDICertificate* GetSSLCert();
int SetSSLCert(IPWorksEDICertificate* val);

int ipworksedi_as2profilemgr_getsslcertstore(void* lpObj, char** lpSSLCertStore, int* lenSSLCertStore);
int ipworksedi_as2profilemgr_setsslcertstore(void* lpObj, const char* lpSSLCertStore, int lenSSLCertStore);

char* ipworksedi_as2profilemgr_getsslcertstorepassword(void* lpObj);
int ipworksedi_as2profilemgr_setsslcertstorepassword(void* lpObj, const char* lpszSSLCertStorePassword);

int ipworksedi_as2profilemgr_getsslcertstoretype(void* lpObj);
int ipworksedi_as2profilemgr_setsslcertstoretype(void* lpObj, int iSSLCertStoreType);

char* ipworksedi_as2profilemgr_getsslcertsubject(void* lpObj);
int ipworksedi_as2profilemgr_setsslcertsubject(void* lpObj, const char* lpszSSLCertSubject);

int ipworksedi_as2profilemgr_getsslcertencoded(void* lpObj, char** lpSSLCertEncoded, int* lenSSLCertEncoded);
int ipworksedi_as2profilemgr_setsslcertencoded(void* lpObj, const char* lpSSLCertEncoded, int lenSSLCertEncoded);

QByteArray GetSSLCertStore();
int SetSSLCertStore(QByteArray qbaSSLCertStore);

QString GetSSLCertStorePassword();
int SetSSLCertStorePassword(QString qsSSLCertStorePassword);

int GetSSLCertStoreType();
int SetSSLCertStoreType(int iSSLCertStoreType);

QString GetSSLCertSubject();
int SetSSLCertSubject(QString qsSSLCertSubject);

QByteArray GetSSLCertEncoded();
int SetSSLCertEncoded(QByteArray qbaSSLCertEncoded);

Remarks

SSLCert for a trading partner, can be set to a filename containing the Base64 encoded SSL certificate or to the contents of the file itself. It is used by the AS2Sender to authenticate the trading partner's server and to establish a secure communication channel.

While specifying self profile, SSLCert should be a pfx file containing a single certificate, private key pair. In this case SSLPassword must also be specified. SSLCert from self profile is used by AS2Sender for client side SSL authentication.

After invoking LoadProfile, the SSLCert will contain the currently saved SSL certificate, alternatively SSLCert may be set and saved by invoking SaveProfile.

Data Type

IPWorksEDICertificate

URL Property (AS2ProfileMgr Class)

The URL for posting EDI data.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetURL();
int SetURL(const char* lpszURL);

Unicode (Windows)
LPWSTR GetURL();
INT SetURL(LPCWSTR lpszURL);

char* ipworksedi_as2profilemgr_geturl(void* lpObj);
int ipworksedi_as2profilemgr_seturl(void* lpObj, const char* lpszURL);

QString GetURL();
int SetURL(QString qsURL);

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.

Data Type

String

Config Method (AS2ProfileMgr Class)

This method sets or retrieves a configuration setting.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* Config(const char* lpszConfigurationString);

Unicode (Windows)
LPWSTR Config(LPCWSTR lpszConfigurationString);

char* ipworksedi_as2profilemgr_config(void* lpObj, const char* lpszConfigurationString);

QString Config(const QString& qsConfigurationString);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

DeleteProfile Method (AS2ProfileMgr Class)

Deletes the configuration of the specified partner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int DeleteProfile(const char* lpszpartnerOrganization);

Unicode (Windows)
INT DeleteProfile(LPCWSTR lpszpartnerOrganization);

int ipworksedi_as2profilemgr_deleteprofile(void* lpObj, const char* lpszpartnerOrganization);

int DeleteProfile(const QString& qspartnerOrganization);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

GetProperty Method (AS2ProfileMgr Class)

Gets the property propName .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetProperty(const char* lpszpropName);

Unicode (Windows)
LPWSTR GetProperty(LPCWSTR lpszpropName);

char* ipworksedi_as2profilemgr_getproperty(void* lpObj, const char* lpszpropName);

QString GetProperty(const QString& qspropName);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

GetTPInfo Method (AS2ProfileMgr Class)

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

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
char* GetTPInfo(const char* lpszpartnerOrganization);

Unicode (Windows)
LPWSTR GetTPInfo(LPCWSTR lpszpartnerOrganization);

char* ipworksedi_as2profilemgr_gettpinfo(void* lpObj, const char* lpszpartnerOrganization);

QString GetTPInfo(const QString& qspartnerOrganization);

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.

Error Handling (C++)

This method returns a String value; after it returns, call the GetLastErrorCode() method to obtain its result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

ListPartners Method (AS2ProfileMgr Class)

Lists trading partners known to the AS2ProfileMgr .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListPartners();

Unicode (Windows)
INT ListPartners();

int ipworksedi_as2profilemgr_listpartners(void* lpObj);

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

ListProperties Method (AS2ProfileMgr Class)

Lists the properties read from self or partner profile.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int ListProperties();

Unicode (Windows)
INT ListProperties();

int ipworksedi_as2profilemgr_listproperties(void* lpObj);

int ListProperties();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

LoadProfile Method (AS2ProfileMgr Class)

Loads the profile of the trading partner identified by partnerOrganization .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int LoadProfile(const char* lpszpartnerOrganization);

Unicode (Windows)
INT LoadProfile(LPCWSTR lpszpartnerOrganization);

int ipworksedi_as2profilemgr_loadprofile(void* lpObj, const char* lpszpartnerOrganization);

int LoadProfile(const QString& qspartnerOrganization);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Reset Method (AS2ProfileMgr Class)

Resets the state of the control.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int Reset();

Unicode (Windows)
INT Reset();

int ipworksedi_as2profilemgr_reset(void* lpObj);

int Reset();

Remarks

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

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SaveProfile Method (AS2ProfileMgr Class)

Saves the profile of the trading partner identified by partnerOrganization .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SaveProfile(const char* lpszpartnerOrganization);

Unicode (Windows)
INT SaveProfile(LPCWSTR lpszpartnerOrganization);

int ipworksedi_as2profilemgr_saveprofile(void* lpObj, const char* lpszpartnerOrganization);

int SaveProfile(const QString& qspartnerOrganization);

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.

Error Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

SetProperty Method (AS2ProfileMgr Class)

Sets the property propName to propValue .

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
int SetProperty(const char* lpszpropName, const char* lpszpropValue);

Unicode (Windows)
INT SetProperty(LPCWSTR lpszpropName, LPCWSTR lpszpropValue);

int ipworksedi_as2profilemgr_setproperty(void* lpObj, const char* lpszpropName, const char* lpszpropValue);

int SetProperty(const QString& qspropName, const QString& qspropValue);

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 Handling (C++)

This method returns a result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. If an error occurs, the GetLastError() method can be called to retrieve the associated error message. (Note: This method's result code can also be obtained by calling the GetLastErrorCode() method after it returns.)

Error Event (AS2ProfileMgr Class)

This event is fired for information about errors during data delivery.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireError(AS2ProfileMgrErrorEventParams *e);

typedef struct {
  int ErrorCode;
  const char *Description;
  int reserved;
} AS2ProfileMgrErrorEventParams;


Unicode (Windows)
virtual INT FireError(AS2ProfileMgrErrorEventParams *e);

typedef struct {
  INT ErrorCode;
  LPCWSTR Description;
  INT reserved;
} AS2ProfileMgrErrorEventParams;

#define EID_AS2PROFILEMGR_ERROR 1

virtual INT IPWORKSEDI_CALL FireError(INT &iErrorCode, LPSTR &lpszDescription);

class AS2ProfileMgrErrorEventParams {
public:
  int ErrorCode();

  const QString &Description();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Error(AS2ProfileMgrErrorEventParams *e);

// Or, subclass AS2ProfileMgr and override this emitter function.
virtual int FireError(AS2ProfileMgrErrorEventParams *e) {...}

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.

Partner Event (AS2ProfileMgr Class)

Fired when ListPartners is invoked.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePartner(AS2ProfileMgrPartnerEventParams *e);

typedef struct {
  const char *partnerIdentifier;
  const char *partnerURL;
  int reserved;
} AS2ProfileMgrPartnerEventParams;


Unicode (Windows)
virtual INT FirePartner(AS2ProfileMgrPartnerEventParams *e);

typedef struct {
  LPCWSTR partnerIdentifier;
  LPCWSTR partnerURL;
  INT reserved;
} AS2ProfileMgrPartnerEventParams;

#define EID_AS2PROFILEMGR_PARTNER 2

virtual INT IPWORKSEDI_CALL FirePartner(LPSTR &lpszpartnerIdentifier, LPSTR &lpszpartnerURL);

class AS2ProfileMgrPartnerEventParams {
public:
  const QString &partnerIdentifier();

  const QString &partnerURL();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Partner(AS2ProfileMgrPartnerEventParams *e);

// Or, subclass AS2ProfileMgr and override this emitter function.
virtual int FirePartner(AS2ProfileMgrPartnerEventParams *e) {...}

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

Fired before accessing partner.cfg of a trading partner.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FirePartnerDirectory(AS2ProfileMgrPartnerDirectoryEventParams *e);

typedef struct {
  const char *Name;
  char *Directory;
  int reserved;
} AS2ProfileMgrPartnerDirectoryEventParams;


Unicode (Windows)
virtual INT FirePartnerDirectory(AS2ProfileMgrPartnerDirectoryEventParams *e);

typedef struct {
  LPCWSTR Name;
  LPWSTR Directory;
  INT reserved;
} AS2ProfileMgrPartnerDirectoryEventParams;

#define EID_AS2PROFILEMGR_PARTNERDIRECTORY 3

virtual INT IPWORKSEDI_CALL FirePartnerDirectory(LPSTR &lpszName, LPSTR &lpszDirectory);

class AS2ProfileMgrPartnerDirectoryEventParams {
public:
  const QString &Name();

  const QString &Directory();
  void SetDirectory(const QString &qsDirectory);

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void PartnerDirectory(AS2ProfileMgrPartnerDirectoryEventParams *e);

// Or, subclass AS2ProfileMgr and override this emitter function.
virtual int FirePartnerDirectory(AS2ProfileMgrPartnerDirectoryEventParams *e) {...}

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

Fired when ListProperties is invoked.

Syntax

• C++
• C
• Qt

ANSI (Cross Platform)
virtual int FireProperty(AS2ProfileMgrPropertyEventParams *e);

typedef struct {
  const char *propName;
  const char *propValue;
  int reserved;
} AS2ProfileMgrPropertyEventParams;


Unicode (Windows)
virtual INT FireProperty(AS2ProfileMgrPropertyEventParams *e);

typedef struct {
  LPCWSTR propName;
  LPCWSTR propValue;
  INT reserved;
} AS2ProfileMgrPropertyEventParams;

#define EID_AS2PROFILEMGR_PROPERTY 4

virtual INT IPWORKSEDI_CALL FireProperty(LPSTR &lpszpropName, LPSTR &lpszpropValue);

class AS2ProfileMgrPropertyEventParams {
public:
  const QString &propName();

  const QString &propValue();

  int EventRetVal();
  void SetEventRetVal(int iRetVal);
};

// To handle, connect one or more slots to this signal.
void Property(AS2ProfileMgrPropertyEventParams *e);

// Or, subclass AS2ProfileMgr and override this emitter function.
virtual int FireProperty(AS2ProfileMgrPropertyEventParams *e) {...}

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.

Certificate Type

This is the digital certificate being used.

Syntax

IPWorksEDICertificate (declared in ipworksedi.h)

Remarks

This type describes the current digital certificate. The certificate may be a public or private key. The fields are used to identify or select certificates.

Fields

Constructors

Certificate()

Creates a Certificate instance whose properties can be set. This is useful for use with CERTMGR when generating new certificates.

Certificate(const char* lpEncoded, int lenEncoded)

Parses Encoded as an X509 public key.

Certificate(int iStoreType, const char* lpStore, int lenStore, const char* lpszStorePassword, const char* lpszSubject)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a string (binary- or base64-encoded) containing the certificate data. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will attempt to find the certificate identified by Subject . This can be either a complete or a substring match of the X509 certificate's subject Distinguished Name (DN).

Config Settings (AS2ProfileMgr Class)

Base Config Settings

Trappable Errors (AS2ProfileMgr Class)

Error Handling (C++)

Call the GetLastErrorCode() method to obtain the last called method's result code; 0 indicates success, while a non-zero error code indicates that this method encountered an error during its execution. Known error codes are listed below. If an error occurs, the GetLastError() method can be called to retrieve the associated error message.

AS2ProfileMgr Errors