test

Java Dynamic Management Kit 4.2 Tutorial

Preface

The Java Dynamic ManagementTM Kit provides a set of JavaTM classes and tools for developing management solutions. This product conforms to the Java Management extensions (JMXTM) v1.0 Final Release, which define resource instrumentation, dynamic agents and remote management applications. The JMX architecture is applicable to network management, remote system maintenance, application provisioning, and the new management needs of the service-based network.

Once you are familiar with management concepts, the Java Dynamic Management Kit 4.2 Tutorial is intended to demonstrate each of the management levels and how they interact. The lessons of this tutorial will show you:

Taken as a whole, these topics will demonstrate the complete development process for implementing a management solution in the Java programming language.

This book ends with a lesson devoted to the details of programming SNMP managers and agents (peers) using the Java Dynamic Management Kit.

Who Should Use This Book

This tutorial is aimed at developers who would like to learn how to instrument new or existing resources for management, write dynamic agents, or write management applications. Familiarity with Java programming is assumed. Some tutorials also rely on system and network management concepts: knowledge of these is helpful though not required.

This book is not intended to be an exhaustive reference. Management concepts and product features are covered in Getting Started with the Java Dynamic Management Kit 4.2, and the complete JavadocTM API definitions are provided in the product's online documentation package.

Before You Read This Book

In order to build and run the sample programs in this tutorial or use the tool commands provided in the Java Dynamic Management Kit, you must have a complete installation of the product on your machine. Please refer to the Java Dynamic Management Kit 4.2 Installation Guide and Release Notes document for instructions on how to install the product components and configure your environment.

Before programming with the Java Dynamic Management Kit, you should be familiar with the concepts and tools used throughout these tutorials. The following books are part of the product documentation set:

These books are available online after you have installed the documentation package of the Java Dynamic Management Kit. The online documentation also includes the Javadoc API for the Java packages and classes, including those of the Java Management extensions. Using any web browser, open the homepage corresponding to your platform:

Operating Environment 

Homepage Location 

Solaris 

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

Windows NT 

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

In these file names, installDir refers to the base directory of your Java Dynamic Management Kit installation. In a default installation procedure, installDir is:

The JDKversion is that of the Java Development Kit (JDKTM) which you use and which you selected during installation. Its value can be either 1.1 or 1.2 when used in a directory, filename, or path.

These conventions are used throughout this book whenever referring to files or directories which are part of the installation.

Directories and Classpath

These tutorials are based on the example programs shipped with the Java Dynamic Management Kit. Each example is a set of Java source code files in a separate subdirectory. The following table gives the location of the main examples directory:

Operating Environment 

Examples Directory 

Solaris 

installDir/SUNWjdmk/jdmk4.2/JDKversion/examples

Windows NT 

installDir\SUNWjdmk\jdmk4.2\JDKversion\examples

Except where noted, the source code in this book is taken from these example programs. However, code fragments may be rearranged and comments may be changed. Program listings in the tutorials usually simplify comments and remove output statements for space considerations.

On the Solaris platform, you must have root access in order to write in the installed examples directory. For this reason, it may be necessary to copy all examples to a different location before compiling them. Throughout the rest of this book, we will use the term examplesDir to refer to the main examples directory in a location where you can compile and run them.

When either compiling or running the example programs, the jar file for the Java Dynamic Management Kit runtime libraries must be in your classpath:

JDK Version 

Classpath for Compiling or Running the Examples on Solaris 

1.1 

.:installDir/SUNWjdmk/jdmk4.2/1.1/lib/jdmkrt.jar:installDir/SUNWjdmk/jdmk4.2/1.1/lib/collections.jar

1.2 

.:installDir/SUNWjdmk/jdmk4.2/1.2/lib/jdmkrt.jar

The classpathes on the Windows NT platform are identical to these, with the forward slashes (/) replaced with back-slashes (\), and the colons (:) replaced with semi-colons (;).

These classpathes assumes that you are in the subdirectory of a particular example when compiling or running it. You specify the classpath on the command line of the javac and java tools with the -classpath option. The JDK version must match the version of the javac or java command that you are using.

Throughout the rest of this book, we will use the term classpath in command line examples to indicate that you must use the classpath indicated above. You may also define this classpath in an environment variable according to your platform and omit its definition on the command line.

In order to use the proxygen and mibgen tools provided with the Java Dynamic Management Kit, you should add the installation's binaries directory your environment's path. The following table give the location of this directory:

Operating Environment 

Binaries Directory 

Solaris 

installDir/SUNWjdmk/jdmk4.2/JDKversion/bin

Windows NT 

installDir\SUNWjdmk\jdmk4.2\JDKversion\bin

How This Book Is Organized

This book is organized like a trail of the The Java Tutorial. Each major part is a lesson covering a subject and each chapter covers a topic within that subject.

Part I, "Instrumentation through MBeans" shows various ways of making a resource manageable. Topics:

Part II, "Agent Applications" demonstrates the functionality of the MBean server at the heart of an agent. Topics:

Part III, "Remote Management Applications" covers how the Java Dynamic Management Kit simplifies how a distant manager may access the resources in an agent. Topics:

Part IV, "Agent Services" demonstrates the various kinds of management intelligence which can be dynamically added to an agent. Topics:

Part VI, "SNMP Interoperability" shows how Java agents can also implement an SNMP agent and how to write a manager with the SNMP manager API. Topics:

Related Books

The Java Dynamic Management Kit relies on the management architecture of the Java Management extensions. The specification document, Java Management Extensions Instrumentation and Agent Specification, v1.0 (Final Release, July 2000) is provided in the product documentation package under the filename jmx_instr_agent.pdf.

The structure of this book was inspired by that of the The Java Tutorial:

Some topics in the lesson on SNMP refer to RFC "standards" for further information. The complete text of RFC papers can be found on the following site:

http://sunsite.auc.dk/RFC/

Disclaimer - This site is in no way affiliated with Sun Microsystems, Inc. and Sun makes no claim as to the accuracy or relevance of the data it contains.

Ordering Sun Documents

Fatbrain.com, an Internet professional bookstore, stocks selected 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.comSM 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 languageInstantiate the MyBean class.

AaBbCc123

 The names of commands, files, and directories; on-screen computer output

Edit your .login file.

Use ls -ato list all files.

machine_name% you have mail

AaBbCc123

 What you type, contrasted with on-screen computer outputmachine_name% suPassword:

AaBbCc123

 A placeholder: replace with the appropriate name or intended 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 
 Bourne shell and Korn shell prompt$
 Bourne shell and Korn shell superuser prompt#
 Windows NT system promptC:\>

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