How do I work with MBeans?

How do I work with MBeans?

How do I work with MBeans?

The Pramati Server Management Information Model is JSR 77 compliant.

JMX defines management interfaces and services designed for distributed environments focused on providing functionality for managing networks, systems and applications.

The Console is built with components called Manageable Beans (MBeans). These beans can be either standard or dynamic. Dynamic MBeans conform to a specific interface and allow for wide flexibility at runtime. MBeans can generate and propagate notification events to components across multiple tiers. Service providers and developers can build standard management components into their products, and avoid investing in complex management systems.

How do I use MBean Viewer on the Console?

MBean Viewer is a utility provided in the Console that lets you view details about all the MBeans present in, and being used by, the various domains. It is an HTML adaptor for Pramati’s MBeans.

To use the MBean Viewer provided, select Utilities > MBean Viewer. This displays a list of all the MBeans registered with the domains PRAMATI and History Collector. The details for the domains JMS and MY_DOMAIN that were provided separately till Pramati Server 4.1, are now available under PRAMATI.

Clicking a domain name displays all the MBeans related to it. Click on an MBean to view the various attributes, operations, and notifications related to it. You can:

View and edit the attributes of an MBean. You can modify MBean attributes only if they are in Read or Write mode.
Perform simple MBean operations that are supported through a browser.
View notifications, if any.

How do I monitor MBean Attributes?

The MBean attributes are displayed in the Attributes tab by default when you select a bean name. The name and domain of the selected MBean, along with its attributes is displayed.

How do I monitor MBean Operations?

Selecting Operations tab displays the name and domain of the selected MBean, along with a list of all the methods being used by it.

How do I monitor MBean Notifications?

Selecting Notifications tab displays the name and domain of the selected MBean, along with a list of notifications issued against it. In case there are no notifications issued, an appropriate message is displayed.

How do I access Pramati MBean Server?

Pramati MBean Server can be accessed from within the server’s virtual machine (VM) or remotely.

To access MBean Server from within the server VM, simply look up java:comp/MBeanServer, as:

javax.naming.InitialContext ic = new javax.naming.InitialContext();
javax.management.MBeanServer mbeanServer =
 (javax.management.MBeanServer)ic.lookup("java:comp/MBeanServer");

This code can be executed from a Server startup hook or any standard J2EE component such as a servlet or an EJB.

To manage Pramati Server remotely, the MBean Server must be accessed from outside the VM, through the RMI-based client connector that is bound to the Naming service by the name rmi-client-connector. The following code illustrates this:

java.util.Properties props=new java.util.Properties();
props.put("java.naming.factory.initial",
"com.pramati.naming.client.PramatiClientContextFactory");
props.put("java.naming.provider.url", "rmi://Host-IP:NamingPort");
javax.naming.InitialContext ic = new javax.naming.InitialContext(props);
com.pramati.jmx.connector.ClientConnector cc =
 (com.pramati.jmx.connector.ClientConnector)ic.lookup("rmi-client-connector");

The Java API for com.pramati.jmx.connector.ClientConnector can be found at www.pramati.com/docstore/1205010/javadocs/index.html.

Pramati RMI Client Connector can also be obtained by a JSR 160 client. JSR 160 is an interoperable, transparent standard to access JMX implementations remotely using RMI or any other transport. Pramati’s JSR 160 implementations are provided over RMI transport.

For JSR 160 client's to access Pramati's implementation, set the system property jmx.remote.protocol.provider.pkgs to com.pramati.jmx.connector.

JMXService URL should be of format service:jmx:rmi:///jndi/rmi://<hostname _moz-userdefined="">:<naming _moz-userdefined="" port="">/std-rmi-connector</naming><hostname>

//create the jmxServiceURL
JMXServiceURL url =
 new JMXServiceURL("service:jmx:rmi:///jndi/rmi://localhost:9191/std-rmi-client-connector");

//initialize the properties to create the jmx connector
Map properties = new HashMap();
properties.put(Context.INITIAL_CONTEXT_FACTORY,
"com.pramati.naming.client.PramatiClientContextFactory");
properties.put(Context.URL_PKG_PREFIXES, "com.pramati.naming.url");

//set credentials else do operations on the mbean server as nobody
Properties pwProps = new Properties();
pwProps.put("com.pramati.naming.realm", "system");
pwProps.put(Context.SECURITY_PRINCIPAL, "root");
pwProps.put(Context.SECURITY_CREDENTIALS, "pramati");
properties.put(JMXConnector.CREDENTIALS, pwProps);

//connect
JMXConnector jmxc = JMXConnectorFactory.connect(url, properties);

// Get an MBeanServerConnection
MBeanServerConnection mbsc = jmxc.getMBeanServerConnection();

// Perform mbean operations
mbsc.getMBeanCount();

How do I use Pramati MBean APIs?

Pramati Server exposes Management APIs to facilitate Server management through custom tools and applications. These Management APIs can be viewed from the Console in the Control Objects on Catalog page.

Start navigating from com.pramati.services.j2ee.spi.admin.J2EEServerMBean or com.pramati.services.jms.spi.admin.JMSServerMBean, which can be obtained by looking up root-server-mbean or jms-servermbean either from the same VM or remotely.

The following sample code obtains a J2EEServerMBean, the management interface for managing Server, in the same VM.

javax.naming.InitialContext ic = new javax.naming.InitialContext();
com.pramati.services.j2ee.spi.admin.J2EEServerMBean
j2eeServerMBean=(com.pramati.services.j2ee.spi.admin.J2EEServerMBean)
ic.lookup("rootserver-mbean");

The following sample code obtains a J2EEServerMBean from a remote VM:

java.util.Properties props=new java.util.Properties();
props.put("java.naming.factory.initial",.
"com.pramati.naming.client.PramatiClientContextFactory");
props.put("java.naming.provider.url", "rmi://Host-IP:NamingPort");
javax.naming.InitialContext ic = new javax.naming.InitialContext(props);
com.pramati.services.j2ee.spi.admin.J2EEServerMBean
j2eeServerMBean = (com.pramati.services.j2ee.spi.admin.J2EEServerMBean)
ic.lookup("rootserver-mbean");

The following sample code obtains a JMSServerMBean, the management interface for the Pramati Message Server, in the same VM:

javax.naming.InitialContext ic = new javax.naming.InitialContext();
com.pramati.services.jms.spi.admin.JMSServerMBean
jmsServerMBean = (com.pramati.services.jms.spi.admin.JMSServerMBean)
ic.lookup("jms-server-mbean");

This sample code obtains a JMSServerMBean from a remote VM:

java.util.Properties props=new java.util.Properties();
props.put("java.naming.factory.initial",
"com.pramati.naming.client.PramatiClientContextFactory");
props.put("java.naming.provider.url", "rmi://Host-IP:NamingPort");
javax.naming.InitialContext ic = new javax.naming.InitialContext(props);
com.pramati.services.jms.spi.admin.JMSServerMBean
jmsServerMBean =(com.pramati.services.jms.spi.admin.JMSServerMBean)
ic.lookup("jms-server-mbean");

Replace Host-IP with the actual IP of the host where Server is running and NamingPort with the port that is used by the Naming Service running on the host. For example, rmi://Host-IP:NamingPort may be replaced by rmi://localhost:9191, where the lookup is on another VM on the same host with Naming Service on port 9191.

The Java API and the MBean API for Console are available at www.pramati.com/docstore/1205009/javadoc/index.html.

How do I register User MBeans using MLET Service?

You can instantiate and register your own MBeans in the MBean Server using the m-let service. An m-let text file contains information on the MBeans to be obtained. The location of the m-let text file is specified by a URL, so that, when the file is loaded, the instance of each MBean defined in the m-let text file, is created and registered. The MBean by name mlet-service is bound to the Server by default.

The m-let text file should have the following pseudo XML format:

<MLET
CODE = class | OBJECT = serfile
ARCHIVE = "archivelist"
[CODEBASE = codebaseURL]
[NAME = MBeanName]
[VERSION = version]
>
[arglist]
<MLET>

The following table contains attribute definitions:

Table 1: Attribute definitions

Attribute	Description
code	Class name of the MBean including package name is specified here. Either the code or object attribute must be present.
object	Serialized representation of the MBean that is to be obtained.
archive	JAR name or jar comma-separated list enclosed in double quotes.
codebase	This specifies the URL of the MBean to be obtained. The JAR name must be stored in the URL specified here.
name	Name of the MBean that is to be registered.
version	This version number must contain non-negative integers. It can be used to specify whether or not the jar files need to be loaded from the Server to update those already loaded by the m-let service.

Here,

Each m-let tag in the m-let file describes one MBean to be downloaded and created in the MBean Server.
Locations of the m-let files should be added to the m-let service by calling addURL() method.
After adding the URLs to the m-let service, call the getMBeansFromURL method with one of the added URLs. This tries to instantiate and register the newly downloaded MBeans. The method returns the object Instance of the MBeans that were successfully created and a Throwable object for those that were not.

You can do all the above itemized steps from Pramati's MBean Viewer.

How do I create MLET Files?

Consider the following example:

<MLET
	CODE =SimpleStandard
	ARCHIVE = "jmxClient.jar"
	CODEBASE = "file:/home/working_dir/PServer/server/lib/ext/"
	NAME =PRAMATI:type=MySimpleStdMBean>
<MLET>

This m-let file will try to register SimpleStandard MBean whose class files are in the jmxClient.jar file at the location specified by the CODEBASE tag.
Save this file on your local file system (myDir) Then your URL will be file:/home/working_dir/PServer50/server/myDir/conf.mlet.
Access the Console. Click Utilities > MBean Viewer. Choose PRAMATI domain. Since MLet Service is bound by the name PRAMATI:type=mlet-service you can access the page for the MLet service by clicking its name.
Go to Operations tab. Locate the method addURL which takes java.lang.String as input parameter.
Copy the URL location to the input text box against addURL() method. Click Submit. You should see message that the operation has been invoked successfully.
After you have added the URL successfully, invoke the method getMBeanFromURL() by copying the same URL to the input text box against the getMBeansFromURL() method.
On successful completion, the MBeans specified in the m-let file should be registered.

The m-let text file should be present in the same directory as the jar files and class files.

After creating the m-let text file, click View under MBean Viewer on the Console. This invokes MBean Viewer Dialog. Select domain as Pramati and click name type=mlet-service.

Specify value as the URL where the m-let text file is present. This registers the MBean to the Server and creates a new domain.

How do I use JConsole to connect to Pramati MBean Server?

JConsole is a java Swing-based application that ships with JDK 5.0. To run this application, invoke jconsole.exe in your JDK_HOME/bin. JConsole can be used to connect to Pramati's MBean Server.

Note: To use JConsole, Pramati Server must be started using jdk1.4.2 or higher including jdk1.5.

JConsole can connect to a running JVM in three different ways:

Local - for local monitoring
Remote - for remote monitoring
Advanced - for remote connection using JMXServiceURL

How does JConsole connect locally to a running JVM for Local Monitoring?

For local monitoring, you must start Pramati Server using JDK 1.5.

Add the system property com.sun.management.jmxremote to the command for starting the Server. You need to modify runserver.bat/runserver.sh file in /server/bin/ directory to include this system property.
Start JConsole using $JDK_HOME/bin>jconsole.exe
A connection dialog box opens, whose Local tab lists any JVMs running on the local system started with the same user ID as JConsole, along with their process ID and class/argument information.
Connect to the Pramati MBean Server.

How does JConsole connect remotely to a running JVM for Remote Monitoring?

Use this method for remote monitoring of the Server without capabilities to perform "secure operations" like deploying application or stopping the server.

This method uses an arbitrary port to export the RMI JMX Adapter. To use a port of your choice, you need to add the com.sun.management.jmxremote.port, com.sun.management.jmxremote.authenticate, and com.sun.management.jmxremote.ssl Java system properties while starting the Server.

Example for Starting a Simple Application for Remote Monitoring

>java -Dcom.sun.management.jmxremote \ -Dcom.sun.management.jmxremote.port=8004
-Dcom.sun.management.jmxremote.authenticate=false
-Dcom.sun.management.jmxremote.ssl=false
-classpath %PROJECT_DIRECTORY% SomeSimpleApplication

When you now start JConsole from a remote machine, you should now be able to connect to the JMX agent in your application by entering the relevant information under the Remote tab of the Connect to Agent dialog box.

How does JConsole connect to a running JVM for Remote Connection using JMXServiceURL?

This is the preferred way to connect to Pramati MBean Server from a remote machine. This procedure exploits the compliance of Pramati MBean Server with JSR-160 standard and demonstrates how third party tools like JConsole can be used to Manage the Server and its sub-systems.

Start JConsole with jconsole.jar and pramati_client_all.jar in the JConsole classpath and system properties java.naming.factory.initial and java.naming.factory.url.pkgs as shown below:

jconsole.exe
-J-Djava.class.path=%JAVA_HOME%\lib\jconsole.jar;
  %JAVA_HOME%\lib\tools.jar;
  D:\PS\lib\pramati_client\pramati_client_all.jar
-J-Djava.naming.factory.initial=com.pramati.naming.client.PramatiClientContextFactory
-J-Djava.naming.factory.url.pkgs=com.pramati.naming.url

JMX Service URL to connect to JSR 160 client connector is service:jmx:rmi:///jndi/rmi://localhost:9191/std-rmi-client-connector.
When you now start JConsole from a remote networked machine, you should now be able to connect to the JMX agent in your application by entering the relevant information under the Advanced tab of the Connect to Agent dialog box.

How do I monitor Pramati MBeans?

After logging into JConsole, the start page displays the summary.

The MBeans tab shows the list of all the domains and the mbeans in them. For example, you can access the EJB container in the domain "PRAMATI", and invoke the operations on it. The right pane consists of all the attributes, operations and notifications supported by the EjbContainerMBean.


© Pramati Technologies 2007	Runs on Pramati Server \| Feedback \| Legal

How do I work with MBeans?

Table of Contents

How do I work with MBeans?

How do I use MBean Viewer on the Console?

How do I monitor MBean Attributes?

How do I monitor MBean Operations?

How do I monitor MBean Notifications?

How do I access Pramati MBean Server?

How do I use Pramati MBean APIs?

How do I register User MBeans using MLET Service?

How do I create MLET Files?

How do I use JConsole to connect to Pramati MBean Server?

How does JConsole connect locally to a running JVM for Local Monitoring?

How does JConsole connect remotely to a running JVM for Remote Monitoring?

How does JConsole connect to a running JVM for Remote Connection using JMXServiceURL?

How do I monitor Pramati MBeans?