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

class 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 data_dir 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 save_profile, alternatively you could retrieve previously saved settings using load_profile.

When a new trading partner profile is saved a sub-directory named after the trading partner is created within data_dir and the file partner.cfg is saved in it. If create_dir_struct 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.

async_mdnurl Property

The URL for posting Async MDNs.

Syntax

def get_async_mdnurl() -> str: ...
def set_async_mdnurl(value: str) -> None: ...

async_mdnurl = property(get_async_mdnurl, set_async_mdnurl)

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

create_dir_struct Property

Option to create file management directories.

Syntax

def get_create_dir_struct() -> bool: ...
def set_create_dir_struct(value: bool) -> None: ...

create_dir_struct = property(get_create_dir_struct, set_create_dir_struct)

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 save_profile is invoked.

data_dir Property

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

Syntax

def get_data_dir() -> str: ...
def set_data_dir(value: str) -> None: ...

data_dir = property(get_data_dir, set_data_dir)

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

dir_deleted Property

The directory used to store deleted files.

Syntax

def get_dir_deleted() -> str: ...

dir_deleted = property(get_dir_deleted, None)

Default Value

""

Remarks

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

This property is read-only.

dir_incoming Property

The directory used to store incoming files.

Syntax

def get_dir_incoming() -> str: ...

dir_incoming = property(get_dir_incoming, None)

Default Value

""

Remarks

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

This property is read-only.

dir_logs Property

The directory used to store log files.

Syntax

def get_dir_logs() -> str: ...

dir_logs = property(get_dir_logs, None)

Default Value

""

Remarks

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

This property is read-only.

dir_outgoing Property

The directory used to store outgoing files.

Syntax

def get_dir_outgoing() -> str: ...

dir_outgoing = property(get_dir_outgoing, None)

Default Value

""

Remarks

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

This property is read-only.

dir_pending Property

The directory used to store files waiting for Async MDN.

Syntax

def get_dir_pending() -> str: ...

dir_pending = property(get_dir_pending, None)

Default Value

""

Remarks

If create_dir_struct was true when save_profile 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 load_profile.

This property is read-only.

dir_pending_info Property

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

Syntax

def get_dir_pending_info() -> str: ...

dir_pending_info = property(get_dir_pending_info, None)

Default Value

""

Remarks

If create_dir_struct was true when save_profile 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 load_profile.

This property is read-only.

dir_sent Property

The directory used to store sent files.

Syntax

def get_dir_sent() -> str: ...

dir_sent = property(get_dir_sent, None)

Default Value

""

Remarks

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

This property is read-only.

email Property

Your email address.

Syntax

def get_email() -> str: ...
def set_email(value: str) -> None: ...

email = property(get_email, set_email)

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 load_profile, the Email will contain your currently configured email address, alternatively Email may be set and saved by invoking save_profile.

encryption_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_encryption_cert_store() -> bytes: ...
def set_encryption_cert_store(value: bytes) -> None: ...

encryption_cert_store = property(get_encryption_cert_store, set_encryption_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The encryption_cert_store_type property denotes the type of the certificate store specified by encryption_cert_store. If the store is password-protected, specify the password in encryption_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

encryption_cert_store_password Property

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

Syntax

def get_encryption_cert_store_password() -> str: ...
def set_encryption_cert_store_password(value: str) -> None: ...

encryption_cert_store_password = property(get_encryption_cert_store_password, set_encryption_cert_store_password)

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.

encryption_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_encryption_cert_store_type() -> int: ...
def set_encryption_cert_store_type(value: int) -> None: ...

encryption_cert_store_type = property(get_encryption_cert_store_type, set_encryption_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

encryption_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_encryption_cert_subject() -> str: ...
def set_encryption_cert_subject(value: str) -> None: ...

encryption_cert_subject = property(get_encryption_cert_subject, set_encryption_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

encryption_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_encryption_cert_encoded() -> bytes: ...
def set_encryption_cert_encoded(value: bytes) -> None: ...

encryption_cert_encoded = property(get_encryption_cert_encoded, set_encryption_cert_encoded)

Default Value

""

Remarks

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

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

option_compress Property

Preference to compress outgoing data.

Syntax

def get_option_compress() -> bool: ...
def set_option_compress(value: bool) -> None: ...

option_compress = property(get_option_compress, set_option_compress)

Default Value

FALSE

Remarks

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

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

option_encrypt Property

Preference to encrypt outgoing data.

Syntax

def get_option_encrypt() -> bool: ...
def set_option_encrypt(value: bool) -> None: ...

option_encrypt = property(get_option_encrypt, set_option_encrypt)

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 encryption_cert must be specified.

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

option_sign Property

Preference to sign outgoing data.

Syntax

def get_option_sign() -> bool: ...
def set_option_sign(value: bool) -> None: ...

option_sign = property(get_option_sign, set_option_sign)

Default Value

FALSE

Remarks

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

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

organization Property

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

Syntax

def get_organization() -> str: ...
def set_organization(value: str) -> None: ...

organization = property(get_organization, set_organization)

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 load_profile reads the AS2 identifier into Organization, alternatively you can save the AS2 identifier by setting Organization and invoking save_profile.

partner_count Property

The number of partners found in DataDir .

Syntax

def get_partner_count() -> int: ...

partner_count = property(get_partner_count, None)

Default Value

0

Remarks

This property returns the number of partners found in data_dir. This proprety is populated after calling list_partners.

This property is read-only.

request_mdn Property

Preference to receive MDNs from trading partner.

Syntax

def get_request_mdn() -> bool: ...
def set_request_mdn(value: bool) -> None: ...

request_mdn = property(get_request_mdn, set_request_mdn)

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 load_profile, the RequireMDN will contain your preference of receiving MDNs, alternatively RequireMDN may be set and saved by invoking save_profile.

request_mdn_signed Property

Preference to request for signed MDNs.

Syntax

def get_request_mdn_signed() -> bool: ...
def set_request_mdn_signed(value: bool) -> None: ...

request_mdn_signed = property(get_request_mdn_signed, set_request_mdn_signed)

Default Value

TRUE

Remarks

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

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

request_mdn_synchronous Property

Preference to request for synchronous MDNs.

Syntax

def get_request_mdn_synchronous() -> bool: ...
def set_request_mdn_synchronous(value: bool) -> None: ...

request_mdn_synchronous = property(get_request_mdn_synchronous, set_request_mdn_synchronous)

Default Value

TRUE

Remarks

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

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

require_encrypt Property

Preference to receive encrypted messages.

Syntax

def get_require_encrypt() -> bool: ...
def set_require_encrypt(value: bool) -> None: ...

require_encrypt = property(get_require_encrypt, set_require_encrypt)

Default Value

FALSE

Remarks

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

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

require_sign Property

Preference to receive signed messages.

Syntax

def get_require_sign() -> bool: ...
def set_require_sign(value: bool) -> None: ...

require_sign = property(get_require_sign, set_require_sign)

Default Value

FALSE

Remarks

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

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

signing_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_signing_cert_store() -> bytes: ...
def set_signing_cert_store(value: bytes) -> None: ...

signing_cert_store = property(get_signing_cert_store, set_signing_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The signing_cert_store_type property denotes the type of the certificate store specified by signing_cert_store. If the store is password-protected, specify the password in signing_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

signing_cert_store_password Property

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

Syntax

def get_signing_cert_store_password() -> str: ...
def set_signing_cert_store_password(value: str) -> None: ...

signing_cert_store_password = property(get_signing_cert_store_password, set_signing_cert_store_password)

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.

signing_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_signing_cert_store_type() -> int: ...
def set_signing_cert_store_type(value: int) -> None: ...

signing_cert_store_type = property(get_signing_cert_store_type, set_signing_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

signing_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_signing_cert_subject() -> str: ...
def set_signing_cert_subject(value: str) -> None: ...

signing_cert_subject = property(get_signing_cert_subject, set_signing_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

signing_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_signing_cert_encoded() -> bytes: ...
def set_signing_cert_encoded(value: bytes) -> None: ...

signing_cert_encoded = property(get_signing_cert_encoded, set_signing_cert_encoded)

Default Value

""

Remarks

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

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

ssl_cert_store Property

The name of the certificate store for the client certificate.

Syntax

def get_ssl_cert_store() -> bytes: ...
def set_ssl_cert_store(value: bytes) -> None: ...

ssl_cert_store = property(get_ssl_cert_store, set_ssl_cert_store)

Default Value

"MY"

Remarks

The name of the certificate store for the client certificate.

The ssl_cert_store_type property denotes the type of the certificate store specified by ssl_cert_store. If the store is password-protected, specify the password in ssl_cert_store_password.

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

Designations of certificate stores are platform dependent.

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

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

ssl_cert_store_password Property

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

Syntax

def get_ssl_cert_store_password() -> str: ...
def set_ssl_cert_store_password(value: str) -> None: ...

ssl_cert_store_password = property(get_ssl_cert_store_password, set_ssl_cert_store_password)

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.

ssl_cert_store_type Property

The type of certificate store for this certificate.

Syntax

def get_ssl_cert_store_type() -> int: ...
def set_ssl_cert_store_type(value: int) -> None: ...

ssl_cert_store_type = property(get_ssl_cert_store_type, set_ssl_cert_store_type)

Default Value

0

Remarks

The type of certificate store for this certificate.

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

ssl_cert_subject Property

The subject of the certificate used for client authentication.

Syntax

def get_ssl_cert_subject() -> str: ...
def set_ssl_cert_subject(value: str) -> None: ...

ssl_cert_subject = property(get_ssl_cert_subject, set_ssl_cert_subject)

Default Value

""

Remarks

The subject of the certificate used for client authentication.

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

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

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

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

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

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

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

ssl_cert_encoded Property

The certificate (PEM/Base64 encoded).

Syntax

def get_ssl_cert_encoded() -> bytes: ...
def set_ssl_cert_encoded(value: bytes) -> None: ...

ssl_cert_encoded = property(get_ssl_cert_encoded, set_ssl_cert_encoded)

Default Value

""

Remarks

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

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

url Property

The URL for posting EDI data.

Syntax

def get_url() -> str: ...
def set_url(value: str) -> None: ...

url = property(get_url, set_url)

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 load_profile or save_profile, URL refers to the URL that your trading partners use to post data to you.

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

config Method

Sets or retrieves a configuration setting.

Syntax

def config(configuration_string: str) -> str: ...

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.

delete_profile Method

Deletes the configuration of the specified partner.

Syntax

def delete_profile(partner_organization: str) -> None: ...

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.

get_property Method

Gets the property propName .

Syntax

def get_property(prop_name: str) -> str: ...

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

get_tp_info Method

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

Syntax

def get_tp_info(partner_organization: str) -> str: ...

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.

list_partners Method

Lists trading partners known to the AS2ProfileMgr .

Syntax

def list_partners() -> None: ...

Remarks

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

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

list_properties Method

Lists the properties read from self or partner profile.

Syntax

def list_properties() -> None: ...

Remarks

Invoking ListProperties causes the event on_property to be fired for each property read by load_profile.

load_profile Method

Loads the profile of the trading partner identified by partnerOrganization .

Syntax

def load_profile(partner_organization: str) -> None: ...

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 data_dir. 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
• option_sign
• option_encrypt
• option_compress
• require_sign
• require_encrypt
• request_mdn
• request_mdn_signed
• request_mdn_synchronous
• encryption_cert
• signing_cert
• ssl_cert

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

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

My Settings

• organization
• url
• email
• encryption_cert
• signing_cert
• ssl_cert
• async_mdnurl

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

reset Method

Resets the state of the control.

Syntax

def reset() -> None: ...

Remarks

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

save_profile Method

Saves the profile of the trading partner identified by partnerOrganization .

Syntax

def save_profile(partner_organization: str) -> None: ...

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 data_dir. The name of the sub-directory is derived from partnerOrganization. In addition to saving the partner profile, SaveProfile also creates the following directories if create_dir_struct 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
• option_sign
• option_encrypt
• option_compress
• require_sign
• require_encrypt
• request_mdn
• request_mdn_signed
• request_mdn_synchronous
• encryption_cert
• signing_cert
• ssl_cert

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

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
• encryption_cert
• signing_cert
• ssl_cert
• async_mdnurl

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

set_property Method

Sets the property propName to propValue .

Syntax

def set_property(prop_name: str, prop_value: str) -> None: ...

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.

on_error Event

Fired when information is available about errors during data delivery.

Syntax

class AS2ProfileMgrErrorEventParams(object):
  @property
  def error_code() -> int: ...

  @property
  def description() -> str: ...

# In class AS2ProfileMgr:
@property
def on_error() -> Callable[[AS2ProfileMgrErrorEventParams], None]: ...
@on_error.setter
def on_error(event_hook: Callable[[AS2ProfileMgrErrorEventParams], None]) -> None: ...

Remarks

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

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

on_partner Event

Fired when ListPartners is invoked.

Syntax

class AS2ProfileMgrPartnerEventParams(object):
  @property
  def partner_identifier() -> str: ...

  @property
  def partner_url() -> str: ...

# In class AS2ProfileMgr:
@property
def on_partner() -> Callable[[AS2ProfileMgrPartnerEventParams], None]: ...
@on_partner.setter
def on_partner(event_hook: Callable[[AS2ProfileMgrPartnerEventParams], None]) -> None: ...

Remarks

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

on_partner_directory Event

Fired before accessing partner.cfg of a trading partner.

Syntax

class AS2ProfileMgrPartnerDirectoryEventParams(object):
  @property
  def name() -> str: ...

  @property
  def directory() -> str: ...
  @directory.setter
  def directory(value) -> None: ...

# In class AS2ProfileMgr:
@property
def on_partner_directory() -> Callable[[AS2ProfileMgrPartnerDirectoryEventParams], None]: ...
@on_partner_directory.setter
def on_partner_directory(event_hook: Callable[[AS2ProfileMgrPartnerDirectoryEventParams], None]) -> None: ...

Remarks

This event is fired every time partner.cfg needs to be accessed i.e when load_profile or get_tp_info 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 list_partners is invoked.

on_property Event

Fired when ListProperties is invoked.

Syntax

class AS2ProfileMgrPropertyEventParams(object):
  @property
  def prop_name() -> str: ...

  @property
  def prop_value() -> str: ...

# In class AS2ProfileMgr:
@property
def on_property() -> Callable[[AS2ProfileMgrPropertyEventParams], None]: ...
@on_property.setter
def on_property(event_hook: Callable[[AS2ProfileMgrPropertyEventParams], None]) -> None: ...

Remarks

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

AS2ProfileMgr Config Settings

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

Base Config Settings

AS2ProfileMgr Errors

AS2ProfileMgr Errors