Java Dynamic Management Kit 4.0 Tools Reference

Preface

The Java Dynamic Management^TM Kit provides a set of Java classes and tools for developing management solutions. This product conforms to the specification of the Java Management extensions (JMX) which define a three-level architecture: resource instrumentation, dynamic agents and remote management applications. Such an architecture is applicable to network management, remote system maintenance, application maintenance and service provisioning.

The Java Dynamic Managment Kit 4.0 Tools Reference Guide presents the development tools provided with the Java Dynamic Management Kit. These tools will help you to develop management solutions to suit your requirements.

Who Should Use This Book

This book is aimed at developers wishing to use the tools provided with the Java Dynamic Management Kit.

Familiarity with Java programming and the JavaBeans component model is assumed.

This book is not intended to be an exhaustive reference: management tutorials intended to demonstrate each of the management levels and how they interact are covered in Java Dynamic Management Kit 4.0 Tutorials, and the complete Javadoc API definitions are provided in the product documentation package.

This book covers proxygen for generating manager-side proxy objects, mibgen for generating MBeans from SNMP MIBs, the tracing and debugging mechanism and the output of the HTML protocol adaptor.

Before You Read This Book

In order to use the tool commands described in this book, you must have a complete installation of the Java Dynamic Management Kit on your machine. Refer to the Java Dynamic Management Kit 4.0 Installation Guide and Release Notes document for instructions on how to install the product components and configure your environment. Management concepts and product features are covered in Getting Started with the Java Dynamic Management Kit 4.0 and the Java Dynamic Management Kit 4.0 Tutorial. The complete Javadoc API definitions are provided in the product documentation package.

These books are available on-line after you have installed the documentation package of the Java Dynamic Management Kit. The on-line documentation also includes the Javadoc API for the Java packages and classes. Using any web browser, open the home-page corresponding to your platform:

Operating Environment

Home-Page Location

Solaris

installDir/SUNWjdmk/jdmk4.0/JDKversion/index.html

Windows NT

installDir\SUNWjdmk\jdmk4.0\JDKversion\index.html

In these file names, installDir refers to the base directory of your Java Dynamic Management Kit installation. The JDKversion is that of the Java Development Kit which you use and which you selected during installation; it can be either 1.1 or 1.2. This convention is used throughout this book whenever referring to files or directories which are part of the installation. In a default installation procedure, installDir is:

/opt on the Solaris platform
C:\Program Files on the Windows NT platform

How This Book Is Organized

This book explains the development tools provided with the Java Dynamic Management Kit and explains how to use them. It is divided into the following sections:

"Proxy MBean Compiler (proxygen)"
"SNMP MIB compiler (mibgen)"
"HTML Adaptor"
"Tracing Mechanism"

Related Books

The Java Dynamic Management Kit is based upon the management architecture of the Java Management Extensions (JMX). The three specifications documents are provided in the product documentation package:

"Java Management Extensions Instrumentation and Agent Specification" (jmx_instr_agent.pdf)
"Java Management Extensions SNMP Manager API" (jmx_snmp_api.pdf)

Ordering Sun Documents

Fatbrain.com, an Internet professional bookstore, stocks select product documentation from Sun Microsystems, Inc.

For a list of documents and how to order them, visit the Sun Documentation Center on Fatbrain.com at http://www1.fatbrain.com/documentation/sun.

Accessing Sun Documentation Online

The docs.sun.com^SM Web site enables you to access Sun technical documentation online. You can browse the docs.sun.com archive or search for a specific book title or subject. The URL is http://www.oracle.com/technetwork/indexes/documentation/index.html.

Typographic Conventions

The following table describes the typographic changes used in this book.

Table P-1 Typographic Conventions


Typeface or Symbol	Meaning	Example
AaBbCc123	Book titles, new words or terms, or words to be emphasized	Read Chapter 6 in User's Guide. These are called class options. You must be root to do this.
`AaBbCc123`	Class or object names, methods, parameters or any other element of the Java programming language	Instantiate the `MyBean` class.
`AaBbCc123`	The names of commands, files, and directories; on-screen computer output	Edit your `.login` file. Use `ls -a` to list all files. `machine_name% you have mail.`
`AaBbCc123`	What you type, contrasted with on-screen computer output	`machine_name%` `su` `Password:`
`AaBbCc123`	Command-line placeholder: replace with a real name or value	To delete a file, type `rm` `filename`.

Shell Prompts

The following table shows the default system prompts for the different platforms and shells.

Table P-2 Shell Prompts


Shell	Prompt
C shell prompt	`machine_name%`
C shell superuser prompt	`machine_name#`
Bourne shell and Korn shell prompt	`$`
Bourne shell and Korn shell superuser prompt	`#`
Windows NT system prompt	`C:\`

Unless otherwise noted, the command examples in this book use the Korn shell.