12.2. Kodo Management Console

12.2.1. Remote Connection
12.2.1.1. Connecting to Kodo under WebLogic 8.1
12.2.1.2. Connecting to Kodo under JBoss 3.2
12.2.1.3. Connecting to Kodo under JBoss 4
12.2.2. Using the Kodo Management Console
12.2.2.1. JMX Explorer
12.2.2.1.1. Executing Operations
12.2.2.1.2. Listening to Notifications
12.2.2.2. MBean Panel
12.2.2.2.1. Notifications / Statistics
12.2.2.2.2. Setting Attributes

The Kodo Management Console is used for local and remote management of MBeans. It can be used to connect to a local MBean server or multiple remote MBean servers. To connect to a local server, see Section 12.1, “Configuration”.

12.2.1. Remote Connection

To start the Kodo Management Console for remote management, run the remotejmxtool command. The remotejmxtool accepts the following arguments:

  • -connect/-c: Whether to attempt an initial connection to the remote JMX adaptor. Defaults to false.

  • -type/-t: The type of the remote JMX adaptor. Current supported types are mx4j1, jmx2, weblogic81 and jboss. Defaults to mx4j1. Integration with other JMX server implementations that support remote connectivity can be accomplished by creating a class that implements the RemoteMBeanServerFactory interface. In this case, the type should be the fully qualified name of the implementing class.

  • -host/-h: Hostname of the JNDI service provider where the remote JMX adaptor is registered. Defaults to localhost. When attempting an initial connection to WebLogic, this must be set to a hostname of the form username:password@hostname. This is optional for JSR 160 connectors, as it may not be necessary for some connectors, and may be encoded in the JMX service URL for others.

  • -port/-p: Port of the JNDI service provider where the remote JMX adaptor is registered. Defaults to 1099 when connecting to MX4J. Defaults to 7001 when connecting to WebLogic. This is optional for JSR 160 connectors, as it may not be necessary for some connectors, and may be encoded in the JMX service URL for others.

  • -name/-n: For non-JSR 160 connectors, the JNDI name of the remote JMX adaptor. Defaults to a special value default which yields the default JNDI name appropriate for the chosen remote JMX adaptor type. For MX4J, the default is jrmp, and for JBoss, the default is the first available JMX adaptor at the specified JNDI service provider. For WebLogic, this parameter is ignored. For JSR 160 connectors, this is the JMX service URL, and defaults to service:jmx:rmi://localhost/jndi/jmxservice. Note that this can also encode the host and port parameters, if desired. For example, the default JMX Connector Server could be referenced by service:jmx:rmi://localhost/jndi/rmi://localhost:1099/jmxservice. In that case, the Host and Port parameters will be ignored.

For example, to automatically connect to the MX4J remote JMX adaptor on host myhost.mydomain.com, use the following command:

remotejmxtool -c true -host myhost.mydomain.com

Once remotejmxtool is up, you can connect to multiple remote JMX adaptors.

To connect to Kodo with MX4J v. 1.1.x, select Connect to Kodo JMX... from the File menu.

To connect to Kodo with a JSR 160 connector, select Connect to Kodo JMX 1.2... from the File menu.

To connect to Kodo running under WebLogic, select Connect to Kodo via WebLogic JMX... from the File menu.

To connect to Kodo running under JBoss, select Connect to Kodo via JBossMX... from the File menu.

12.2.1.1. Connecting to Kodo under WebLogic 8.1

In order to connect to WebLogic 8.1 with remotejmxtool, the following requirements must be met:

  • remotejmxtool must be run with the weblogic.jar (found in the weblogic81/server/lib/ directory of the WebLogic 8.1 distribution) in your CLASSPATH. Note that this library should appear before the mx4j-jmx.jar (included with the Kodo distribution) library in your CLASSPATH.

  • The remotejmxtool must be run with JDK 1.4.x.

  • The jar kodo-wl81manage.jar must be put in the WebLogic system CLASSPATH. You can accomplish this by editing startWebLogic.sh/startWebLogic.cmd.

12.2.1.2. Connecting to Kodo under JBoss 3.2

In order to connect to JBossMX 3.2, remotejmxtool must be run with the following libraries from the JBoss distribution in your CLASSPATH.

  • jboss-common-client.jar: Found in the client/ directory of the JBoss 3.2 distribution.

  • jboss-jmx.jar: Found in the lib/ directory of the JBoss 3.2 distribution.

  • jmx-adaptor-plugin.jar: Found in the server/all/lib/ directory of the JBoss 3.2 distribution.

  • jnp-client.jar: Found in the client/ directory of the JBoss 3.2 distribution.

  • jboss-system.jar: Found in the lib/ directory of the JBoss 3.2 distribution.

  • jnet.jar: Found in the client/ directory of the JBoss 3.2 distribution. Alternately, remotejmxtool can be run under JDK 1.4 or higher.

  • concurrent.jar: Found in the client/ directory of the JBoss 3.2 distribution.

  • jbossall-client.jar: Found in the client/ directory of the JBoss 3.2 distribution.

Note that these libraries should appear before the mx4j-jmx.jar (included with the Kodo distribution) library in your CLASSPATH.

12.2.1.3. Connecting to Kodo under JBoss 4

In order to connect to JBossMX 4, remotejmxtool must be run with the following libraries from the JBoss distribution in your CLASSPATH.

  • jboss-common-client.jar: Found in the client/ directory of the JBoss 4 distribution.

  • jboss-jmx.jar: Found in the lib/ directory of the JBoss 4 distribution.

  • jmx-adaptor-plugin.jar: Found in the server/all/lib/ directory of the JBoss 4 distribution.

  • jnp-client.jar: Found in the client/ directory of the JBoss 4 distribution.

  • jboss-system.jar: Found in the lib/ directory of the JBoss 4 distribution.

  • concurrent.jar: Found in the client/ directory of the JBoss 4 distribution.

  • jbossall-client.jar: Found in the client/ directory of the JBoss 4 distribution.

  • dom4j.jar: Found in the lib/ directory of the JBoss 4 distribution.

Note that these libraries should appear before the mx4j-jmx.jar (included with the Kodo distribution) library in your CLASSPATH.

Additionally, the following requirements must be met:

  • The remotejmxtool must be run with JDK 1.5.x.

  • The jar kodo-jboss4manage.jar must be put in the JBoss 4 system CLASSPATH. You can accomplish this by placing the jar in the server's lib/ directory (e.g. >JBoss 4 install</server/default/lib/).

12.2.2. Using the Kodo Management Console

The above diagram shows the Kodo Management Console window. The Kodo Management Console window is divided into two main parts, the JMX Explorer on the left, and the MBean Panel on the right.

12.2.2.1. JMX Explorer

The JMX Explorer provides a tree view of the connected MBean servers. Under each MBean server are the JMX domains handled by that server. Under each domain are the MBeans within that domain. Under each MBean are the attributes, operations and notifications provided by that MBean.

12.2.2.1.1. Executing Operations

In order to execute an operation of an MBean, right click on the operation, and select "Execute..." from the context menu. A dialog box will come up asking for values for each of the arguments to the managed operation. Fill in each of the values and hit the OK button to execute the operation.

[Note]Note

Currently, only primitive types, primitive wrapper types, and classes with a string constructor can be entered.

If the operation returns a non-null value, the string representation of the return value is shown.

12.2.2.1.2. Listening to Notifications

When an MBean is selected in the JMX Explorer, the Kodo Management Console automatically listens to all notifications. To stop listening to all notifications for a given MBean, right click on the Notifications node and select Stop Listening All. To stop listening to a single notification, right click on the individual notification and select Stop Listening. In order to listen to all notifications provided by an MBean, right click on the Notifications node under the MBean and select Listen All. To listen to a single notification, right click on the individual notification and select Listen.

You can see the available notifications in the MBean Panel to the right of the JMX Explorer.

12.2.2.2. MBean Panel

You can view the attributes, operations and notifications of an MBean in the MBean Panel. The top half of the panel shows notifications and statistics, while the bottom half allows for viewing / editing attributes, viewing available operations, and viewing available notifications.

12.2.2.2.1. Notifications / Statistics

The top half of the MBean Panel shows the notifications emitted by the selected MBean. Note that you must listen to a notification (see Section 12.2.2.1.2, “Listening to Notifications”) in order to view it in the MBean Panel. There is one tab per notification. Certain notifications represent statistics. These notifications are grouped under tabs based on their ordinate description. Statistic notifications are represented in charts. Dragging a rectangle across a chart causes the chart to zoom in on the selected area. Right clicking on a chart brings up a context menu with a number of options:

  • Properties...: Edit chart properties, such as colors and labels.

  • Save as...: Save the chart to disk.

  • Print...: Print the chart.

  • Zoom In / Zoom Out: Zoom in and out on either or both axes.

  • Auto Range: Set the either or both the abscissa and ordinate range to see all of the values.

12.2.2.2.2. Setting Attributes

The Attributes tab in the bottom half of the MBean Panel allows for viewing / editing of attributes. Not all attributes are editable. Selecting an editable attribute allows you to set the value.

[Note]Note

Currently, you can only enter primitive types, primitive wrapper types, and classes with a string constructor.

 

Skip navigation bar   Back to Top