org.ow2.cmi.admin.MBeanUtils Maven / Gradle / Ivy
The newest version!
/**
* CMI : Cluster Method Invocation
* Copyright (C) 2007,2008 Bull S.A.S.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or any later version.
*
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
*
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307
* USA
*
* --------------------------------------------------------------------------
* $Id: MBeanUtils.java 2438 2010-02-24 16:20:30Z benoitf $
* --------------------------------------------------------------------------
*/
package org.ow2.cmi.admin;
import java.util.HashSet;
import java.util.List;
import java.util.Set;
import javax.management.MBeanServer;
import javax.management.MBeanServerFactory;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import net.jcip.annotations.ThreadSafe;
import org.ow2.cmi.controller.common.ClusterViewManager;
import org.ow2.cmi.controller.common.IConfig;
import org.ow2.cmi.controller.server.ServerClusterViewManager;
import org.ow2.util.log.Log;
import org.ow2.util.log.LogFactory;
/**
* This class is used to manage MBean registration.
* @author The new CMI team
*/
@ThreadSafe
public final class MBeanUtils {
/**
* Logger.
*/
private static Log logger = LogFactory.getLog(MBeanUtils.class);
/**
* MBeanServer.
*/
private static volatile MBeanServer mbeanServer;
/**
* MBean domain name.
*/
private static volatile String mbeanDomainName;
/**
* The agent identifier of the MBeanServer to retrieve.
*/
private static volatile String agentId;
/**
* MBean server name.
*/
private static String mbeanServerName;
/**
* True if CMIMBean is already registered.
*/
private static boolean registered = false;
/**
* Contains the additional MBeans.
*/
private static final Set XTRAMBEANS = new HashSet();
/**
* ObjectName for the CMI MBean.
*/
private static ObjectName cmiAdminObjectName = null;
private static String mbeanName;
/**
* Utility class, so no constructor.
*/
private MBeanUtils() {}
/**
* Initialize the MBeanServer.
* Use an already existing server when CMI is embedded, else create a new MBean server.
* @throws CMIMBeanConfigException if CMI is embedded but no MBean server is available
*/
private static void initMBeanServer() throws CMIMBeanConfigException {
// Gets the first available MBean Server
List mbeanServers = MBeanServerFactory.findMBeanServer(agentId);
if (mbeanServers.size() == 0) {
logger.info("Creating a new MBeanServer...");
// Needs to create an MBean server
mbeanServer = MBeanServerFactory.createMBeanServer(mbeanDomainName);
} else {
if (mbeanServers.size() > 1) {
logger.info("Many MBeanServer available: taking the first of the list");
}
mbeanServer = (MBeanServer) mbeanServers.get(0);
}
}
/**
* Set the MBean parameters when CMI is embedded.
* @param domainName the name of the JOnAS domain
* @param serverName the name of the server for creating MBeans
* @param agentId the agent identifier of the MBeanServer to retrieve
*/
public static synchronized void setMBeanParameters(final String domainName, final String serverName, final String agentId) {
mbeanDomainName = domainName;
mbeanServerName = serverName;
MBeanUtils.agentId = agentId;
}
/**
* Get the MBean server.
* @return MBean server
*/
public static MBeanServer getMBeanServer() {
return mbeanServer;
}
/**
* Build a JMX Object Name for a given mbean name.
* @param name mbean name
* @return a JMX Object Name
*/
private static String buildObjectName(final String name) {
assert name != null;
StringBuffer sb = new StringBuffer();
if(mbeanDomainName != null) {
sb.append(mbeanDomainName);
}
sb.append(":type=cmi");
sb.append(",name=" + name);
if(mbeanServerName != null) {
sb.append(",J2EEServer=" + mbeanServerName);
}
return sb.toString();
}
/**
* Get the MBean domain name.
* @return the MBean domain name
*/
public static String getMBeanDomainName() {
return mbeanDomainName;
}
/**
* Get the MBean server name.
* @return the MBean server name
*/
public static String getMBeanServerName() {
return mbeanServerName;
}
/**
* Register the CMIMBean.
* @param clusterViewManager the manager of the cluster view to use
* @throws CMIMBeanConfigException if CMIAdmin MBean cannot be registered
*/
public static synchronized void registerCMIMBean(final ClusterViewManager clusterViewManager)
throws CMIMBeanConfigException {
if(registered) {
logger.error("CMIMBean is already registered");
throw new CMIMBeanConfigException("CMIMBean is already registered");
}
IConfig config = clusterViewManager.getConfig();
if(mbeanServerName != null) {
if(mbeanDomainName == null) {
mbeanDomainName = config.getMbeanDomainName();
}
if(clusterViewManager instanceof ServerClusterViewManager) {
mbeanName = "CMIServer";
} else {
mbeanName = "CMIClient";
}
} else {
// Standalone mode: get values from cmi-server-config.xml
mbeanDomainName = config.getMbeanDomainName();
mbeanName = config.getMbeanName();
}
logger.debug("MBeanDomainName: {0}", mbeanDomainName);
logger.debug("MBeanServerName: {0}", mbeanServerName);
// Get a MBean server
initMBeanServer();
// Creates an ObjectName to register CMIAdmin
try {
cmiAdminObjectName = getCMIAdminObjectName();
} catch (MalformedObjectNameException e) {
logger.error("Cannot build an ObjectName for CMIAdmin", e);
throw new CMIMBeanConfigException("Cannot build an ObjectName for CMIAdmin", e);
}
// Creates the CMIAdminMBean
CMIAdminMBean cmiAdmin = CMIAdmin.getCMIAdmin(cmiAdminObjectName, clusterViewManager);
// Registers it with its ObjectName
try {
mbeanServer.registerMBean(cmiAdmin, cmiAdminObjectName);
} catch (Exception e) {
logger.error("Cannot register the CMIAdmin MBean", e);
throw new CMIMBeanConfigException("Cannot register the CMIAdmin MBean", e);
}
registered = true;
}
public static String getMbeanName() {
return mbeanName;
}
public static ObjectName getCMIAdminObjectName()
throws MalformedObjectNameException, NullPointerException {
String cmiAdminObjectNameRepresentation = buildObjectName(mbeanName);
return new ObjectName(cmiAdminObjectNameRepresentation);
}
/**
* Unregister the CMIMBean.
* @throws CMIMBeanConfigException if CMIAdmin MBean cannot be unregistered
*/
public static void unregisterCMIMBean() throws CMIMBeanConfigException {
if(registered) {
try {
mbeanServer.unregisterMBean(cmiAdminObjectName);
} catch (Exception e) {
logger.error("Cannot unregister the CMIAdmin MBean", e);
throw new CMIMBeanConfigException("Cannot unregister the CMIAdmin MBean", e);
}
CMIAdmin.destroy();
registered = false;
}
}
/**
* Registers an additional MBean.
* @param name its name
* @param mbean the object
* @throws CMIMBeanConfigException if the MBean cannot be registered
*/
public static synchronized ObjectName registerXtraMBean(final String name, final Object mbean)
throws CMIMBeanConfigException {
if(!registered) {
logger.error("CMIMBean is not already registered");
throw new CMIMBeanConfigException("CMIMBean is not already registered");
}
if(XTRAMBEANS.contains(name)) {
logger.error("{0} is already registered", name);
throw new CMIMBeanConfigException(name+" is already registered");
}
// Creates an ObjectName to register the MBean
ObjectName objectName = null;
String objectNameRepresentation = buildObjectName(name);
try {
objectName = new ObjectName(objectNameRepresentation);
} catch (MalformedObjectNameException e) {
logger.error("Cannot build an ObjectName with representation {0}",
objectNameRepresentation, e);
throw new CMIMBeanConfigException("Cannot build an ObjectName with representation "
+objectNameRepresentation, e);
}
// Registers it with its ObjectName
try {
mbeanServer.registerMBean(mbean, objectName);
} catch (Exception e) {
logger.error("Cannot register the MBean", e);
throw new CMIMBeanConfigException("Cannot register the MBean", e);
}
XTRAMBEANS.add(name);
return objectName;
}
/**
* Unregisters an additional MBean.
* @param objectName its name
* @param name its name
* @throws CMIMBeanConfigException if the MBean cannot be registered
*/
public static synchronized void unRegisterXtraMBean(final ObjectName objectName, final String name)
throws CMIMBeanConfigException {
if(!registered) {
logger.error("CMIMBean is not already registered");
throw new CMIMBeanConfigException("CMIMBean is not already registered");
}
// Registers it with its ObjectName
try {
mbeanServer.unregisterMBean(objectName);
} catch (Exception e) {
logger.error("Cannot unregister the MBean", e);
throw new CMIMBeanConfigException("Cannot unregister the MBean", e);
}
XTRAMBEANS.remove(name);
}
}