AS2ProfileMgr Component

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

nsoftware.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 component allows you to manage such settings using simple XML files, furthermore these configuration files can be directly fed to the AS2Sender and AS2Receiver Component 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 component with short descriptions. Click on the links for further details.

Method List

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

Event List

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

Config Settings

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

AsyncMDNURL Property (AS2ProfileMgr Component)

The URL for posting Async MDNs.

Syntax

• C#
• VB.NET

public string AsyncMDNURL { get; set; }

Public Property AsyncMDNURL As String

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

Option to create file management directories.

Syntax

• C#
• VB.NET

public bool CreateDirStruct { get; set; }

Public Property CreateDirStruct As Boolean

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

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

Syntax

• C#
• VB.NET

public string DataDir { get; set; }

Public Property DataDir As String

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

The directory used to store deleted files.

Syntax

• C#
• VB.NET

public string DirDeleted { get; }

Public ReadOnly Property DirDeleted As String

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

The directory used to store incoming files.

Syntax

• C#
• VB.NET

public string DirIncoming { get; }

Public ReadOnly Property DirIncoming As String

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

The directory used to store log files.

Syntax

• C#
• VB.NET

public string DirLogs { get; }

Public ReadOnly Property DirLogs As String

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

The directory used to store outgoing files.

Syntax

• C#
• VB.NET

public string DirOutgoing { get; }

Public ReadOnly Property DirOutgoing As String

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

The directory used to store files waiting for Async MDN.

Syntax

• C#
• VB.NET

public string DirPending { get; }

Public ReadOnly Property DirPending As String

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

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

Syntax

• C#
• VB.NET

public string DirPendingInfo { get; }

Public ReadOnly Property DirPendingInfo As String

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

The directory used to store sent files.

Syntax

• C#
• VB.NET

public string DirSent { get; }

Public ReadOnly Property DirSent As String

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

Your email address.

Syntax

• C#
• VB.NET

public string Email { get; set; }

Public Property Email As String

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.

EncryptionCert Property (AS2ProfileMgr Component)

Certificate used for encryption or decryption.

Syntax

• C#
• VB.NET

public Certificate EncryptionCert { get; set; }

Public Property EncryptionCert As Certificate

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.

OptionCompress Property (AS2ProfileMgr Component)

Preference to compress outgoing data.

Syntax

• C#
• VB.NET

public bool OptionCompress { get; set; }

Public Property OptionCompress As Boolean

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

Preference to encrypt outgoing data.

Syntax

• C#
• VB.NET

public bool OptionEncrypt { get; set; }

Public Property OptionEncrypt As Boolean

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

Preference to sign outgoing data.

Syntax

• C#
• VB.NET

public bool OptionSign { get; set; }

Public Property OptionSign As Boolean

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

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

Syntax

• C#
• VB.NET

public string Organization { get; set; }

Public Property Organization As String

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

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

PartnerCount Property (AS2ProfileMgr Component)

The number of partners found in DataDir

Syntax

• C#
• VB.NET

public int PartnerCount { get; }

Public ReadOnly Property PartnerCount As Integer

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.

RequestMDN Property (AS2ProfileMgr Component)

Preference to receive MDNs from trading partner.

Syntax

• C#
• VB.NET

public bool RequestMDN { get; set; }

Public Property RequestMDN As Boolean

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

Preference to request for signed MDNs.

Syntax

• C#
• VB.NET

public bool RequestMDNSigned { get; set; }

Public Property RequestMDNSigned As Boolean

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

Preference to request for synchronous MDNs.

Syntax

• C#
• VB.NET

public bool RequestMDNSynchronous { get; set; }

Public Property RequestMDNSynchronous As Boolean

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

Preference to receive encrypted messages.

Syntax

• C#
• VB.NET

public bool RequireEncrypt { get; set; }

Public Property RequireEncrypt As Boolean

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

Preference to receive signed messages.

Syntax

• C#
• VB.NET

public bool RequireSign { get; set; }

Public Property RequireSign As Boolean

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.

SigningCert Property (AS2ProfileMgr Component)

Certificate used for signing or signature validation.

Syntax

• C#
• VB.NET

public Certificate SigningCert { get; set; }

Public Property SigningCert As Certificate

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.

SSLCert Property (AS2ProfileMgr Component)

Certificate used for secure communication over SSL.

Syntax

• C#
• VB.NET

public Certificate SSLCert { get; set; }

Public Property SSLCert As Certificate

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.

URL Property (AS2ProfileMgr Component)

The URL for posting EDI data.

Syntax

• C#
• VB.NET

public string URL { get; set; }

Public Property URL As String

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

Sets or retrieves a configuration setting.

Syntax

• C#
• VB.NET

public string Config(string configurationString);

Async Version
public async Task<string> Config(string configurationString);
public async Task<string> Config(string configurationString, CancellationToken cancellationToken);

Public Function Config(ByVal ConfigurationString As String) As String

Async Version
Public Function Config(ByVal ConfigurationString As String) As Task(Of String)
Public Function Config(ByVal ConfigurationString As String, cancellationToken As CancellationToken) As Task(Of String)

Remarks

Config is a generic method available in every component. It is used to set and retrieve configuration settings for the component.

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the component, 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 Component)

Deletes the configuration of the specified partner.

Syntax

• C#
• VB.NET

public void DeleteProfile(string partnerOrganization);

Async Version
public async Task DeleteProfile(string partnerOrganization);
public async Task DeleteProfile(string partnerOrganization, CancellationToken cancellationToken);

Public Sub DeleteProfile(ByVal partnerOrganization As String)

Async Version
Public Sub DeleteProfile(ByVal partnerOrganization As String) As Task
Public Sub DeleteProfile(ByVal partnerOrganization As String, cancellationToken As CancellationToken) As Task

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

Gets the property propName .

Syntax

• C#
• VB.NET

public string GetProperty(string propName);

Async Version
public async Task<string> GetProperty(string propName);
public async Task<string> GetProperty(string propName, CancellationToken cancellationToken);

Public Function GetProperty(ByVal propName As String) As String

Async Version
Public Function GetProperty(ByVal propName As String) As Task(Of String)
Public Function GetProperty(ByVal propName As String, cancellationToken As CancellationToken) As Task(Of String)

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 components and thus not exposed as AS2ProfileMgr properties.

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

GetTPInfo Method (AS2ProfileMgr Component)

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

Syntax

• C#
• VB.NET

public string GetTPInfo(string partnerOrganization);

Async Version
public async Task<string> GetTPInfo(string partnerOrganization);
public async Task<string> GetTPInfo(string partnerOrganization, CancellationToken cancellationToken);

Public Function GetTPInfo(ByVal partnerOrganization As String) As String

Async Version
Public Function GetTPInfo(ByVal partnerOrganization As String) As Task(Of String)
Public Function GetTPInfo(ByVal partnerOrganization As String, cancellationToken As CancellationToken) As Task(Of String)

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

Lists trading partners known to the AS2ProfileMgr .

Syntax

• C#
• VB.NET

public void ListPartners();

Async Version
public async Task ListPartners();
public async Task ListPartners(CancellationToken cancellationToken);

Public Sub ListPartners()

Async Version
Public Sub ListPartners() As Task
Public Sub ListPartners(cancellationToken As CancellationToken) As Task

Remarks

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

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

ListProperties Method (AS2ProfileMgr Component)

Lists the properties read from self or partner profile.

Syntax

• C#
• VB.NET

public void ListProperties();

Async Version
public async Task ListProperties();
public async Task ListProperties(CancellationToken cancellationToken);

Public Sub ListProperties()

Async Version
Public Sub ListProperties() As Task
Public Sub ListProperties(cancellationToken As CancellationToken) As Task

Remarks

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

LoadProfile Method (AS2ProfileMgr Component)

Loads the profile of the trading partner identified by partnerOrganization .

Syntax

• C#
• VB.NET

public void LoadProfile(string partnerOrganization);

Async Version
public async Task LoadProfile(string partnerOrganization);
public async Task LoadProfile(string partnerOrganization, CancellationToken cancellationToken);

Public Sub LoadProfile(ByVal partnerOrganization As String)

Async Version
Public Sub LoadProfile(ByVal partnerOrganization As String) As Task
Public Sub LoadProfile(ByVal partnerOrganization As String, cancellationToken As CancellationToken) As Task

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

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

My Settings

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

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

Reset Method (AS2ProfileMgr Component)

Resets the state of the control.

Syntax

• C#
• VB.NET

public void Reset();

Async Version
public async Task Reset();
public async Task Reset(CancellationToken cancellationToken);

Public Sub Reset()

Async Version
Public Sub Reset() As Task
Public Sub Reset(cancellationToken As CancellationToken) As Task

Remarks

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

SaveProfile Method (AS2ProfileMgr Component)

Saves the profile of the trading partner identified by partnerOrganization .

Syntax

• C#
• VB.NET

public void SaveProfile(string partnerOrganization);

Async Version
public async Task SaveProfile(string partnerOrganization);
public async Task SaveProfile(string partnerOrganization, CancellationToken cancellationToken);

Public Sub SaveProfile(ByVal partnerOrganization As String)

Async Version
Public Sub SaveProfile(ByVal partnerOrganization As String) As Task
Public Sub SaveProfile(ByVal partnerOrganization As String, cancellationToken As CancellationToken) As Task

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

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

My Settings

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

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

SetProperty Method (AS2ProfileMgr Component)

Sets the property propName to propValue .

Syntax

• C#
• VB.NET

public void SetProperty(string propName, string propValue);

Async Version
public async Task SetProperty(string propName, string propValue);
public async Task SetProperty(string propName, string propValue, CancellationToken cancellationToken);

Public Sub SetProperty(ByVal propName As String, ByVal propValue As String)

Async Version
Public Sub SetProperty(ByVal propName As String, ByVal propValue As String) As Task
Public Sub SetProperty(ByVal propName As String, ByVal propValue As String, cancellationToken As CancellationToken) As Task

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 AS2Receivercomponents and thus not exposed as AS2ProfileMgr properties.

Error Event (AS2ProfileMgr Component)

Information about errors during data delivery.

Syntax

• C#
• VB.NET

public event OnErrorHandler OnError;

public delegate void OnErrorHandler(object sender, As2profilemgrErrorEventArgs e);

public class As2profilemgrErrorEventArgs : EventArgs {
  public int ErrorCode { get; }
  public string Description { get; }
}

Public Event OnError As OnErrorHandler

Public Delegate Sub OnErrorHandler(sender As Object, e As As2profilemgrErrorEventArgs)

Public Class As2profilemgrErrorEventArgs Inherits EventArgs
  Public ReadOnly Property ErrorCode As Integer
  Public ReadOnly Property Description As String
End Class

Remarks

The Error event is fired in case of exceptional conditions during message processing. Normally the component throws an exception.

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

Fired when ListPartners is invoked.

Syntax

• C#
• VB.NET

public event OnPartnerHandler OnPartner;

public delegate void OnPartnerHandler(object sender, As2profilemgrPartnerEventArgs e);

public class As2profilemgrPartnerEventArgs : EventArgs {
  public string partnerIdentifier { get; }
  public string partnerURL { get; }
}

Public Event OnPartner As OnPartnerHandler

Public Delegate Sub OnPartnerHandler(sender As Object, e As As2profilemgrPartnerEventArgs)

Public Class As2profilemgrPartnerEventArgs Inherits EventArgs
  Public ReadOnly Property partnerIdentifier As String
  Public ReadOnly Property partnerURL As String
End Class

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

Fired before accessing partner.cfg of a trading partner.

Syntax

• C#
• VB.NET

public event OnPartnerDirectoryHandler OnPartnerDirectory;

public delegate void OnPartnerDirectoryHandler(object sender, As2profilemgrPartnerDirectoryEventArgs e);

public class As2profilemgrPartnerDirectoryEventArgs : EventArgs {
  public string Name { get; }
  public string Directory { get; set; }
}

Public Event OnPartnerDirectory As OnPartnerDirectoryHandler

Public Delegate Sub OnPartnerDirectoryHandler(sender As Object, e As As2profilemgrPartnerDirectoryEventArgs)

Public Class As2profilemgrPartnerDirectoryEventArgs Inherits EventArgs
  Public ReadOnly Property Name As String
  Public Property Directory As String
End Class

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

Fired when ListProperties is invoked.

Syntax

• C#
• VB.NET

public event OnPropertyHandler OnProperty;

public delegate void OnPropertyHandler(object sender, As2profilemgrPropertyEventArgs e);

public class As2profilemgrPropertyEventArgs : EventArgs {
  public string propName { get; }
  public string propValue { get; }
}

Public Event OnProperty As OnPropertyHandler

Public Delegate Sub OnPropertyHandler(sender As Object, e As As2profilemgrPropertyEventArgs)

Public Class As2profilemgrPropertyEventArgs Inherits EventArgs
  Public ReadOnly Property propName As String
  Public ReadOnly Property propValue As String
End Class

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.

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

• C#
• VB.NET

public Certificate();

Public Certificate()

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

• C#
• VB.NET

public Certificate(string certificateFile);

Public Certificate(ByVal CertificateFile As String)

Opens CertificateFile and reads out the contents as an X509 public key.

• C#
• VB.NET

public Certificate(byte[] certificateData);

Public Certificate(ByVal CertificateData As Byte())

Parses CertificateData as an X509 public key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. 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).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. ConfigurationString is a newline separated list of name-value pairs that may be used to modify the default behavior. Possible values include "PersistPFXKey", which shows whether or not the PFX key is persisted after performing operations with the private key. This correlates to the PKCS12_NO_PERSIST_KEY CyrptoAPI option. The default value is True (the key is persisted). "Thumbprint" - a MD5, SHA1, or SHA256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to cstUser, cstMachine, cstPublicKeyFile, and cstPFXFile store types. "UseInternalSecurityAPI" shows whether the platform (default) or the internal security API is used when performing certificate-related operations. 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).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, string store, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal Store As String, ByVal StorePassword As String, ByVal Encoded As Byte())

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. Store is a file containing the certificate store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob 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).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, string subject, string configurationString);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Subject As String, ByVal ConfigurationString As String)

CertStoreType identifies the type of certificate store to use. See StoreType for descriptions of the different certificate stores. StoreBlob 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).

• C#
• VB.NET

public Certificate(CertStoreTypes certStoreType, byte[] storeBlob, string storePassword, byte[] encoded);

Public Certificate(ByVal CertStoreType As CertStoreTypes, ByVal StoreBlob As Byte(), ByVal StorePassword As String, ByVal Encoded As Byte())

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 store. StorePassword is the password used to protect the store. After the store has been successfully opened, the component will load Encoded as an X509 certificate and search the opened store for a corresponding private key.

Config Settings (AS2ProfileMgr Component)

Base Config Settings

Trappable Errors (AS2ProfileMgr Component)

AS2ProfileMgr Errors