JavaApiGenerator.jar

The JavaApiGenerator.jar program generates the Java classes that can be used by Java applications to communicate with MATRIXX Engine.

For information about installing the JavaApiGenerator.jar program, see the discussion about using the MATRIXX Java API in MATRIXX Subscriber Management API.

Name

JavaApiGenerator.jar

Syntax

java -jar JavaApiGenerator.jar -rev:revision -address:ipaddress -port:port -output:directory -rest

Options

-help
Prints help information for this JAR program.
-address:ipaddress
If you are routing data through the Gateway Proxy or MDC Gateway, this option specifies the IP address of the respective host. If you are connecting directly to a running MATRIXX Engine, the option specifies the IP address of the MATRIXX publishing server.
-port:port
The port to connect to on the Gateway Proxy or MDC Gateway host.
-output:directory
The full path of the directory on the RS Gateway host for the generated files.
-rev:revno
The software version. The latest version and default value is 4300. If you use code for the Java API bindings before the 4300 release, specify -rev:4200. Otherwise, omit this parameter.
-config:file.xml
Load the container definitions from file.xml (specify the full path to file).
-rest
Generates the REST controller for the RS Gateway. This parameter is used internally by MATRIXX and must not be called by any Java programs.
-no-rest-check
If this option is set, REST validation does not stop the build. The report is still displayed.
-json:prefix
Generate the JSON controller with prefix as the prefix of the URL.
-dir:n
Load the XML files in directory n as schema extensions.
-clear
Remove all XSD patterns.
-xsd:regex
The regex used to compare with container names to determine if an XSD file is generated for the container, for example: -xsd:"^MtxSubscriber.*$"

Generate Java Classes

To generate custom MATRIXX Data Container (MDC) XSD files, add the -xsd option as shown here:

java -jar JavaApiGenerator.jar -xsd:.* -address:192.168.11.10 -port:4080 -output:/var/mtx/