test

Java Dynamic Management Kit 5.0 Tools Reference

Chapter 1 Proxy MBean Compiler (proxygen)

You can use the proxygen compiler supplied with the Java Dynamic Management Kit (DMK) to generate a proxy MBean from its corresponding MBean. A proxy MBean is an image of an agent-side MBean and exists on the manager side. The proxygen compiler allows you to customize your proxy MBeans depending on how you want to use them in your management application. For more information regarding the relationship between MBeans and proxy MBeans, refer to Getting Started with the Java Dynamic Management Kit 5.0, which is part of the documentation set.

The proxygen compiler takes the compiled Java class of an MBean and generates the Java interface and Java proxies. The Java proxies consist of Java source code that implements the interface. To develop a Java manager with code generated by proxygen, you call the methods of the proxy MBean's interface.

Options of the proxygen compiler enable you to modify the characteristics of the proxies you generate from an MBean. For example, with some options, you can generate read-only or read-write proxies. By generating from the same MBean a set of proxies with different characteristics, you can develop a Java manager whose behavior is modified at runtime, depending on which proxies are loaded. For example, when the read-only proxies are loaded, the Java manager cannot modify properties in the MBean.

A proxy MBean consists of two components:

For example, if you have an MBean MyClass, the proxygen compiler gives you a proxy MBean that consists of the following files:

The proxygen compiler generates Java source code, not compiled Java classes. For your proxy MBeans to be accessible to a Java manager, you must compile the files that proxygen generates, and make sure that the compiled Java classes are stored at the location specified by the CLASSPATH environment variable of the manager, or are accessible through the class loader of the manager.

Note –

Classes marked “deprecated” in the Java DMK 4.2 have been removed from version 5.0.

Starting the proxygen Compiler

To start proxygen, type the command for your operating environment:

Alternatively, invoke the java com.sun.jdmk.tools.ProxyGen class by first invoking java com.sun.jdmk.tools.ProxyGen <options> <classes>. Provide the class name without the .class extension.

proxygen Compiler Options

The proxygen command takes options, as follows:


proxygenoptions classes

The options include:

-d dir

Specifies a destination directory for the generated code.

-ro

Generates read-only proxy MBeans. Calling setter methods of these read-only proxies raises a com.sun.jdmk.RuntimeProxyException.

-tp pkgName

Generates code in the target package specified by pkgName.

-classpath path

Specifies a class path to use for locating the class to compile. By default, the system class path is used.

-help

Prints a message that briefly describes each proxygen option.

proxygen Compiler Example

The following example shows how to generate the managed object for the Simple class and SimpleMBean interface, which is provided as an example with the Java DMK. You must first call the Java compiler on the source code to obtain its .class file before using the proxygen compiler to generate the managed object. Finally, you must compile the Java code generated by the proxygen compiler.

The source code for the Simple class is contained in the installDir/SUNWjdmk/jdmk5.0/examples/MonitorMBean directory, where installDir is the directory under which the Java DMK was installed.

Note –

On the Solaris platform, the installDir file hierarchy is not writable by default. In this case you must copy the Simple.java and SimpleMBean.java files to a directory where you have write permissions.

To Generate the Managed Object for the Simple Class

  1. Set your CLASSPATH as follows:

    • In the Solaris operating environment:


      prompt% installDir/SUNWjdmk/jdmk5.0/lib/jdmkrt.jar and jdmktk.jar

    • In a Windows 2000 operating environment:


      installDir\SUNWjdmk\jdmk5.0\1.2\lib\jdmkrt.jar and jdmktk.jar

  2. Type the following commands:


    prompt% javac Simple.java SimpleMBean.java
prompt% /.../bin/proxygen/proxygen -classpath . Simple
Destination directory set to ./.
 
Starting compilation of Simple.
 
Starting to generate stub SimpleProxy.java for class Simple
Starting to generate MBean interface SimpleProxyMBean.java for class Simple
    Note –

    Proxy MBeans generated using proxygen in Java DMK 4.2 must be regenerated to run in Java DMK 5.0, because some of the methods used in version 4.2 have been deprecated.

Output of the proxygen Compiler

For an MBean defined in the Java class BeanName, the proxygen compiler generates:

For example, when an MBean representing a Java class named Simple is compiled, the proxygen compiler generates the source code of:

Mapping Rules

The proxygen compiler uses the Java Reflection API for analyzing an MBean and generating its associated proxy MBean. It parses an MBean using the JMX-specific design patterns. The mapping rules that proxygen uses for generating the proxy MBean are described in the following subsections.

Attributes

The proxygen compiler generates code only for exposed operations of the MBean itself. Each attribute of the MBean is present in the proxy MBean with the same accessor getter and setter methods. Therefore, if an attribute is read-only in the MBean, the property is read-only in the generated proxy MBean.

Operations

In addition to the attribute accessors, the proxygen compiler generates code only for exposed operations of the MBean itself.

Methods in the Proxy Interface

The proxy MBeans that the proxygen compiler generates also contain methods that are not present in the MBean. Rather, they are defined in the Java interface com.sun.jdmk.Proxy. The proxy MBean that is generated implements this interface. These methods are public methods that do not follow the design patterns defined by the JavaBeans component model.

These methods provide additional functionality for proxy MBeans and the management applications that instantiate them. Their purpose is to twofold:

Using the Generated Code

The proxygen compiler generates Java source code that you use for developing Java managers. To develop a Java manager by using code generated by the proxygen compiler, you use the RemoteMBeanServer interface. Using this interface enables you to develop Java managers without having to modify the code that the proxygen compiler generates. However, you can also modify the code that it generates if you want to define a specific view of an MBean.

The proxygen compiler generates Java source code, not compiled Java classes. For your proxy MBeans to be accessible to a Java manager, you must compile the files that the proxygen compiler generates, and make sure that the compiled Java classes are stored at a location specified in the CLASSPATH environment variable of the manager or are accessible through the class loader of the manager.

Modifying the Code Generated by the proxygen Compiler

If you want to define a specific view of an MBean, you can modify the generated code. To ensure that the modified code remains consistent with the MBean it represents, modify only the proxy and not the interface.