# AS2ProfileMgr Class

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

## Syntax

```text
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](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) Class as a convenient way to set communication parameters.

To use the **AS2ProfileMgr** you should first set [DataDir](#datadir-property-as2profilemgr-class) 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](#saveprofile-method-as2profilemgr-class), alternatively you could retrieve previously saved settings using [LoadProfile](#loadprofile-method-as2profilemgr-class).

When a new trading partner profile is saved a sub-directory named after the trading partner is created within [DataDir](#datadir-property-as2profilemgr-class) and the file *partner.cfg* is saved in it. If [CreateDirStruct](#createdirstruct-property-as2profilemgr-class) 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.

|  |  |
| --- | --- |
| [DirDeleted](#dirdeleted-property-as2profilemgr-class) | Deleted files. |
| [DirIncoming](#dirincoming-property-as2profilemgr-class) | Received files. |
| [DirLogs](#dirlogs-property-as2profilemgr-class) | Log files. |
| [DirOutgoing](#diroutgoing-property-as2profilemgr-class) | Files to be sent. |
| [DirPending](#dirpending-property-as2profilemgr-class) | Files pending async MDN. |
| [DirPendingInfo](#dirpendinginfo-property-as2profilemgr-class) | Files having data to verify async MSN. |
| [DirSent](#dirsent-property-as2profilemgr-class) | Sent files. |

## Property List

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

|  |  |
| --- | --- |
| [AsyncMDNURL](#asyncmdnurl-property-as2profilemgr-class) | The URL for posting Async MDNs. |
| [CreateDirStruct](#createdirstruct-property-as2profilemgr-class) | Option to create file management directories. |
| [DataDir](#datadir-property-as2profilemgr-class) | The directory that the AS2ProfileMgr uses to store self and trading partner profiles. |
| [DirDeleted](#dirdeleted-property-as2profilemgr-class) | The directory used to store deleted files. |
| [DirIncoming](#dirincoming-property-as2profilemgr-class) | The directory used to store incoming files. |
| [DirLogs](#dirlogs-property-as2profilemgr-class) | The directory used to store log files. |
| [DirOutgoing](#diroutgoing-property-as2profilemgr-class) | The directory used to store outgoing files. |
| [DirPending](#dirpending-property-as2profilemgr-class) | The directory used to store files waiting for Async MDN. |
| [DirPendingInfo](#dirpendinginfo-property-as2profilemgr-class) | The directory used to store files containing data to verify Async MDN. |
| [DirSent](#dirsent-property-as2profilemgr-class) | The directory used to store sent files. |
| [Email](#email-property-as2profilemgr-class) | Your email address. |
| [EncryptionCert](#encryptioncert-property-as2profilemgr-class) | Certificate used for encryption or decryption. |
| [OptionCompress](#optioncompress-property-as2profilemgr-class) | Preference to compress outgoing data. |
| [OptionEncrypt](#optionencrypt-property-as2profilemgr-class) | Preference to encrypt outgoing data. |
| [OptionSign](#optionsign-property-as2profilemgr-class) | Preference to sign outgoing data. |
| [Organization](#organization-property-as2profilemgr-class) | The name of your, or your trading partner's organization. |
| [PartnerCount](#partnercount-property-as2profilemgr-class) | The number of partners found in DataDir . |
| [RequestMDN](#requestmdn-property-as2profilemgr-class) | Preference to receive MDNs from trading partner. |
| [RequestMDNSigned](#requestmdnsigned-property-as2profilemgr-class) | Preference to request for signed MDNs. |
| [RequestMDNSynchronous](#requestmdnsynchronous-property-as2profilemgr-class) | Preference to request for synchronous MDNs. |
| [RequireEncrypt](#requireencrypt-property-as2profilemgr-class) | Preference to receive encrypted messages. |
| [RequireSign](#requiresign-property-as2profilemgr-class) | Preference to receive signed messages. |
| [SigningCert](#signingcert-property-as2profilemgr-class) | Certificate used for signing or signature validation. |
| [SSLCert](#sslcert-property-as2profilemgr-class) | Certificate used for secure communication over SSL. |
| [URL](#url-property-as2profilemgr-class) | The URL for posting EDI data. |

## Method List

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

|  |  |
| --- | --- |
| [Config](#config-method-as2profilemgr-class) | Sets or retrieves a configuration setting. |
| [DeleteProfile](#deleteprofile-method-as2profilemgr-class) | Deletes the configuration of the specified partner. |
| [GetProperty](#getproperty-method-as2profilemgr-class) | Gets the property propName . |
| [GetTPInfo](#gettpinfo-method-as2profilemgr-class) | Gets the profile of the specified partner as a XML TPInfo. |
| [ListPartners](#listpartners-method-as2profilemgr-class) | Lists trading partners known to the AS2ProfileMgr . |
| [ListProperties](#listproperties-method-as2profilemgr-class) | Lists the properties read from self or partner profile. |
| [LoadProfile](#loadprofile-method-as2profilemgr-class) | Loads the profile of the trading partner identified by partnerOrganization . |
| [Reset](#reset-method-as2profilemgr-class) | Resets the state of the control. |
| [SaveProfile](#saveprofile-method-as2profilemgr-class) | Saves the profile of the trading partner identified by partnerOrganization . |
| [SetProperty](#setproperty-method-as2profilemgr-class) | Sets the property propName to propValue . |

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

|  |  |
| --- | --- |
| [Error](#error-event-as2profilemgr-class) | Fired when information is available about errors during data delivery. |
| [Partner](#partner-event-as2profilemgr-class) | Fired when ListPartners is invoked. |
| [PartnerDirectory](#partnerdirectory-event-as2profilemgr-class) | Fired before accessing partner.cfg of a trading partner. |
| [Property](#property-event-as2profilemgr-class) | Fired when ListProperties is invoked. |

## Config Settings

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

|  |  |
| --- | --- |
| [BuildInfo](#BuildInfo) | Information about the product's build. |
| [GUIAvailable](#GUIAvailable) | Whether or not a message loop is available for processing events. |
| [LicenseInfo](#LicenseInfo) | Information about the current license. |
| [MaskSensitiveData](#MaskSensitiveData) | Whether sensitive data is masked in log messages. |
| [UseDaemonThreads](#UseDaemonThreads) | Whether threads created by the class are daemon threads. |
| [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) | Tells the class whether or not to use FIPS certified APIs. |
| [UseInternalSecurityAPI](#UseInternalSecurityAPI) | Whether or not to use the system security libraries or an internal implementation. |
| [UseVirtualThreads](#UseVirtualThreads) | Whether threads created by the class use virtual threads instead of platform threads. |

# AsyncMDNURL Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

The URL for posting Async MDNs.

## Syntax

```text
public String getAsyncMDNURL();
public void setAsyncMDNURL(String asyncMDNURL);
```

## 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](#requestmdnsynchronous-property-as2profilemgr-class).

# CreateDirStruct Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Option to create file management directories.

## Syntax

```text
public boolean isCreateDirStruct();
public void setCreateDirStruct(boolean createDirStruct);
```

## 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](#saveprofile-method-as2profilemgr-class) is invoked.

# DataDir Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

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

## Syntax

```text
public String getDataDir();
public void setDataDir(String dataDir);
```

## 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](#saveprofile-method-as2profilemgr-class).

# DirDeleted Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

The directory used to store deleted files.

## Syntax

```text
public String getDirDeleted();
```

## Default Value

""

## Remarks

If [CreateDirStruct](#createdirstruct-property-as2profilemgr-class) was true when [SaveProfile](#saveprofile-method-as2profilemgr-class) 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](#loadprofile-method-as2profilemgr-class).

This property is read-only.

# DirIncoming Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

The directory used to store incoming files.

## Syntax

```text
public String getDirIncoming();
```

## Default Value

""

## Remarks

If [CreateDirStruct](#createdirstruct-property-as2profilemgr-class) was true when [SaveProfile](#saveprofile-method-as2profilemgr-class) 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](#loadprofile-method-as2profilemgr-class).

This property is read-only.

# DirLogs Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

The directory used to store log files.

## Syntax

```text
public String getDirLogs();
```

## Default Value

""

## Remarks

If [CreateDirStruct](#createdirstruct-property-as2profilemgr-class) was true when [SaveProfile](#saveprofile-method-as2profilemgr-class) 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](#loadprofile-method-as2profilemgr-class).

This property is read-only.

# DirOutgoing Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

The directory used to store outgoing files.

## Syntax

```text
public String getDirOutgoing();
```

## Default Value

""

## Remarks

If [CreateDirStruct](#createdirstruct-property-as2profilemgr-class) was true when [SaveProfile](#saveprofile-method-as2profilemgr-class) 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](#loadprofile-method-as2profilemgr-class).

This property is read-only.

# DirPending Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

The directory used to store files waiting for Async MDN.

## Syntax

```text
public String getDirPending();
```

## Default Value

""

## Remarks

If [CreateDirStruct](#createdirstruct-property-as2profilemgr-class) was true when [SaveProfile](#saveprofile-method-as2profilemgr-class) 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](#loadprofile-method-as2profilemgr-class).

This property is read-only.

# DirPendingInfo Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

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

## Syntax

```text
public String getDirPendingInfo();
```

## Default Value

""

## Remarks

If [CreateDirStruct](#createdirstruct-property-as2profilemgr-class) was true when [SaveProfile](#saveprofile-method-as2profilemgr-class) 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](#loadprofile-method-as2profilemgr-class).

This property is read-only.

# DirSent Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

The directory used to store sent files.

## Syntax

```text
public String getDirSent();
```

## Default Value

""

## Remarks

If [CreateDirStruct](#createdirstruct-property-as2profilemgr-class) was true when [SaveProfile](#saveprofile-method-as2profilemgr-class) 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](#loadprofile-method-as2profilemgr-class).

This property is read-only.

# Email Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Your email address.

## Syntax

```text
public String getEmail();
public void setEmail(String 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](AS2Sender.md#AS2Sender) for details.

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **Email** will contain your currently configured email address, alternatively **Email** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# EncryptionCert Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Certificate used for encryption or decryption.

## Syntax

```text
public Certificate getEncryptionCert();
public void setEncryptionCert(Certificate encryptionCert);
```

## 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](AS2Sender.md#AS2Sender) to encrypt outgoing data. It is also used by [AS2Receiver](AS2Receiver.md#AS2Receiver) to verify signatures on incoming data if a separate [SigningCert](#signingcert-property-as2profilemgr-class) 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](AS2Receiver.md#AS2Receiver) to decrypt incoming data. It is also used by [AS2Sender](AS2Sender.md#AS2Sender) to sign outgoing data if a separate [SigningCert](#signingcert-property-as2profilemgr-class) is not specified.

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **EncryptionCert** will contain the currently saved encryption certificate, alternatively **EncryptionCert** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# OptionCompress Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Preference to compress outgoing data.

## Syntax

```text
public boolean isOptionCompress();
public void setOptionCompress(boolean optionCompress);
```

## Default Value

False

## Remarks

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

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **OptionCompress** will contain your compression preference for your trading partner, alternatively **OptionCompress** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# OptionEncrypt Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Preference to encrypt outgoing data.

## Syntax

```text
public boolean isOptionEncrypt();
public void setOptionEncrypt(boolean optionEncrypt);
```

## 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](#encryptioncert-property-as2profilemgr-class) must be specified. When a profile with **OptionEncrypt** set to true is loaded into [AS2Sender](AS2Sender.md#AS2Sender), the default encryption algorithm is *AESCBC256*.

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **OptionEncrypt** will contain your encryption preference for your trading partner, alternatively **OptionEncrypt** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# OptionSign Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Preference to sign outgoing data.

## Syntax

```text
public boolean isOptionSign();
public void setOptionSign(boolean optionSign);
```

## Default Value

False

## Remarks

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

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **OptionSign** will contain your signing preference for your trading partner, alternatively **OptionSign** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# Organization Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

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

## Syntax

```text
public String getOrganization();
public void setOrganization(String 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](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

Invoking [LoadProfile](#loadprofile-method-as2profilemgr-class) reads the AS2 identifier into **Organization**, alternatively you can save the AS2 identifier by setting **Organization** and invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# PartnerCount Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

The number of partners found in DataDir .

## Syntax

```text
public int getPartnerCount();
```

## Default Value

0

## Remarks

This property returns the number of partners found in [DataDir](#datadir-property-as2profilemgr-class). This property is populated after calling [ListPartners](#listpartners-method-as2profilemgr-class).

This property is read-only and not available at design time.

# RequestMDN Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Preference to receive MDNs from trading partner.

## Syntax

```text
public boolean isRequestMDN();
public void setRequestMDN(boolean requestMDN);
```

## 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](#loadprofile-method-as2profilemgr-class), the **RequireMDN** will contain your preference of receiving MDNs, alternatively **RequireMDN** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# RequestMDNSigned Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Preference to request for signed MDNs.

## Syntax

```text
public boolean isRequestMDNSigned();
public void setRequestMDNSigned(boolean requestMDNSigned);
```

## Default Value

True

## Remarks

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

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **MDNRequestSigned** will contain your preference of requesting signed MDNs, alternatively **MDNRequestSigned** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# RequestMDNSynchronous Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Preference to request for synchronous MDNs.

## Syntax

```text
public boolean isRequestMDNSynchronous();
public void setRequestMDNSynchronous(boolean requestMDNSynchronous);
```

## Default Value

True

## Remarks

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

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **MDNRequestSynchronous** will contain your preference of requesting synchronous MDNs, alternatively **MDNRequestSynchronous** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# RequireEncrypt Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Preference to receive encrypted messages.

## Syntax

```text
public boolean isRequireEncrypt();
public void setRequireEncrypt(boolean requireEncrypt);
```

## Default Value

False

## Remarks

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

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **RequireEncrypt** will contain your preference of receiving encrypted messages, alternatively **RequireEncrypt** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# RequireSign Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Preference to receive signed messages.

## Syntax

```text
public boolean isRequireSign();
public void setRequireSign(boolean requireSign);
```

## Default Value

False

## Remarks

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

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **RequireSign** will contain your preference of receiving signed messages, alternatively **RequireSign** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# SigningCert Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Certificate used for signing or signature validation.

## Syntax

```text
public Certificate getSigningCert();
public void setSigningCert(Certificate signingCert);
```

## 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](AS2Receiver.md#AS2Receiver) to verify the signature on incoming data. If **SigningCert** is not specified [EncryptionCert](#encryptioncert-property-as2profilemgr-class) 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](AS2Sender.md#AS2Sender) to sign outgoing data. If **SigningCert** is not specified the [EncryptionCert](#encryptioncert-property-as2profilemgr-class) is used for signing as well.

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **SigningCert** will contain the currently saved signing certificate, alternatively **SigningCert** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# SSLCert Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

Certificate used for secure communication over SSL.

## Syntax

```text
public Certificate getSSLCert();
public void setSSLCert(Certificate SSLCert);
```

## 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](AS2Sender.md#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](AS2Sender.md#AS2Sender) for client side SSL authentication.

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **SSLCert** will contain the currently saved SSL certificate, alternatively **SSLCert** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

 Please refer to the [Certificate](#certificate-type) type for a complete list of fields.

# URL Property ([AS2ProfileMgr](#as2profilemgr-class) Class)

The URL for posting EDI data.

## Syntax

```text
public String getURL();
public void setURL(String 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](AS2Sender.md#AS2Sender) for details.

In the case of "self" profile i.e. when the parameter *partnerIdentifier* is "self" in [LoadProfile](#loadprofile-method-as2profilemgr-class) or [SaveProfile](#saveprofile-method-as2profilemgr-class), **URL** refers to the URL that your trading partners use to post data to you.

After invoking [LoadProfile](#loadprofile-method-as2profilemgr-class), the **URL** will contain the URL of your trading partner, alternatively **URL** may be set and saved by invoking [SaveProfile](#saveprofile-method-as2profilemgr-class).

# Config Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

Sets or retrieves a configuration setting.

## Syntax

```text
public String config(String configurationString);
```

## Remarks

Config is a generic method available in every class. It is used to set and retrieve [configuration settings](#config-settings-as2profilemgr-class) 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](#config-settings-as2profilemgr-class), you must call *Config("PROPERTY")*. The value will be returned as a string.

# DeleteProfile Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

Deletes the configuration of the specified partner.

## Syntax

```text
public void deleteProfile(String partnerOrganization);
```

## Remarks

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

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

# GetProperty Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

Gets the property propName .

## Syntax

```text
public String getProperty(String propName);
```

## Remarks

**GetProperty** can be used to query any property from "self" or partner profile. It is specially useful in retrieving properties not interpreted by [AS2Sender](AS2Sender.md#AS2Sender) [AS2Receiver](AS2Receiver.md#AS2Receiver) classes and thus not exposed as **AS2ProfileMgr** properties.

**GetProperty** returns *null* if property *propName* was not read by [LoadProfile](#loadprofile-method-as2profilemgr-class).

# GetTPInfo Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

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

## Syntax

```text
public String getTPInfo(String partnerOrganization);
```

## Remarks

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

# ListPartners Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

Lists trading partners known to the AS2ProfileMgr .

## Syntax

```text
public void listPartners();
```

## Remarks

Invoking *ListPartners* causes the event [Partner](#partner-event-as2profilemgr-class) to be fired for each trading partner profile found by the **AS2ProfileMgr** class.

After this method returns [PartnerCount](#partnercount-property-as2profilemgr-class) is populated with the number of found partners.

# ListProperties Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

Lists the properties read from self or partner profile.

## Syntax

```text
public void listProperties();
```

## Remarks

Invoking *ListProperties* causes the event [Property](#property-event-as2profilemgr-class) to be fired for each property read by [LoadProfile](#loadprofile-method-as2profilemgr-class).

# LoadProfile Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

Loads the profile of the trading partner identified by partnerOrganization .

## Syntax

```text
public void loadProfile(String partnerOrganization);
```

## Remarks

If the *partnerOrganization* is not "self", the properties of **AS2ProfileMgr** are read from the XML file *partner.cfg*. The file is expected to be in a sub-directory within [DataDir](#datadir-property-as2profilemgr-class). 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](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

**Partner Settings**

- [Organization](#organization-property-as2profilemgr-class)
- [URL](#url-property-as2profilemgr-class)
- [OptionSign](#optionsign-property-as2profilemgr-class)
- [OptionEncrypt](#optionencrypt-property-as2profilemgr-class)
- [OptionCompress](#optioncompress-property-as2profilemgr-class)
- [RequireSign](#requiresign-property-as2profilemgr-class)
- [RequireEncrypt](#requireencrypt-property-as2profilemgr-class)
- [RequestMDN](#requestmdn-property-as2profilemgr-class)
- [RequestMDNSigned](#requestmdnsigned-property-as2profilemgr-class)
- [RequestMDNSynchronous](#requestmdnsynchronous-property-as2profilemgr-class)
- [EncryptionCert](#encryptioncert-property-as2profilemgr-class)
- [SigningCert](#signingcert-property-as2profilemgr-class)
- [SSLCert](#sslcert-property-as2profilemgr-class)

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](#datadir-property-as2profilemgr-class).

Although all properties are read from the self profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

**My Settings**

- [Organization](#organization-property-as2profilemgr-class)
- [URL](#url-property-as2profilemgr-class)
- [Email](#email-property-as2profilemgr-class)
- [EncryptionCert](#encryptioncert-property-as2profilemgr-class)
- [SigningCert](#signingcert-property-as2profilemgr-class)
- [SSLCert](#sslcert-property-as2profilemgr-class)
- [AsyncMDNURL](#asyncmdnurl-property-as2profilemgr-class)

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

# Reset Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

Resets the state of the control.

## Syntax

```text
public void reset();
```

## Remarks

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

# SaveProfile Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

Saves the profile of the trading partner identified by partnerOrganization .

## Syntax

```text
public void saveProfile(String partnerOrganization);
```

## Remarks

If the *partnerOrganization* is not "self", the properties of **AS2ProfileMgr** are saved to the XML file *partner.cfg* placed in a sub-directory within [DataDir](#datadir-property-as2profilemgr-class). 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](#createdirstruct-property-as2profilemgr-class) is set to true.

|  |  |
| --- | --- |
| [DirDeleted](#dirdeleted-property-as2profilemgr-class) | Deleted files. |
| [DirIncoming](#dirincoming-property-as2profilemgr-class) | Received files. |
| [DirLogs](#dirlogs-property-as2profilemgr-class) | Log files. |
| [DirOutgoing](#diroutgoing-property-as2profilemgr-class) | Files to be sent. |
| [DirPending](#dirpending-property-as2profilemgr-class) | Files pending async MDN. |
| [DirPendingInfo](#dirpendinginfo-property-as2profilemgr-class) | Files having data to verify async MSN. |
| [DirSent](#dirsent-property-as2profilemgr-class) | Sent files. |

Although any number of properties may be saved to the partner profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

**Partner Settings**

- [Organization](#organization-property-as2profilemgr-class)
- [URL](#url-property-as2profilemgr-class)
- [OptionSign](#optionsign-property-as2profilemgr-class)
- [OptionEncrypt](#optionencrypt-property-as2profilemgr-class)
- [OptionCompress](#optioncompress-property-as2profilemgr-class)
- [RequireSign](#requiresign-property-as2profilemgr-class)
- [RequireEncrypt](#requireencrypt-property-as2profilemgr-class)
- [RequestMDN](#requestmdn-property-as2profilemgr-class)
- [RequestMDNSigned](#requestmdnsigned-property-as2profilemgr-class)
- [RequestMDNSynchronous](#requestmdnsynchronous-property-as2profilemgr-class)
- [EncryptionCert](#encryptioncert-property-as2profilemgr-class)
- [SigningCert](#signingcert-property-as2profilemgr-class)
- [SSLCert](#sslcert-property-as2profilemgr-class)

If the *partnerOrganization* specified is "self", the properties of **AS2ProfileMgr** are saved to the XML file *me.cfg* placed in [DataDir](#datadir-property-as2profilemgr-class).

Although any number of properties may be saved to the self profile, the following are interpreted by [AS2Sender](AS2Sender.md#AS2Sender) and [AS2Receiver](AS2Receiver.md#AS2Receiver) classes.

**My Settings**

- [Organization](#organization-property-as2profilemgr-class)
- [URL](#url-property-as2profilemgr-class)
- [Email](#email-property-as2profilemgr-class)
- [EncryptionCert](#encryptioncert-property-as2profilemgr-class)
- [SigningCert](#signingcert-property-as2profilemgr-class)
- [SSLCert](#sslcert-property-as2profilemgr-class)
- [AsyncMDNURL](#asyncmdnurl-property-as2profilemgr-class)

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

# SetProperty Method ([AS2ProfileMgr](#as2profilemgr-class) Class)

Sets the property propName to propValue .

## Syntax

```text
public void setProperty(String propName, String propValue);
```

## Remarks

**SetProperty** can be used to set any property in self or partner profile. It is specially useful in setting properties not interpreted by [AS2Sender](AS2Sender.md#AS2Sender) [AS2Receiver](AS2Receiver.md#AS2Receiver) classes and thus not exposed as **AS2ProfileMgr** properties.

# Error Event ([AS2ProfileMgr](#as2profilemgr-class) Class)

Fired when information is available about errors during data delivery.

## Syntax

```text
public class DefaultAS2ProfileMgrEventListener implements AS2ProfileMgrEventListener {
  ...
  public void error(AS2ProfileMgrErrorEvent e) {}
  ...
}

public class AS2ProfileMgrErrorEvent {
  public int errorCode;
  public String description;
}
```

## Remarks

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

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](#trappable-errors-as2profilemgr-class) section.

# Partner Event ([AS2ProfileMgr](#as2profilemgr-class) Class)

Fired when ListPartners is invoked.

## Syntax

```text
public class DefaultAS2ProfileMgrEventListener implements AS2ProfileMgrEventListener {
  ...
  public void partner(AS2ProfileMgrPartnerEvent e) {}
  ...
}

public class AS2ProfileMgrPartnerEvent {
  public String partnerIdentifier;
  public String partnerURL;
}
```

## Remarks

This event is fired when [ListPartners](#listpartners-method-as2profilemgr-class) is called. It fires for each partner found by the **AS2ProfileMgr** in [DataDir](#datadir-property-as2profilemgr-class). The parameter *partnerIdentifier* is same as provided to [SaveProfile](#saveprofile-method-as2profilemgr-class) to save the partner profile. The URL provided by the trading partner to post AS2 messages can be read from *partnerURL*.

# PartnerDirectory Event ([AS2ProfileMgr](#as2profilemgr-class) Class)

Fired before accessing partner.cfg of a trading partner.

## Syntax

```text
public class DefaultAS2ProfileMgrEventListener implements AS2ProfileMgrEventListener {
  ...
  public void partnerDirectory(AS2ProfileMgrPartnerDirectoryEvent e) {}
  ...
}

public class AS2ProfileMgrPartnerDirectoryEvent {
  public String name;
  public String directory; //read-write
}
```

## Remarks

This event is fired every time *partner.cfg* needs to be accessed i.e when [LoadProfile](#loadprofile-method-as2profilemgr-class) or [GetTPInfo](#gettpinfo-method-as2profilemgr-class) 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](#listpartners-method-as2profilemgr-class) is invoked.

# Property Event ([AS2ProfileMgr](#as2profilemgr-class) Class)

Fired when ListProperties is invoked.

## Syntax

```text
public class DefaultAS2ProfileMgrEventListener implements AS2ProfileMgrEventListener {
  ...
  public void property(AS2ProfileMgrPropertyEvent e) {}
  ...
}

public class AS2ProfileMgrPropertyEvent {
  public String propName;
  public String propValue;
}
```

## Remarks

This event is fired when [ListProperties](#listproperties-method-as2profilemgr-class) is called. It fires for each property read by [LoadProfile](#loadprofile-method-as2profilemgr-class). 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.

The following fields are available:

- [EffectiveDate](#Certificate_f_EffectiveDate)

- [ExpirationDate](#Certificate_f_ExpirationDate)

- [ExtendedKeyUsage](#Certificate_f_ExtendedKeyUsage)

- [Fingerprint](#Certificate_f_Fingerprint)

- [FingerprintSHA1](#Certificate_f_FingerprintSHA1)

- [FingerprintSHA256](#Certificate_f_FingerprintSHA256)

- [Issuer](#Certificate_f_Issuer)

- [KeyPassword](#Certificate_f_KeyPassword)

- [PrivateKey](#Certificate_f_PrivateKey)

- [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable)

- [PrivateKeyContainer](#Certificate_f_PrivateKeyContainer)

- [PublicKey](#Certificate_f_PublicKey)

- [PublicKeyAlgorithm](#Certificate_f_PublicKeyAlgorithm)

- [PublicKeyLength](#Certificate_f_PublicKeyLength)

- [SerialNumber](#Certificate_f_SerialNumber)

- [SignatureAlgorithm](#Certificate_f_SignatureAlgorithm)

- [Store](#Certificate_f_Store)

- [StorePassword](#Certificate_f_StorePassword)

- [StoreType](#Certificate_f_StoreType)

- [SubjectAltNames](#Certificate_f_SubjectAltNames)

- [ThumbprintMD5](#Certificate_f_ThumbprintMD5)

- [ThumbprintSHA1](#Certificate_f_ThumbprintSHA1)

- [ThumbprintSHA256](#Certificate_f_ThumbprintSHA256)

- [Usage](#Certificate_f_Usage)

- [UsageFlags](#Certificate_f_UsageFlags)

- [Version](#Certificate_f_Version)

- [Subject](#Certificate_f_Subject)

- [Encoded](#Certificate_f_Encoded)

## Fields

 **EffectiveDate** *String (read-only)*
*Default Value: ""*

The date on which this certificate becomes valid. Before this date, it is not valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2000 15:00:00.

 **ExpirationDate** *String (read-only)*
*Default Value: ""*

The date on which the certificate expires. After this date, the certificate will no longer be valid. The date is localized to the system's time zone. The following example illustrates the format of an encoded date:

23-Jan-2001 15:00:00.

 **ExtendedKeyUsage** *String (read-only)*
*Default Value: ""*

A comma-delimited list of extended key usage identifiers. These are the same as ASN.1 object identifiers (OIDs).

 **Fingerprint** *String (read-only)*
*Default Value: ""*

The hex-encoded, 16-byte MD5 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *bc:2a:72:af:fe:58:17:43:7a:5f:ba:5a:7c:90:f7:02*

 **FingerprintSHA1** *String (read-only)*
*Default Value: ""*

The hex-encoded, 20-byte SHA-1 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *30:7b:fa:38:65:83:ff:da:b4:4e:07:3f:17:b8:a4:ed:80:be:ff:84*

 **FingerprintSHA256** *String (read-only)*
*Default Value: ""*

The hex-encoded, 32-byte SHA-256 fingerprint of the certificate. This property is primarily used for keys which do not have a corresponding X.509 public certificate, such as PEM keys that only contain a private key. It is commonly used for SSH keys.

The following example illustrates the format: *6a:80:5c:33:a9:43:ea:b0:96:12:8a:64:96:30:ef:4a:8a:96:86:ce:f4:c7:be:10:24:8e:2b:60:9e:f3:59:53*

 **Issuer** *String (read-only)*
*Default Value: ""*

The issuer of the certificate. This field contains a string representation of the name of the issuing authority for the certificate.

 **KeyPassword** *String*
*Default Value: ""*

The password for the certificate's private key (if any).

Some certificate stores may individually protect certificates' private keys, separate from the standard protection offered by the [StorePassword](#Certificate_f_StorePassword). This field can be used to read such password-protected private keys.

NOTE: This property defaults to the value of [StorePassword](#Certificate_f_StorePassword). To clear it, you must set the property to the empty string (""). It can be set at any time, but when the private key's password is different from the store's password, then it must be set before calling [PrivateKey](#Certificate_f_PrivateKey).

 **PrivateKey** *String (read-only)*
*Default Value: ""*

The private key of the certificate (if available). The key is provided as PEM/Base64-encoded data.

NOTE: The [PrivateKey](#Certificate_f_PrivateKey) may be available but not exportable. In this case, [PrivateKey](#Certificate_f_PrivateKey) returns an empty string.

 **PrivateKeyAvailable** *boolean (read-only)*
*Default Value: False*

Whether a [PrivateKey](#Certificate_f_PrivateKey) is available for the selected certificate. If [PrivateKeyAvailable](#Certificate_f_PrivateKeyAvailable) is True, the certificate may be used for authentication purposes (e.g., server authentication).

 **PrivateKeyContainer** *String (read-only)*
*Default Value: ""*

The name of the [PrivateKey](#Certificate_f_PrivateKey) container for the certificate (if available). This functionality is available only on Windows platforms.

 **PublicKey** *String (read-only)*
*Default Value: ""*

The public key of the certificate. The key is provided as PEM/Base64-encoded data.

 **PublicKeyAlgorithm** *String (read-only)*
*Default Value: ""*

The textual description of the certificate's public key algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_DH") or an object identifier (OID) string representing the algorithm.

 **PublicKeyLength** *int (read-only)*
*Default Value: 0*

The length of the certificate's public key (in bits). Common values are 512, 1024, and 2048.

 **SerialNumber** *String (read-only)*
*Default Value: ""*

The serial number of the certificate encoded as a string. The number is encoded as a series of hexadecimal digits, with each pair representing a byte of the serial number.

 **SignatureAlgorithm** *String (read-only)*
*Default Value: ""*

The text description of the certificate's signature algorithm. The property contains either the name of the algorithm (e.g., "RSA" or "RSA_MD5RSA") or an object identifier (OID) string representing the algorithm.

 **Store** *String*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

In Java, the certificate store normally is a file containing certificates and optional private keys.

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

 **StoreB** *byte[]*
*Default Value: "MY"*

The name of the certificate store for the client certificate.

The [StoreType](#Certificate_f_StoreType) field denotes the type of the certificate store specified by [Store](#Certificate_f_Store). If the store is password-protected, specify the password in [StorePassword](#Certificate_f_StorePassword).

[Store](#Certificate_f_Store) is used in conjunction with the [Subject](#Certificate_f_Subject) field to specify client certificates. If [Store](#Certificate_f_Store) has a value, and [Subject](#Certificate_f_Subject) or [Encoded](#Certificate_f_Encoded) is set, a search for a certificate is initiated. Please see the [Subject](#Certificate_f_Subject) field for details.

 Designations of certificate stores are platform dependent.

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

|  |  |
| --- | --- |
| MY | A certificate store holding personal certificates with their associated private keys. |
| CA | Certifying authority certificates. |
| ROOT | Root certificates. |

In Java, the certificate store normally is a file containing certificates and optional private keys.

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

 **StorePassword** *String*
*Default Value: ""*

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

 **StoreType** *int*
*Default Value: 0*

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 field can take one of the following values:

```csharp
sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11,
                               @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll",
                               "123456", // PIN
                               "CN=cert_subject");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

```csharp
certmgr.CertStoreType = CertStoreTypes.cstPKCS11;
certmgr.OnCertList += (s, e) => {
  secKeyBlob = e.CertEncoded;
};
certmgr.CertStore = @"C:\Program Files\OpenSC Project\OpenSC\pkcs11\opensc-pkcs11.dll";
certmgr.CertStorePassword = "123456"; // PIN
certmgr.ListStoreCertificates();

sftp.SSHCert = new Certificate(CertStoreTypes.cstPKCS11, secKeyBlob, "123456", "*");
sftp.SSHUser = "test";
sftp.SSHLogon("myhost", 22);
```

|  |  |
| --- | --- |
| 0 (cstUser - default) | For Windows, this specifies that the certificate store is a certificate store owned by the current user. NOTE: This store type is not available in Java. |
| 1 (cstMachine) | For Windows, this specifies that the certificate store is a machine store. NOTE: This store type is not available in Java. |
| 2 (cstPFXFile) | The certificate store is the name of a PFX (PKCS#12) file containing certificates. |
| 3 (cstPFXBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in PFX (PKCS#12) format. |
| 4 (cstJKSFile) | The certificate store is the name of a Java Key Store (JKS) file containing certificates. NOTE: This store type is only available in Java. |
| 5 (cstJKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in Java Key Store (JKS) format. NOTE: This store type is only available in Java. |
| 6 (cstPEMKeyFile) | The certificate store is the name of a PEM-encoded file that contains a private key and an optional certificate. |
| 7 (cstPEMKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a private key and an optional certificate. |
| 8 (cstPublicKeyFile) | The certificate store is the name of a file that contains a PEM- or DER-encoded public key certificate. |
| 9 (cstPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains a PEM- or DER-encoded public key certificate. |
| 10 (cstSSHPublicKeyBlob) | The certificate store is a string (binary or Base64-encoded) that contains an SSH-style public key. |
| 11 (cstP7BFile) | The certificate store is the name of a PKCS#7 file containing certificates. |
| 12 (cstP7BBlob) | The certificate store is a string (binary) representing a certificate store in PKCS#7 format. |
| 13 (cstSSHPublicKeyFile) | The certificate store is the name of a file that contains an SSH-style public key. |
| 14 (cstPPKFile) | The certificate store is the name of a file that contains a PPK (PuTTY Private Key). |
| 15 (cstPPKBlob) | The certificate store is a string (binary) that contains a PPK (PuTTY Private Key). |
| 16 (cstXMLFile) | The certificate store is the name of a file that contains a certificate in XML format. |
| 17 (cstXMLBlob) | The certificate store is a string that contains a certificate in XML format. |
| 18 (cstJWKFile) | The certificate store is the name of a file that contains a JWK (JSON Web Key). |
| 19 (cstJWKBlob) | The certificate store is a string that contains a JWK (JSON Web Key). |
| 21 (cstBCFKSFile) | The certificate store is the name of a file that contains a BCFKS (Bouncy Castle FIPS Key Store). NOTE: This store type is only available in Java and .NET. |
| 22 (cstBCFKSBlob) | The certificate store is a string (binary or Base64-encoded) representing a certificate store in BCFKS (Bouncy Castle FIPS Key Store) format. NOTE: This store type is only available in Java and .NET. |
| 23 (cstPKCS11) | The certificate is present on a physical security key accessible via a PKCS#11 interface. To use a security key, create a new [Certificate](#certificate-type) object and pass cstPKCS11 as the [StoreType](#Certificate_f_StoreType), the full path of the PKCS#11 DLL as the [Store](#Certificate_f_Store), and the PIN as the [StorePassword](#Certificate_f_StorePassword). Code Example. SSH Authentication with Security Key (without CertMgr): Alternatively, collect the necessary data using the [CertMgr](CertMgr.md#CertMgr) class by calling the [ListStoreCertificates](CertMgr.md#CertMgr_m_ListStoreCertificates) method after setting the corresponding properties accordingly. The certificate information returned in the [CertList](CertMgr.md#CertMgr_e_CertList) event's CertEncoded parameter may be saved for later use. When using a certificate obtained with this approach, pass the previously saved security key information as the [Store](#Certificate_f_Store) and set [StorePassword](#Certificate_f_StorePassword) to the PIN. Code Example. SSH Authentication with Security Key (with CertMgr): |
| 99 (cstAuto) | The store type is automatically detected from the input data. This setting may be used with both public and private keys and can detect any of the supported formats automatically. |

 **SubjectAltNames** *String (read-only)*
*Default Value: ""*

Comma-separated lists of alternative subject names for the certificate.

 **ThumbprintMD5** *String (read-only)*
*Default Value: ""*

The MD5 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA1** *String (read-only)*
*Default Value: ""*

The SHA-1 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **ThumbprintSHA256** *String (read-only)*
*Default Value: ""*

The SHA-256 hash of the certificate. It is primarily used for X.509 certificates. If the hash does not already exist, it is automatically computed.

 **Usage** *String (read-only)*
*Default Value: ""*

The text description of [UsageFlags](#Certificate_f_UsageFlags).

This value will be one or more of the following strings and will be separated by commas:

- Digital Signature
- Non-Repudiation
- Key Encipherment
- Data Encipherment
- Key Agreement
- Certificate Signing
- CRL Signing
- Encipher Only

If the provider is OpenSSL, the value is a comma-separated list of X.509 certificate extension names.

 **UsageFlags** *int (read-only)*
*Default Value: 0*

The flags that show intended use for the certificate. The value of [UsageFlags](#Certificate_f_UsageFlags) is a combination of the following flags:

|  |  |
| --- | --- |
| 0x80 | Digital Signature |
| 0x40 | Non-Repudiation |
| 0x20 | Key Encipherment |
| 0x10 | Data Encipherment |
| 0x08 | Key Agreement |
| 0x04 | Certificate Signing |
| 0x02 | CRL Signing |
| 0x01 | Encipher Only |

Please see the [Usage](#Certificate_f_Usage) field for a text representation of [UsageFlags](#Certificate_f_UsageFlags).

This functionality currently is not available when the provider is OpenSSL.

 **Version** *String (read-only)*
*Default Value: ""*

The certificate's version number. The possible values are the strings "V1", "V2", and "V3".

 **Subject** *String*
*Default Value: ""*

The subject of the certificate used for client authentication.

This field will be populated with the full subject of the loaded certificate. When loading a certificate, the subject is used to locate the certificate in the store.

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=example@email.com". Common fields and their meanings are as follows:

| Field | Meaning |
| --- | --- |
| CN | Common Name. This is commonly a hostname like www.server.com. |
| O | Organization |
| OU | Organizational Unit |
| L | Locality |
| S | State |
| C | Country |
| E | Email Address |

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

 **Encoded** *String*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

 **EncodedB** *byte[]*
*Default Value: ""*

The certificate (PEM/Base64 encoded). This field is used to assign a specific certificate. The [Store](#Certificate_f_Store) and [Subject](#Certificate_f_Subject) fields also may be used to specify a certificate.

When [Encoded](#Certificate_f_Encoded) is set, a search is initiated in the current [Store](#Certificate_f_Store) for the private key of the certificate. If the key is found, [Subject](#Certificate_f_Subject) is updated to reflect the full subject of the selected certificate; otherwise, [Subject](#Certificate_f_Subject) is set to an empty string.

## Constructors

```text
public Certificate();
```

 Creates a instance whose properties can be set.

```text
public Certificate(String certificateFile);
```

 Opens * CertificateFile * and reads out the contents as an X.509 public key.

```text
public Certificate(byte[] encoded);
```

 Parses * Encoded * as an X.509 public key.

```text
public Certificate(int storeType, String store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See 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 class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See 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 CryptoAPI option. The default value is True (the key is persisted). "Thumbprint" - an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load. When specified, this value is used to select the certificate in the store. This is applicable to the * 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 class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, String store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See 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 class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, String subject, String configurationString);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will attempt to find the certificate identified by * Subject * . This can be either a complete or a substring match of the X.509 certificate's subject Distinguished Name (DN). The * Subject * parameter can also take an MD5, SHA-1, or SHA-256 thumbprint of the certificate to load in a "Thumbprint=value" format.

```text
public Certificate(int storeType, byte[] store, String storePassword, byte[] encoded);
```

 * StoreType * identifies the type of certificate store to use. See for descriptions of the different certificate stores. * Store * is a byte array containing the certificate data. * StorePassword * is the password used to protect the store.

 After the store has been successfully opened, the class will load * Encoded * as an X.509 certificate and search the opened store for a corresponding private key.

# Config Settings ([AS2ProfileMgr](#as2profilemgr-class) Class)

 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](#config-method-as2profilemgr-class) method.

### Base Config Settings

**BuildInfo**: Information about the product's build.When queried, this setting will return a string containing information about the product's build.

**GUIAvailable**: Whether or not a message loop is available for processing events.In a GUI-based application, long-running blocking operations may cause the application to stop responding to input until the operation returns. The class will attempt to discover whether or not the application has a message loop and, if one is discovered, it will process events in that message loop during any such blocking operation.

In some non-GUI applications, an invalid message loop may be discovered that will result in errant behavior. In these cases, setting [GUIAvailable](#GUIAvailable) to *false* will ensure that the class does not attempt to process external events.

**LicenseInfo**: Information about the current license.When queried, this setting will return a string containing information about the license this instance of a class is using. It will return the following information:

- Product: The product the license is for.
- Product Key: The key the license was generated from.
- License Source: Where the license was found (e.g., RuntimeLicense, License File).
- License Type: The type of license installed (e.g., Royalty Free, Single Server).
- Last Valid Build: The last valid build number for which the license will work.

**MaskSensitiveData**: Whether sensitive data is masked in log messages.In certain circumstances it may be beneficial to mask sensitive data, like passwords, in log messages. Set this to *true* to mask sensitive data. The default is *true*.

**UseDaemonThreads**: Whether threads created by the class are daemon threads.If set to True (default), when the class creates a thread, the thread's Daemon property will be explicitly set to True. When set to False, the class will not set the Daemon property on the created thread. The default value is True.

**UseFIPSCompliantAPI**: Tells the class whether or not to use FIPS certified APIs.When set to *true*, the class will utilize the underlying operating system's certified APIs. Java editions, regardless of OS, utilize Bouncy Castle Federal Information Processing Standards (FIPS), while all other Windows editions make use of Microsoft security libraries.

The Java edition requires installation of the FIPS-certified Bouncy Castle library regardless of the target operating system. This can be downloaded from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). Only the "Provider" library is needed. The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

```text
import java.security.Security;
import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;
```

The Bouncy Castle provider must be added as a valid provider and must also be configured to operate in FIPS mode:

```text
System.setProperty("org.bouncycastle.fips.approved_only","true");
Security.addProvider(new BouncyCastleFipsProvider());
```

When [UseFIPSCompliantAPI](#UseFIPSCompliantAPI) is *true*, Secure Sockets Layer (SSL)-enabled classes can optionally be configured to use the Transport Layer Security (TLS) Bouncy Castle library. When SSLProvider is set to *sslpAutomatic* (default) or *sslpInternal*, an internal TLS implementation is used, but all cryptographic operations are offloaded to the Bouncy Castle FIPS provider to achieve FIPS-compliant operation. If SSLProvider is set to *sslpPlatform*, the Bouncy Castle JSSE will be used in place of the internal TLS implementation.

To enable the use of the Bouncy Castle JSSE take the following steps in addition to the steps above. Both the Bouncy Castle FIPS provider and the Bouncy Castle JSSE must be configured to use the Bouncy Castle TLS library in FIPS mode. Obtain the Bouncy Castle TLS library from [https://www.bouncycastle.org/fips-java/](https://www.bouncycastle.org/fips-java/). The jar file should then be installed in a JRE search path.

The following classes must be imported in the application in which the component will be used:

```text
import java.security.Security;
import org.bouncycastle.jcajce.provider.BouncyCastleFipsProvider;

//required to use BCJSSE when SSLProvider is set to sslpPlatform
import org.bouncycastle.jsse.provider.BouncyCastleJsseProvider;
```

The Bouncy Castle provider must be added as a valid provider and also must be configured to operate in FIPS mode:

```text
System.setProperty("org.bouncycastle.fips.approved_only","true");
Security.addProvider(new BouncyCastleFipsProvider());

//required to use BCJSSE when SSLProvider is set to sslpPlatform
Security.addProvider(new BouncyCastleJsseProvider("fips:BCFIPS"));

//optional - configure logging level of BCJSSE
Logger.getLogger("org.bouncycastle.jsse").setLevel(java.util.logging.Level.OFF);

//configure the class to use BCJSSE
component.setSSLProvider(1); //platform
component.config("UseFIPSCompliantAPI=true");
```

 NOTE: TLS 1.3 support requires the Bouncy Castle TLS library version 1.0.14 or later.

FIPS mode can be enabled by setting the *UseFIPSCompliantAPI* configuration setting to *true*. This is a static setting that applies to all instances of all classes of the toolkit within the process. It is recommended to enable or disable this setting once before the component has been used to establish a connection. Enabling FIPS while an instance of the component is active and connected may result in unexpected behavior.

For more details, please see the [FIPS 140-2 Compliance](https://www.nsoftware.com/kb/articles/fips.rst) article.

NOTE: Enabling FIPS compliance requires a special license; please contact [sales@nsoftware.com](mailto:sales@nsoftware.com) for details.

**UseInternalSecurityAPI**: Whether or not to use the system security libraries or an internal implementation. When set to *false*, the class will use the system security libraries by default to perform cryptographic functions where applicable.

Setting this configuration setting to *true* tells the class to use the internal implementation instead of using the system security libraries.

 This setting is set to *false* by default on all platforms.

**UseVirtualThreads**: Whether threads created by the class use virtual threads instead of platform threads.If set to *true*, when the class creates a thread, it will be created as a virtual thread instead of a platform thread. Virtual threads are lightweight threads managed by the JVM that are multiplexed onto a small pool of carrier threads, significantly reducing memory usage and platform thread count under high-concurrency workloads. Requires Java 24 or later. The default value is *false*.

# Trappable Errors ([AS2ProfileMgr](#as2profilemgr-class) Class)

### AS2ProfileMgr Errors

|  |  |
| --- | --- |
| 601 | Cannot access data directory. |
| 602 | This operation requires data directory to be set. |
| 603 | Cannot save personal profile. |
| 604 | Cannot load personal profile. |
| 605 | Cannot save partner profile. |
| 606 | Cannot load partner profile. |