The Java DMK product includes both printable and online documentation, as well as an exhaustive set of programming examples.
You can view HTML documentation after installation of the product. On the machine where you installed the product, open one of the following URLs in any browser:
In the Solaris operating environment: file:/opt/SUNWjdmk/jdmk5.0/index.html |
On the Windows 2000 operating environment: file:/Program Files/SUNWjdmk/jdmk5.0/index.html |
The page contains links to all the product documentation supplied online with the Java DMK, including:
Getting Started with the Java Dynamic Management Kit 5.0
Java Dynamic Management Kit 5.0 Tools Reference
Java Dynamic Management Kit 5.0 Tutorial
Java Dynamic Management Kit 5.0 Installation Guide
The Java Management Extensions 1.1 specification document.
Complete PDF versions of the books listed in the preceding section are supplied on the CD-ROM of the software. These files are located in the docs directory at the common root of the CD-ROM.
The documents are formatted for U.S. Letter paper size (8.5 × 11 inches), but the can be loaded by any appropriate document viewer or printed directly to any printer, regardless of the default paper size. The text area on each page fits on all standard paper sizes.
Sample applications that demonstrate most of the functionality of the Java DMK are provided in the examples package of the product. If you installed this package, the Java source files and README text files for these applications are located in subdirectories at:
installDir/SUNWjdmk/jdmk5.0/examples |
In the Solaris operating environment, you need to be root user to write to this directory. To compile the example programs, users should copy the examples hierarchy to a more accessible location.
The README file for each example gives a brief explanation of the source files and the instructions for running its application. Further explanation for most examples is available in the Java Dynamic Management Kit 5.0 Tutorial.
The examples directory also contains the JdmkProxyMBeans subdirectory, which provides proxy MBeans for all of the Java DMK components that support them. These are generated by the proxygen tool and must be compiled in the normal way before use. You can use them to provide proxy objects in your manager applications for the agent-side service MBeans.
The Javadoc utility provides the full description of all classes, interfaces, and methods in the Java DMK APIs.
The Java DMK Javadoc is found in the following location after installation:
installDir/SUNWjdmk/jdmk5.0/docs/locale/C/api/index.html