JavaAPIOverview

The XAware Java API provides the ability for an application to interface directly to the XAware BizView processing, through Java calls. The XAware API provides the following features:

• the initialization of the Engine and ability to execute multiple BizView files
• the ability to manage user authentication and credentials
• the ability to pass input data (XML) and input parameters to the BizView processing
• the ability to use input and output streams for XML input and results
• the ability to process the XML results in different formats

The API is provided in two basic “flavors”. The High Level Interface allows the caller to invoke a single method, and pass in defined options as method parameters. The High Level Interface is implemented as a static method, loadAndExecute(), with a number of overloaded versions for various parameter options.

The Detailed Level Interface provides a flexible "options" structure which can be set with any available BizView option. The Detailed Interface provides a non-static method, executeBizView(), which takes the options structure as input. (An overloaded version is provided which allows you to record statistics.)

For each interface approach, a number of output options are available. The program can receive a “general” response which includes a flag indicating execution status and allows querying the result as a String, JDOM Document, or W3C Document. The program can also receive the result directly as a String, JDOM Document or W3C Document.

Complete details of the XAware API can be found in the javadoc directory, under the XAware installation at <xawarehome>/javadoc/api/index.htm (see org.xaware.api; XABizView is the main class).