/********************************************************************************
* CruiseControl, a Continuous Integration Toolkit
* Copyright (c) 2004, ThoughtWorks, Inc.
* 200 E. Randolph, 25th Floor
* Chicago, IL 60601 USA
* All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* + Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* + Redistributions in binary form must reproduce the above
* copyright notice, this list of conditions and the following
* disclaimer in the documentation and/or other materials provided
* with the distribution.
*
* + Neither the name of ThoughtWorks, Inc., CruiseControl, nor the
* names of its contributors may be used to endorse or promote
* products derived from this software without specific prior
* written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
* "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
* LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR
* A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR
* CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
* EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
* PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
* PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
* LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
* NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
* SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
********************************************************************************/
package net.sourceforge.cruisecontrol.jmx;
import java.io.IOException;
import java.rmi.NoSuchObjectException;
import java.rmi.RemoteException;
import java.util.HashMap;
import java.util.Map;
import java.util.Iterator;
import javax.management.Attribute;
import javax.management.MBeanServer;
import javax.management.MBeanServerFactory;
import javax.management.ObjectName;
import javax.management.remote.JMXConnectorServer;
import javax.management.remote.JMXConnectorServerFactory;
import javax.management.remote.JMXServiceURL;
import javax.naming.Context;
import mx4j.log.Log;
import mx4j.log.Log4JLogger;
import mx4j.tools.adaptor.http.HttpAdaptor;
import mx4j.tools.naming.NamingService;
import mx4j.tools.naming.NamingServiceMBean;
import net.sourceforge.cruisecontrol.CruiseControlController;
import net.sourceforge.cruisecontrol.util.MainArgs;
import org.apache.log4j.Logger;
/**
* JMX agent for a ProjectController
*
* @author <a href="mailto:jcyip@thoughtworks.com">Jason Yip</a>
*/
public class CruiseControlControllerAgent {
private static final Logger LOG = Logger.getLogger(CruiseControlControllerAgent.class);
private static final String JNDI_NAME = "/jndi/jrmp";
private final HttpAdaptor httpAdaptor = new HttpAdaptor();
private final int httpPort;
private NamingServiceMBean rmiRegistry;
private JMXConnectorServer connectorServer;
private final int connectorServerPort;
private final String path;
private final String user;
private final String password;
public CruiseControlControllerAgent(final CruiseControlController controller, final int httpPort,
final int connectorServerPort, final String user, final String password, final String xslPath,
final LOAD_JMX_AGENTUTIL enableJMXAgentUtility) {
this.httpPort = httpPort;
this.connectorServerPort = connectorServerPort;
path = xslPath;
CruiseControlControllerJMXAdaptor controllerAdaptor = new CruiseControlControllerJMXAdaptor(controller);
this.user = user;
this.password = password;
// Redirect MX4J logging to the Log4j system
Log.redirectTo(new Log4JLogger());
Iterator i = MBeanServerFactory.findMBeanServer(null).iterator();
MBeanServer server = i.hasNext() ? (MBeanServer) i.next() : MBeanServerFactory.createMBeanServer();
try {
controllerAdaptor.register(server);
} catch (Exception e) {
LOG.error("Problem registering CruiseControlController HttpAdaptor", e);
}
try {
registerHttpAdaptor(server);
} catch (Exception e) {
LOG.error("Problem registering HttpAdaptor", e);
}
try {
registerConnectorServer(server);
} catch (Exception e) {
LOG.error("Problem registering ConnectorServer", e);
}
try {
ObjectName name = new ObjectName("Logger:name=root");
server.registerMBean(new LoggerController(Logger.getRootLogger()), name);
} catch (Exception e) {
LOG.error("Problem registering LoggerController for root-Logger", e);
}
try {
ObjectName name = new ObjectName("CruiseControl Dashboard:name=posting");
server.registerMBean(new DashboardController(controller), name);
} catch (Exception e) {
LOG.error("Problem registering DashboardController for posting", e);
}
// when "-agentutil false", do not attempt to load.
if (LOAD_JMX_AGENTUTIL.FORCE_BYPASS != enableJMXAgentUtility) {
try {
// use reflection to avoid dependency on CCDist
final String className = "net.sourceforge.cruisecontrol.jmx.JMXBuildAgentUtility";
final Class< ? > clsCCDistMBean = loadCCDistMBeanClass(enableJMXAgentUtility, className);
if (clsCCDistMBean != null) {
final Object objCCDistMBean
= clsCCDistMBean.getConstructor((Class[]) null).newInstance((Object[]) null);
final ObjectName name = new ObjectName("CruiseControl Distributed:name=buildAgentUtility");
server.registerMBean(objCCDistMBean, name);
}
} catch (Exception e) {
LOG.error("Problem registering Build Agent Utility jmx bean", e);
}
}
}
private static Class loadCCDistMBeanClass(final LOAD_JMX_AGENTUTIL enableJMXAgentUtility, final String className) {
// use reflection to avoid dependency on CCDist
Class clsCCDistMBean = null;
try {
clsCCDistMBean = Class.forName(className);
} catch (ClassNotFoundException e) {
// we expect this exception if NOT running with CCDist classes on the classpath
final String msgPrefix = "Failed to load JMX CCDist class: " + className;
// -agentutil true. Considered an error if load fails.
if (LOAD_JMX_AGENTUTIL.FORCE_LOAD == enableJMXAgentUtility) {
LOG.error(msgPrefix + ". CCDist JMX classes are not on the classpath. \n"
+ "You need to include the contrib/distributed classes to use this feature. \n"
+ "Try using contrib/distributed/cruisecontrol[.bat][.sh].");
// default, if no command line arg present. Not an error if load fails.
} else {
LOG.debug(msgPrefix);
}
}
return clsCCDistMBean;
}
public void start() {
if (useHttpAdaptor()) {
try {
LOG.info("starting httpAdaptor");
httpAdaptor.start();
} catch (IOException e) {
LOG.error("Exception starting httpAdaptor", e);
}
}
if (useConnectorServer()) {
try {
LOG.info("starting rmiRegistry");
rmiRegistry.start();
} catch (RemoteException e) {
if (e.getMessage().startsWith("Port already in use")) {
LOG.warn("Port " + connectorServerPort + " is already in use, so no new rmiRegistry is started");
} else {
LOG.error("Exception starting rmiRegistry", e);
}
}
try {
LOG.info("starting connectorServer");
connectorServer.start();
} catch (Exception e) {
if (e.getMessage().startsWith("javax.naming.NameAlreadyBoundException")) {
LOG.warn("Couldn't start connectorServer since its name (" + JNDI_NAME
+ ") is already bound; you might need to restart your rmi registry");
} else {
LOG.error("Exception starting connectorServer", e);
}
}
}
}
public void stop() {
if (useHttpAdaptor() && httpAdaptor.isActive()) {
httpAdaptor.stop();
}
if (useConnectorServer()) {
if (connectorServer.isActive()) {
try {
LOG.info("stopping connectorServer");
connectorServer.stop();
} catch (IOException e) {
LOG.error("IOException stopping connectorServer", e);
}
}
if (rmiRegistry.isRunning()) {
try {
LOG.info("stopping rmiRegistry");
rmiRegistry.stop();
} catch (NoSuchObjectException e) {
LOG.error("NoSuchObjectException stopping rmiRegistry", e);
}
}
}
}
private void registerHttpAdaptor(MBeanServer server) throws Exception {
if (useHttpAdaptor()) {
httpAdaptor.setPort(httpPort);
System.setProperty("cruisecontrol.jmxport", String.valueOf(httpPort));
httpAdaptor.setHost("0.0.0.0");
ObjectName adaptorName = new ObjectName("Adapter:name=HttpAdaptor,httpPort=" + httpPort);
server.registerMBean(httpAdaptor, adaptorName);
ObjectName processorName = new ObjectName("Http:name=XSLTProcessor");
server.createMBean("mx4j.tools.adaptor.http.XSLTProcessor", processorName, null);
String pathInJar = "net/sourceforge/cruisecontrol/jmx/xsl";
if (path != null && !path.equals("")) {
LOG.info("Starting HttpAdaptor with customized Stylesheets");
server.setAttribute(processorName, new Attribute("File", path));
} else {
LOG.info("Starting HttpAdaptor with CC-Stylesheets");
server.setAttribute(processorName, new Attribute("PathInJar", pathInJar));
}
server.setAttribute(adaptorName, new Attribute("ProcessorName", processorName));
if (user != null && password != null) {
LOG.info("This CruiseControl instance is password protected");
httpAdaptor.setAuthenticationMethod("basic");
httpAdaptor.addAuthorization(user, password);
System.setProperty("jmx.http.username", user);
System.setProperty("jmx.http.password", password);
}
}
}
private boolean useHttpAdaptor() {
return httpPort != MainArgs.NOT_FOUND;
}
private void registerConnectorServer(MBeanServer server) throws Exception {
if (useConnectorServer()) {
// Create and start the naming service
ObjectName naming = new ObjectName("Naming:type=rmiregistry");
rmiRegistry = new NamingService(connectorServerPort);
server.registerMBean(rmiRegistry, naming);
System.setProperty("cruisecontrol.rmiport", String.valueOf(connectorServerPort));
JMXServiceURL address = new JMXServiceURL("rmi", "localhost", 0, JNDI_NAME);
final Map<String, String> environment = new HashMap<String, String>();
final String registryContextFactory = "com.sun.jndi.rmi.registry.RegistryContextFactory";
environment.put(Context.INITIAL_CONTEXT_FACTORY, registryContextFactory);
environment.put(Context.PROVIDER_URL, "rmi://localhost:" + connectorServerPort);
connectorServer = JMXConnectorServerFactory.newJMXConnectorServer(address, environment, server);
ObjectName connServerName = new ObjectName("ConnectorServer:name=" + JNDI_NAME);
server.registerMBean(connectorServer, connServerName);
}
}
private boolean useConnectorServer() {
return connectorServerPort != MainArgs.NOT_FOUND;
}
// /** CC Command line arguement name. */
// public static final String ARG_JMX_AGENTUTIL = "agentutil";
public static enum LOAD_JMX_AGENTUTIL {
/** default, if no command line arg present. Not an error if load fails. */
LOAD_IF_AVAILABLE,
/** -agentutil true. Considered an error if load fails. */
FORCE_LOAD,
/** -agentutil false. Do not attempt to load. */
FORCE_BYPASS
}
}