AS2ProfileMgr Class

Properties   Methods   Events   Config Settings   Errors  

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

Syntax

ipworksedi.AS2ProfileMgr

Remarks

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

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

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

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

Property List

---

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

Method List

---

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

Event List

---

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

Config Settings

---

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

AsyncMDNURL Property (AS2ProfileMgr Class)

The URL for posting Async MDNs.

Syntax

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.

CreateDirStruct Property (AS2ProfileMgr Class)

Option to create file management directories.

Syntax

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

DataDir Property (AS2ProfileMgr Class)

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

Syntax

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.

DirDeleted Property (AS2ProfileMgr Class)

The directory used to store deleted files.

Syntax

public String getDirDeleted();

Default Value

""

Remarks

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

This property is read-only.

DirIncoming Property (AS2ProfileMgr Class)

The directory used to store incoming files.

Syntax

public String getDirIncoming();

Default Value

""

Remarks

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

This property is read-only.

DirLogs Property (AS2ProfileMgr Class)

The directory used to store log files.

Syntax

public String getDirLogs();

Default Value

""

Remarks

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

This property is read-only.

DirOutgoing Property (AS2ProfileMgr Class)

The directory used to store outgoing files.

Syntax

public String getDirOutgoing();

Default Value

""

Remarks

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

This property is read-only.

DirPending Property (AS2ProfileMgr Class)

The directory used to store files waiting for Async MDN.

Syntax

public String getDirPending();

Default Value

""

Remarks

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

This property is read-only.

DirPendingInfo Property (AS2ProfileMgr Class)

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

Syntax

public String getDirPendingInfo();

Default Value

""

Remarks

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

This property is read-only.

DirSent Property (AS2ProfileMgr Class)

The directory used to store sent files.

Syntax

public String getDirSent();

Default Value

""

Remarks

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

This property is read-only.

Email Property (AS2ProfileMgr Class)

Your email address.

Syntax

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

Certificate used for encryption or decryption.

Syntax

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

Please refer to the Certificate type for a complete list of fields.

OptionCompress Property (AS2ProfileMgr Class)

Preference to compress outgoing data.

Syntax

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, the OptionCompress will contain your compression preference for your trading partner, alternatively OptionCompress may be set and saved by invoking SaveProfile.

OptionEncrypt Property (AS2ProfileMgr Class)

Preference to encrypt outgoing data.

Syntax

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

Preference to sign outgoing data.

Syntax

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, the OptionSign will contain your signing preference for your trading partner, alternatively OptionSign may be set and saved by invoking SaveProfile.

Organization Property (AS2ProfileMgr Class)

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

Syntax

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 and AS2Receiver classs.

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

PartnerCount Property (AS2ProfileMgr Class)

The number of partners found in DataDir .

Syntax

public int getPartnerCount();

Default Value

0

Remarks

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

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

RequestMDN Property (AS2ProfileMgr Class)

Preference to receive MDNs from trading partner.

Syntax

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

RequestMDNSigned Property (AS2ProfileMgr Class)

Preference to request for signed MDNs.

Syntax

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, the MDNRequestSigned will contain your preference of requesting signed MDNs, alternatively MDNRequestSigned may be set and saved by invoking SaveProfile.

RequestMDNSynchronous Property (AS2ProfileMgr Class)

Preference to request for synchronous MDNs.

Syntax

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, the MDNRequestSynchronous will contain your preference of requesting synchronous MDNs, alternatively MDNRequestSynchronous may be set and saved by invoking SaveProfile.

RequireEncrypt Property (AS2ProfileMgr Class)

Preference to receive encrypted messages.

Syntax

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, the RequireEncrypt will contain your preference of receiving encrypted messages, alternatively RequireEncrypt may be set and saved by invoking SaveProfile.

RequireSign Property (AS2ProfileMgr Class)

Preference to receive signed messages.

Syntax

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, the RequireSign will contain your preference of receiving signed messages, alternatively RequireSign may be set and saved by invoking SaveProfile.

SigningCert Property (AS2ProfileMgr Class)

Certificate used for signing or signature validation.

Syntax

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

Please refer to the Certificate type for a complete list of fields.

SSLCert Property (AS2ProfileMgr Class)

Certificate used for secure communication over SSL.

Syntax

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

Please refer to the Certificate type for a complete list of fields.

URL Property (AS2ProfileMgr Class)

The URL for posting EDI data.

Syntax

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

Sets or retrieves a configuration setting.

Syntax

public String config(String configurationString);

Remarks

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

These settings are similar in functionality to properties, but they are rarely used. In order to avoid "polluting" the property namespace of the class, access to these internal properties is provided through the Config method.

To set a configuration setting named PROPERTY, you must call Config("PROPERTY=VALUE"), where VALUE is the value of the setting expressed as a string. For boolean values, use the strings "True", "False", "0", "1", "Yes", or "No" (case does not matter).

To read (query) the value of a configuration setting, you must call Config("PROPERTY"). The value will be returned as a string.

DeleteProfile Method (AS2ProfileMgr Class)

Deletes the configuration of the specified partner.

Syntax

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

Gets the property propName .

Syntax

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

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

GetTPInfo Method (AS2ProfileMgr Class)

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

Syntax

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 and AS2Receiver using the method SetTPInfo.

ListPartners Method (AS2ProfileMgr Class)

Lists trading partners known to the AS2ProfileMgr .

Syntax

public void listPartners();

Remarks

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

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

ListProperties Method (AS2ProfileMgr Class)

Lists the properties read from self or partner profile.

Syntax

public void listProperties();

Remarks

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

LoadProfile Method (AS2ProfileMgr Class)

Loads the profile of the trading partner identified by partnerOrganization .

Syntax

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. The name of the sub-directory is derived from partnerOrganization.

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

Partner Settings

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

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

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

My Settings

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

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

Reset Method (AS2ProfileMgr Class)

Resets the state of the control.

Syntax

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

Saves the profile of the trading partner identified by partnerOrganization .

Syntax

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. The name of the sub-directory is derived from partnerOrganization. In addition to saving the partner profile, SaveProfile also creates the following directories if CreateDirStruct is set to true.

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

Partner Settings

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

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

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

My Settings

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

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

SetProperty Method (AS2ProfileMgr Class)

Sets the property propName to propValue .

Syntax

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

Error Event (AS2ProfileMgr Class)

Fired when information is available about errors during data delivery.

Syntax

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

Partner Event (AS2ProfileMgr Class)

Fired when ListPartners is invoked.

Syntax

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 is called. It fires for each partner found by the AS2ProfileMgr in DataDir. The parameter partnerIdentifier is same as provided to SaveProfile to save the partner profile. The URL provided by the trading partner to post AS2 messages can be read from partnerURL.

PartnerDirectory Event (AS2ProfileMgr Class)

Fired before accessing partner.cfg of a trading partner.

Syntax

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 or GetTPInfo are invoked with partner name not being "self". The Name provides the partner name and Directory indicates the directory in which partner profile is expected. Setting Directory to a different path will make the component look for partner.cfg in that directory. Note: PartnerDirectory event is not fired when ListPartners is invoked.

Property Event (AS2ProfileMgr Class)

Fired when ListProperties is invoked.

Syntax

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

public Certificate();

public Certificate( certificateFile);

public Certificate( encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

public Certificate( storeType,  store,  storePassword,  subject);

public Certificate( storeType,  store,  storePassword,  subject,  configurationString);

public Certificate( storeType,  store,  storePassword,  encoded);

Config Settings (AS2ProfileMgr 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 method.

Base Config Settings

Trappable Errors (AS2ProfileMgr Class)

AS2ProfileMgr Errors