org.apache.jk.common: public class: JkMX

org.apache.jk.common
public class: JkMX [javadoc | source]

java.lang.Object
   org.apache.jk.core.JkHandler
      org.apache.jk.common.JkMX

All Implemented Interfaces:
NotificationListener, MBeanRegistration

Load the HTTP or RMI adapters for MX4J and JMXRI. Add "mx.enabled=true" in jk2.properties to enable it. You could also select http and/or jrmp protocol, with mx.httpPort, mx.httpHost, mxjrmpPort and mx.jrmpPort.

If you run into an error message like "SystemId Unknown; Line #12; Column #81; Cannot add attribute name after child nodes or before an element is produced. Attribute will be ignored." after setting mx.enabled to true, you probably need a newer version of Xalan. See the RELEASE-NOTES document section on XML Parsers for more information.
Field Summary
MBeanServer mserver
ObjectName httpServerName
ObjectName jrmpServerName
Fields inherited from org.apache.jk.core.JkHandler:
OK, LAST, ERROR, properties, wEnv, next, nextName, name, id, HANDLE_RECEIVE_PACKET, HANDLE_SEND_PACKET, HANDLE_FLUSH, HANDLE_THREAD_END, domain, oname, mserver

Constructor:

public JkMX()
{ }

Method from org.apache.jk.common.JkMX Summary:
addHandlerCallback, destroy, getAuthMode, getAuthPassword, getAuthUser, getEnabled, getHttpHost, getHttpPort, getJrmpHost, getJrmpPort, getLog4jEnabled, getMBeanServer, getPort, getUseXSLTProcessor, init, loadAdapter, setAuthMode, setAuthPassword, setAuthUser, setEnabled, setHttpHost, setHttpPort, setJrmpHost, setJrmpPort, setLog4jEnabled, setPort, setUseXSLTProcessor
Methods from org.apache.jk.core.JkHandler:
addHandlerCallback, createMsgContext, createMsgContext, destroy, getDomain, getId, getName, getNext, getObjectName, getProperty, handleNotification, init, invoke, pause, postDeregister, postRegister, preDeregister, preRegister, resume, setId, setName, setNext, setNext, setProperty, setWorkerEnv
Methods from java.lang.Object:
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Method from org.apache.jk.common.JkMX Detail:

public void addHandlerCallback(JkHandler w)
{ }
public void destroy()
{ try { if(log.isInfoEnabled()) log.info("Stoping JMX "); if( httpServerName!=null ) { mserver.invoke(httpServerName, "stop", null, null); } if( jrmpServerName!=null ) { mserver.invoke(jrmpServerName, "stop", null, null); } } catch( Throwable t ) { log.error( "Destroy error" + t ); } }
public String getAuthMode()
{ return authmode; }
public String getAuthPassword()
{ return authpassword; }
public String getAuthUser()
{ return authuser; }
public boolean getEnabled()
{ return enabled; }
public String getHttpHost()
{ return httphost; }
public int getHttpPort()
{ return httpport; }
public String getJrmpHost()
{ return jrmphost; }
public int getJrmpPort()
{ return jrmpport; }
public boolean getLog4jEnabled()
{ return log4jEnabled; }
MBeanServer getMBeanServer()
{ MBeanServer server; if( MBeanServerFactory.findMBeanServer(null).size() > 0 ) { server=(MBeanServer)MBeanServerFactory.findMBeanServer(null).get(0); } else { server=MBeanServerFactory.createMBeanServer(); } return (server); }
public int getPort()
{ return ((httpport != -1) ? httpport : jrmpport); }
public boolean getUseXSLTProcessor()
{ return useXSLTProcessor; }
public void init() throws IOException
{ try { mserver = getMBeanServer(); if( enabled ) { loadAdapter(); } if( log4jEnabled) { try { registerObject("org.apache.log4j.jmx.HierarchyDynamicMBean" , "log4j:hierarchy=default"); if(log.isInfoEnabled()) log.info("Registering the JMX hierarchy for Log4J "); } catch( Throwable t ) { if(log.isInfoEnabled()) log.info("Can't enable log4j mx: ",t); } } } catch( Throwable t ) { log.error( "Init error", t ); } }
public void loadAdapter() throws IOException
{ boolean httpAdapterLoaded = false; boolean jrmpAdapterLoaded = false; if ((httpport != -1) && classExists("mx4j.adaptor.http.HttpAdaptor")) { try { httpServerName = registerObject("mx4j.adaptor.http.HttpAdaptor", "Http:name=HttpAdaptor"); if( httphost!=null ) mserver.setAttribute(httpServerName, new Attribute("Host", httphost)); mserver.setAttribute(httpServerName, new Attribute("Port", new Integer(httpport))); if( "none".equals(authmode) || "basic".equals(authmode) || "digest".equals(authmode) ) mserver.setAttribute(httpServerName, new Attribute("AuthenticationMethod", authmode)); if( authuser!=null && authpassword!=null ) mserver.invoke(httpServerName, "addAuthorization", new Object[] { authuser, authpassword}, new String[] { "java.lang.String", "java.lang.String" }); if(useXSLTProcessor) { ObjectName processorName = registerObject("mx4j.adaptor.http.XSLTProcessor", "Http:name=XSLTProcessor"); mserver.setAttribute(httpServerName, new Attribute("ProcessorName", processorName)); } // starts the server mserver.invoke(httpServerName, "start", null, null); log.info( "Started MX4J console on host " + httphost + " at port " + httpport); httpAdapterLoaded = true; } catch( Throwable t ) { httpServerName=null; log.error( "Can't load the MX4J http adapter ", t ); } } if ((httpport != -1) && (!httpAdapterLoaded) && classExists("mx4j.tools.adaptor.http.HttpAdaptor")) { try { httpServerName = registerObject("mx4j.tools.adaptor.http.HttpAdaptor", "Http:name=HttpAdaptor"); if( httphost!=null ) mserver.setAttribute(httpServerName, new Attribute("Host", httphost)); mserver.setAttribute(httpServerName, new Attribute("Port", new Integer(httpport))); if( "none".equals(authmode) || "basic".equals(authmode) || "digest".equals(authmode) ) mserver.setAttribute(httpServerName, new Attribute("AuthenticationMethod", authmode)); if( authuser!=null && authpassword!=null ) mserver.invoke(httpServerName, "addAuthorization", new Object[] { authuser, authpassword}, new String[] { "java.lang.String", "java.lang.String" }); if(useXSLTProcessor) { ObjectName processorName = registerObject("mx4j.tools.adaptor.http.XSLTProcessor", "Http:name=XSLTProcessor"); mserver.setAttribute(httpServerName, new Attribute("ProcessorName", processorName)); } // starts the server mserver.invoke(httpServerName, "start", null, null); if(log.isInfoEnabled()) log.info( "Started MX4J console on host " + httphost + " at port " + httpport); httpAdapterLoaded = true; } catch( Throwable t ) { httpServerName=null; log.error( "Can't load the MX4J http adapter ", t ); } } if ((jrmpport != -1) && classExists("mx4j.tools.naming.NamingService")) { try { jrmpServerName = registerObject("mx4j.tools.naming.NamingService", "Naming:name=rmiregistry"); mserver.setAttribute(jrmpServerName, new Attribute("Port", new Integer(jrmpport))); mserver.invoke(jrmpServerName, "start", null, null); if(log.isInfoEnabled()) log.info( "Creating " + jrmpServerName ); // Create the JRMP adaptor ObjectName adaptor = registerObject("mx4j.adaptor.rmi.jrmp.JRMPAdaptor", "Adaptor:protocol=jrmp"); mserver.setAttribute(adaptor, new Attribute("JNDIName", "jrmp")); mserver.invoke( adaptor, "putNamingProperty", new Object[] { javax.naming.Context.INITIAL_CONTEXT_FACTORY, "com.sun.jndi.rmi.registry.RegistryContextFactory"}, new String[] { "java.lang.Object", "java.lang.Object" }); String jrpmurl = "rmi://" + jrmphost + ":" + Integer.toString(jrmpport) ; mserver.invoke( adaptor, "putNamingProperty", new Object[] { javax.naming.Context.PROVIDER_URL, jrpmurl}, new String[] { "java.lang.Object", "java.lang.Object" }); // Registers the JRMP adaptor in JNDI and starts it mserver.invoke(adaptor, "start", null, null); if(log.isInfoEnabled()) log.info( "Creating " + adaptor + " on host " + jrmphost + " at port " + jrmpport); jrmpAdapterLoaded = true; } catch( Exception ex ) { jrmpServerName = null; log.error( "MX4j RMI adapter not loaded: " + ex.toString()); } } if ((httpport != -1) && (! httpAdapterLoaded) && classExists("com.sun.jdmk.comm.HtmlAdaptorServer")) { try { httpServerName=registerObject("com.sun.jdmk.comm.HtmlAdaptorServer", "Adaptor:name=html,port=" + httpport); if(log.isInfoEnabled()) log.info("Registering the JMX_RI html adapter " + httpServerName + " at port " + httpport); mserver.setAttribute(httpServerName, new Attribute("Port", new Integer(httpport))); mserver.invoke(httpServerName, "start", null, null); httpAdapterLoaded = true; } catch( Throwable t ) { httpServerName = null; log.error( "Can't load the JMX_RI http adapter " + t.toString() ); } } if ((!httpAdapterLoaded) && (!jrmpAdapterLoaded)) log.warn( "No adaptors were loaded but mx.enabled was defined."); }
Initialize the worker. After this call the worker will be ready to accept new requests.
public void setAuthMode(String mode)
{ authmode=mode; }
public void setAuthPassword(String password)
{ authpassword=password; }
public void setAuthUser(String user)
{ authuser=user; }
public void setEnabled(boolean b)
{ enabled=b; }
Enable the MX4J adapters (new way)
public void setHttpHost(String host)
{ this.httphost=host; }
public void setHttpPort(int i)
{ httpport=i; }
Enable the MX4J HTTP internal adapter
public void setJrmpHost(String host)
{ this.jrmphost=host; }
public void setJrmpPort(int i)
{ jrmpport=i; }
Enable the MX4J JRMP internal adapter
public void setLog4jEnabled(boolean b)
{ log4jEnabled=b; }
Enable the Log4j MBean)
public void setPort(int i)
{ enabled=(i != -1); }
Enable the MX4J adapters (old way, compatible)
public void setUseXSLTProcessor(boolean uxsltp)
{ useXSLTProcessor = uxsltp; }

Field Summary
MBeanServer	mserver
ObjectName	httpServerName
ObjectName	jrmpServerName