This document describes the few steps that are required to setup and configure your system to run XQuark Fusion. XQuark Fusion is a software component that can be used in two modes:
Each mode requires specific configuration steps, which are described below.
XQuark Fusion runs on the following platform:
The distribution is provided as a simple archive (.zip or .tgz depending on the target platform) to be extracted in any directory of your choice.
The configuration of the command-line tool requires two steps:
The xqfusion
script (which is found in the
bin/
directory of the distribution) uses several
environment
variables:
JAVA_HOME
: this variable must be set to
the directory where the JRE 1.3.1 or 1.4.x can be found. If not set,
the script will run the first java executable found on the execution
path.XQ_CLASSPATH
: this variable defines the
additional classpath which is appended to the standard one
and to the XQuark Fusion distribution jars before running the software.
It is used to load the JDBC driver classes and
JAXP-compliant parsers that are not part of the delivery.
Alternatively, the classpath can be controlled by setting
the standard CLASSPATH
environment variable to the appropriate value.XQFUSION_HOME
:
this variable must be set to the directory where XQuark Bridge was
installed.
XQuark Fusion must be configured in order to run properly. This is done
through one or more configuration files. An example of these files can be found
in the use-cases
directory where the basic configuration file main.xml
shows relevant parameters as well the configuration of the SQL wrappers
WSQL1.cfg
, WSQL2.cfg
and WSQL3.cfg
.
The command-line tool can be executed by invoking the following commands:
xqfusion -q <query file>
The command:
xqfusion -help
prints a message on the standard output detailing command-line options. Options are also described in the user guide.
Integrating XQuark Fusion in an application or in an application server environment requires to properly set up the compilation and run-time classpaths.
The list of JAR files present in the distribution is given in the table below, relatively to installation directory:
JAR name | Content |
lib/xquark-fusion.jar |
Main JAR in the distribution. Must be present in both compilation and run-time classpaths. This file contains internal links to other JAR files in the distribution (except crimson.jar and JDBC drivers, see below), so that those files don't need to be explicitly included in the run-time classpath, as long as their relative paths do not change. |
lib/xquark-schema.jar |
Runtime JAR containing XQuark XML schema implementation. |
lib/xquark-xdbc.jar |
Runtime JAR containing the XQuark XML/DBC API (interface definitions only). |
lib/xquark-xpath.jar |
Runtime JAR containing XQuark XPath implementation. |
lib/xquark-xquery.jar |
Runtime JAR containing XQuark XQuery front-end. |
lib/xquark-jdbcutils.jar |
Runtime JAR containing tools providing an abstraction layer over JDBC. |
lib/xquark-extractor.jar |
Runtime JAR containing the XQuery back-end for relational database access. |
lib/xml-apis.jar |
Support JAR, containing the JAXP, DOM2 and SAX2 interfaces. It is only used at compilation time. |
lib/crimson.jar |
Support JAR, containing the JAXP, DOM2 and SAX2 interfaces, as well as a JAXP-compliant parser implementation. This file contains all the classes needed to parse XML files and build DOM2 in-memory representations. Either this file or another JAR file providing a JAXP implementation (e.g. Xerces) must be present in the runtime classpath. |
lib/mysql-connector-java-3.0.9-stable-bin.jar |
Support JAR, containing the
redistributable JDBC driver for MySQL. |
lib/xpp3-1.1.3.4-RC3.jar |
Support JAR, containing the
XPP pull parser, used to access XML documents from Fusion. |
All JAR files in the distribution must be present in the classpath
at compilation
time, except lib/crimson.jar
, lib/mysql-connector-java-3.0.9-stable-bin.jar
and lib/xpp3-1.1.3.4-RC3.jar
.
When integrating XQuark Fusion in an application, it is only necessary to add:
lib/xquark-fusion.jar
,lib/crimson.jar
(or an alternate JAXP
implementation),