CargoWriter Class

Properties Methods Events Config Settings Errors

The CargoWriter class is optimized for Cargo-IMP documents, providing a simple way to create Cargo-IMP documents.

Syntax

ipworkseditranslator.Cargowriter

Remarks

The class allows you to create a document from scratch by writing one value at a time. Here's how a document would normally be created:

Call LoadSchema to load the schema for the message type you want to write.
Call Write once per value to add values to the message.
Once the message is complete, call Finish.

Example CargoWriter Code:

Cargowriter writer = new Cargowriter(); writer.LoadSchema("C:\\cargoimp_schemas\\FSU.json"); writer.Write("1.1", "FSU"); writer.Write("1.3", "15"); writer.Write("2.1.1", "057"); writer.Write("2.1.3", "12345675"); writer.Write("2.2.1", "YYZ"); writer.Write("2.2.2", "LYS"); writer.Write("2.3.2", "T"); writer.Write("2.3.3", "12"); writer.Write("23.1", "OCI"); writer.Write("23.3", "FR"); writer.Write("23.5", "IMP"); writer.Write("23.7", "M"); writer.Write("23.9", "07FR9876AB88901235"); writer.Write("23.5", "HWB"); writer.Write("23.7", "I"); writer.Write("23.9", "ABCD12345678"); writer.Finish();

Schemas are written in JSON format: { "name": "FSU", "desc": "FSU MESSAGE", "children": { "1": { "desc": "Standard Message Identification", "children": { "1.1": { "desc": "Standard Message Identifier", "value": "FSU" }, "1.2": { "value": "/" }, "1.3": { "desc": "Message Type Version Number", "format": "n[...3]" }, "1.4": { "value": "\r\n" } } }, "2": { ... For example schemas and questions, please contact support@nsoftware.com.

Property List

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


OutputData	Contains the output data.
OutputFile	Specifies the name of the file to write to.
Overwrite	Whether to overwrite the file.

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	Sets or retrieves a configuration setting.
Finish	Completes the current message.
LoadSchema	Loads a schema file describing a Message type.
Reset	Resets the class.
SetOutputStream	The stream to which the class will write the data.
Write	Writes a value to the Cargo-IMP message.

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	Fired when information is available about errors during data delivery.
Output	Fires whenever a segment is complete.
ResolveSchema	Fires whenever a new Cargo-Imp message is encountered and no schema is found for it.

Config Settings

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


CloseStreamAfterProcessing	Specifies whether or not the OutputStream should be closed after processing.
BuildInfo	Information about the product's build.
GUIAvailable	Whether or not a message loop is available for processing events.
LicenseInfo	Information about the current license.
MaskSensitive	Whether sensitive data is masked in log messages.
UseDaemonThreads	Whether threads created by the class are daemon threads.
UseFIPSCompliantAPI	Tells the class whether or not to use FIPS certified APIs.
UseInternalSecurityAPI	Whether or not to use the system security libraries or an internal implementation.

OutputData Property (CargoWriter Class)

Contains the output data.

Syntax


public String getOutputData();


public void setOutputData(String outputData);

Default Value

Remarks

This property will be populated with the contents of the Cargo-IMP data as output by the class when no OutputFile has been specified and SetOutputStream has not been called with a valid output stream.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

SetInputStream
InputFile
InputData

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

SetOutputStream
OutputFile
OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

OutputFile Property (CargoWriter Class)

Specifies the name of the file to write to.

Syntax


public String getOutputFile();


public void setOutputFile(String outputFile);

Default Value

Remarks

This property specifies the file to which the Cargo-IMP message will be written. This may be set to an absolute or relative path. This should be set before calling Write.

Input and Output Properties

The class will determine the source and destination of the input and output based on which properties are set.

The order in which the input properties are checked is as follows:

SetInputStream
InputFile
InputData

When a valid source is found the search stops. The order in which the output properties are checked is as follows:

SetOutputStream
OutputFile
OutputData: The output data is written to this property if no other destination is specified.

This property is not available at design time.

Overwrite Property (CargoWriter Class)

Whether to overwrite the file.

Syntax


public boolean isOverwrite();


public void setOverwrite(boolean overwrite);

Default Value

False

Remarks

This property specifies whether the existing file will be overwritten when a new message is created. If set to False (default) the class throws an exception when attempting to write to a file which already exists. If set to True the class will overwrite the existing file.

Config Method (Cargowriter 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.

Finish Method (Cargowriter Class)

Completes the current message.

Syntax

public void finish();

Remarks

When this method is called, the class will finalize the current Cargo-IMP message.

LoadSchema Method (Cargowriter Class)

Loads a schema file describing a Message type.

Syntax

public void loadSchema(String fileName);

Remarks

This method parses the File and loads it into an internal schema list.

If the schema file does not exist or cannot be parsed as an Cargo-IMP schema, the class throws an exception.

Reset Method (Cargowriter Class)

Resets the class.

Syntax

public void reset();

Remarks

When called, the class initializes itself to its default state.

SetOutputStream Method (Cargowriter Class)

The stream to which the class will write the data.

Syntax

public void setOutputStream(java.io.OutputStream outputStream);

Remarks

This method sets the stream to which the class will write the translated data.

Output Properties

The class will determine the source of the output based on which properties are set.

The order in which the output properties are checked is as follows:

SetOutputStream
OutputFile
OutputData

When a valid source is found the search stops.

Write Method (Cargowriter Class)

Writes a value to the Cargo-IMP message.

Syntax

public void write(String name, String value);

Remarks

This method adds a value to the current Cargo-IMP message.

Example CargoWriter Code:

Error Event (Cargowriter Class)

Fired when information is available about errors during data delivery.

Syntax

public class DefaultCargowriterEventListener implements CargowriterEventListener {
  ...
  public void error(CargowriterErrorEvent e) {}
  ...
}

public class CargowriterErrorEvent {
  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.

Output Event (Cargowriter Class)

Fires whenever a segment is complete.

Syntax

public class DefaultCargowriterEventListener implements CargowriterEventListener {
  ...
  public void output(CargowriterOutputEvent e) {}
  ...
}

public class CargowriterOutputEvent {
  public byte[] outputData;
}

Remarks

The Output event will fire when the writer completes a new segment and writes data to the output stream or buffer. The OutputData parameter contains the data bytes.

ResolveSchema Event (Cargowriter Class)

Fires whenever a new Cargo-Imp message is encountered and no schema is found for it.

Syntax

public class DefaultCargowriterEventListener implements CargowriterEventListener {
  ...
  public void resolveSchema(CargowriterResolveSchemaEvent e) {}
  ...
}

public class CargowriterResolveSchemaEvent {
  public String messageIdentifier;
  public String version;
}

Remarks

The ResolveSchema event will fire when a the class encounters a new Cargo-IMP message, but it finds no schema corresponding to it already loaded.

MessageIdentifier contains the message type, such as "FWB" or "FSU".

Version contains the version of the schema used by the message.

When processing this event, the caller can use LoadSchema() to load a new schema into the class that can be used to parse the transaction.

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

CargoWriter Config Settings

CloseStreamAfterProcessing: Specifies whether or not the OutputStream should be closed after processing.

By default this is True. Setting this to False keeps the stream open for further use.

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

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

This setting only works on these classes: AS3Receiver, AS3Sender, Atom, Client(3DS), FTP, FTPServer, IMAP, OFTPClient, SSHClient, SCP, Server(3DS), Sexec, SFTP, SFTPServer, SSHServer, TCPClient, TCPServer.

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 FIPS, while all the 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/. Only the "Provider" library is needed. The jar file should then be installed in a JRE search path.

In the application where the component will be used the following classes must be imported:

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:

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

When UseFIPSCompliantAPI is true, SSL enabled classes can optionally be configured to use the 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 BCFIPS provider in order 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/. The jar file should then be installed in a JRE search path.

In the application where the component will be used the following classes must be imported:

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 must also be configured to operate in FIPS mode:

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

Note: Enabling FIPS-compliance requires a special license; please contact 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.

Trappable Errors (Cargowriter Class)

CargoWriter Errors


	304 Could not write to file.
	1000 Invalid schema file.
	1001 No schema found.
	1002 Schema format error.
	1003 Line or message was too long.
	1004 Failed to parse the message version.
	1005 Element is not in the schema file or is not a simple element.
	1006 Could not find the element.