JMX Setup

The JMX is part of Java API since Java 5.

To enable it, you only have to pass the following argument in the virtual machine of your web application server:

        -Dcom.sun.management.jmxremote

JMX Setup for Java 1.4

As JMX is not part of Java 1.4, you will have to import JMX jars in your application. The 2 jars required are JMX-RI and JMX-remote.

For those who are using maven, include the following dependencies in your pom.

        <dependency>
                <groupId>javax.management</groupId>
                <artifactId>jmxri</artifactId>
                <version>1.2.1</version>
        </dependency>
        <dependency>
                <groupId>javax.management</groupId>
                <artifactId>jmxremote</artifactId>
                <version>1.0.1_04</version>
        </dependency>

The JMX-RI and JMX-remote have not been deployed on maven, so when searching for dependencies, maven will only retrieve the pom files. You should download the Jars from Sun download center (http://www.sun.com/download/index.jsp). Please follow the next instructions, to retrieve those libraries :

• In the download center, launch a search on JMX
• Select the Java Management Extensions Download Information.
• Download the JMX 1.2.1 Reference Implementation, and the JMX Remote API 1.0.1_04 Reference Implementation.
• After the download, for the JMX 1.2.1 RI, you will have to rename the jars from jmx*.jar to jmx*-1.2.1.jar.
• And for JMX Remote API, you will have to rename the jar file as jmxremote-1.0.1_04.jar.
• Then you can register them with Maven or set it directly in your local repository under /javax/management/jmxri/1.2.1/ .

For those, who are not using maven just download the jar files as described above, and put them in your application.

Secure access to JMX MBeans

To secure the JMX access to your application, please look for the section "Using Password and Access Files" at the following link.

• http://java.sun.com/j2se/1.5.0/docs/guide/management/agent.html

JAWR MBeans

We have defined two types of MBeans in JAWR. One which handles the configuration for a resource type (JS, CSS, Image). And another one, which handles the configuration for an entire application.

• JawrConfigManagerMBean

  This MBean will handle the configuration for one type of resource. You will be able to configure the following properties :

  • charsetName the charset name
  • cssLinkFlavor the CSS link flavor
  • debugModeOn the flag indicatin if we are in debug mode or not
  • debugOverrideKey the debug override key
  • gzipResourcesForIESixOn the flag indicating if we must GZIP resources for IE 6
  • gzipResourcesModeOn the flag indicating if we must GZIP resources
  • contextPathOverride the value which should be used to override the context path
  • contextPathSslOverride the value which should be used to override the context path for SSL request
  • useContextPathOverrideInDebugMode the flag indicating if we should the the overridden value of the context path in debug mode
  • dwrMapping the dwr mapping
  • imageBundleDefinition the image bundle definition
  • imageHashAlgorithm the image hash algorithm
  • usingClasspathCssImageServlet the flag indicating if we should use Image Servlet for CSS images of classpath CSS resources.
  • useBundleMapping the flag indicating if we should use the bundle mapping
  • jawrWorkingDirectory the JAWR working directory.

  You could modify these values at runtime, but the values will only be taken in account when you will launch the refreshConfig operation from the JMX console :

          /**
           * Refresh the configuration. 
           */
          public void refreshConfig();
  

• JawrApplicationConfigManagerMBean

  This MBean will handle the configuration for an entire application. This means that when modifying the configuration on this MBean, you will modify the configuration of JAWR for all resources (JS, CSS and Images).

  You will be able to configure the following properties :

  • charsetName the charset name
  • cssLinkFlavor the CSS link flavor
  • debugModeOn the flag indicating if we are in debug mode or not
  • debugOverrideKey the debug override key
  • gzipResourcesForIESixOn the flag indicating if we must GZIP resources for IE 6
  • gzipResourcesModeOn the flag indicating if we must GZIP resources
  • contextPathOverride the value which should be used to override the context path
  • contextPathSslOverride the value which should be used to override the context path for SSL request
  • useContextPathOverrideInDebugMode the flag indicating if we should the the overridden value of the context path in debug mode
  • useBundleMapping the flag indicating if we should use the bundle mapping
  • jawrWorkingDirectory the JAWR working directory.

  You could modify these values at runtime, but the values will only be taken in account when you will launch the refreshConfig operation from the JMX console :

          /**
           * Refresh the configuration. 
           */
          public void refreshConfig();
  

  There are other methods available in the JawrApplicationConfigManagerMBean.

          /**
           * Add a session ID to the set of debug session ID.
           * All request make by sessions, whose their IDs are contained in the debug session set,
           * will be threated as in debug mode.
           *   
           * @param sessionId the session ID to add
           */
          public void addDebugSessionId(String sessionId);
          
          /**
           * Add a session ID, to the set of debug session ID.
           * All request make by sessions, whose their IDs are contained in the debug session set,
           * will be threated as in debug mode.
           *   
           * @param sessionId the session ID to add
           */
          public void removeDebugSessionId(String sessionId);
  
          /**
           * Remove a session ID from the set of debug session ID.
           *   
           * @param sessionId the session ID to remove
           */
          public void removeAllDebugSessionId();
          
          /**
           * Returns true if the session ID passed in parameter is a debuggable session ID
           * @param sessionId the session ID
           * @return true if the session ID passed in parameter is a debuggable session ID
           */
          public boolean isDebugSessionId(String sessionId);
          
  

Multiple application using Jawr on the web application container

When you have multiple applications which are using Jawr, if you are using a servlet API, whose the version greater or equals to 2.5, Jawr will use the contextPath to identify the applications.

But if you are using a version which is lesser than 2.5, then you will have to use a context parameter named 'contextPath' in your web.xml to define the context path of the application like below.

        <context-param>
                <param-name>contextPath</param-name>
                <param-value>myApplication</param-value>
        </context-param>