About the Java client examples

The Oracle Endeca Server includes a collection of Java client examples for sending queries to a data domain. Consider using these examples as one possible way to build your own front-end client code.

The examples are based on Java stubs generated with JRF 11.1.1.6.

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.

Important: The Java client examples are not intended to be extensible to real tasks and are not intended to be run in a secure production environment. Use them 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 for the Bulk Load Interface. The automatically-generated documentation for these interfaces, collectively known as the Oracle Endeca Server API References, 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 them.

The Java client examples are installed in the $ENDECA_HOME/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 JRF.
`src`	Contains sample code for accomplishing basic tasks using these stubs, such as configuring a data domain, 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, and a Perl script for running the tests.

Running the examples

All example tests run against a WebLogic instance that has its unencrypted port (7001) open, and that is not configured securely (will not use HTTPS internally).

The Perl script for running the example tests is located in the /apis/examples/standalone_tests directory. Before running the script:

Verify that the Endeca Server is running.
Download and install Perl, Java, and TestNG packages on your machine, and ensure that your PATH environment variable includes the full paths to Perl and Java packages. The script depends on these packages and logs errors if any of them are not found.
Verify that the script can locate the security configuration file jpsconfig.xml. The script checks for this file in MW_HOME. Alternatively, you can define the file's location by setting the path to it in the environment variable oracle.security.jps.config.

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 example test to run and the full path to the TestNG JAR file. The script runs as many tests as you specify on the command line.