A Understanding the Oracle Coherence Directory Structure

This appendix describes the directory structure that is created on your system at the end of your standalone Oracle Coherence installation.

Table A-1 describes the directories that are installed in COHERENCE_HOME.

Table A-1 Directory Description for Oracle Coherence

Directory or File Description

bin

This directory includes a set of common scripts for performing different tasks, such as: starting a cache server, starting development tools, and performing network tests. The scripts are provided in both Windows (.cmd) and UNIX-based (.sh) formats.

doc

This directory contains the Coherence Java API Reference and a link to the Coherence documentation on the Oracle Technology Network (OTN). The Coherence Java API Reference is distributed as a JAR file and must be extracted. The JAR can also be imported into an IDE for easy access during development.

To extract the Coherence Java API Reference, execute the following command from the /api directory (assuming that JAVA_HOME/bin is located on the computer's PATH):

jar -xvf CoherenceJavaDoc.jar

examples

This directory contains a set of examples that demonstrate many Coherence features and how to use the Coherence API. For detailed instructions on building and running the examples, see Running the Coherence Examples.

lib

lib – This directory includes all delivered libraries. The coherence.jar library is the main development and run-time library and is discussed in detail throughout the Coherence documentation.

plugins

This directory contains plug-ins for common integrations. Coherence provides a plug-in for Maven and Java VisualVM. The Maven plug-ins are used to integrate Coherence as part of a Maven build process. For details about the Coherence Maven plugins, see "Integration with Maven". The Java VisualVM plug-in used to provide Coherence monitoring. For details about the Java VisualVM plug-in, see Managing Oracle Coherence.