About the Java client examples

The Oracle Endeca Server includes a collection of Java client examples for sending queries to the Oracle Endeca Server. Treat these examples as one of the possible ways to build your own front-end client code.

The examples are based on Java stubs generated with CXF version 2.4.2, however, you can use any other utility for stub generation.

Even though these examples represent Java classes and methods, they do not represent the supported interfaces. The Web services and the Bulk Load Interface represent the supported interfaces to the Oracle Endeca Server. The Java client examples are not intended to be extensible to real tasks. Use the Java client examples as demonstrations of how to interact with the generated code and how to create your own client code in Java for sending queries to the Oracle Endeca Server.

Do not use the Java client examples as your reference for the supported interfaces. To learn about the capabilities of each of the supported interfaces, use the Web services themselves, their corresponding WSDL documents and the documentation generated from them, and the Bulk Load Interface. The automatically-generated documentation for these interfaces, collectively known as the Oracle Endeca Server API Reference, is included in the installation of the Oracle Endeca Server. In addition, the Oracle Endeca Server documentation provides information about the interface capabilities and describes how to use the Web service interfaces.

The Java client examples are installed in the /apis/examples directory of the Oracle Endeca Server package, and include the following top-level directories:
Directory Description
generated-sources Contains the result of generating stubs using a version of CXF wsdl2java.
src Contains sample code for accomplishing basic tasks using these stubs, such as configuring a data store, adding individual records, and making basic queries.

In addition, the src/tests directory contains unit tests employing the simple routines in src/main, as well as wrappers around those unit tests.

standalone_tests Includes a JAR file containing compiled versions of unit test wrappers, supporting JAR files, and a Perl script for starting the Oracle Endeca Server and running the tests.

Before running the Perl script, ensure that you have Perl and the Java JDK packages installed on your machine and that your PATH environment variable includes the path to the bin directories of both of these packages.

If you use the Perl script with no arguments, it issues a list of available options.

To run the Perl script, specify the name of the test to run.

By default, the script assumes that the script's directory is part of the installation, and it will start the Oracle Endeca Server from its sibling path. Alternatively, the script can check the environment variable ENDECA_SERVER for the location of your Oracle Endeca Server installation.