Read Me

ocms - OpenCms JMX Integration
==============================

Version:    0.2
Date:       2007-01-28 16:34
Author:     Joachim Zittmayr

A library for management and monitoring an OpenCms environment
using Java Management Extensions (JMX, JSR 3 and 160).

Tested with Java 1.5_x, Tomcat 5.5.x and OpenCms 6.2.3.

NOTE: Due to the fact that only Objects which implement the Serializable interface
can be "transported" via RMI, not all remote method invocations will work!!!

INSTALLATION INSTRUCTIONS
-------------------------

1.) Add the follwing lines to your tomcat startup script ($CATALINA_HOME/bin/startup.sh)
    for enabling JMX on Tomcat

    set CATALINA_OPTS="-Dcom.sun.management.jmxremote \
        -Dcom.sun.management.jmxremote.port=8050 \
        -Dcom.sun.management.jmxremote.ssl=false \
        -Dcom.sun.management.jmxremote.authenticate=false"

2.) Adapt your deployment descriptor by adding the following lines:

        <listener>
            <listener-class>org.opencms.main.OpenCmsMBeansListener</listener-class>
        </listener>


3.) Place the provided (or build ocmx by yourself, but adapt the build file accordingly)
    opencms_contrib-ocmx-0.2.jar in your opencms installations libs folder

4.) Start tomcat

5.) Be sure that you have opencms.jar and opencms_contrib-ocmx-0.2.jar in your classpath on client-side!

6.) Start jconsole and watch out for an MBean named org.opencms.main:CORE

7.) Try out the client (or change it to your needs) provided in this jar file!
    Especially if you change the jmx port (hardcoded at the moment) from above!