/*
* Copyright (C) 2009 eXo Platform SAS.
*
* This 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 (at your option) any later version.
*
* This software 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 software; if not, write to the Free
* Software Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA
* 02110-1301 USA, or see the FSF site: http://www.fsf.org.
*/
package org.exoplatform.container.management;
import org.exoplatform.container.AbstractInterceptor;
import org.exoplatform.container.ExoContainer;
import org.exoplatform.container.monitor.jvm.J2EEServerInfo;
import org.exoplatform.container.spi.ComponentAdapter;
import org.exoplatform.container.spi.ContainerException;
import org.exoplatform.management.ManagementContext;
import org.exoplatform.management.jmx.impl.JMX;
import org.exoplatform.management.jmx.impl.JMXManagementProvider;
import org.exoplatform.management.jmx.impl.MBeanScopingData;
import org.exoplatform.management.spi.ManagementProvider;
import org.exoplatform.services.log.ExoLogger;
import org.exoplatform.services.log.Log;
import java.util.Collection;
import java.util.HashSet;
import java.util.LinkedHashMap;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.management.MBeanServer;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
/**
* @author <a href="mailto:julien.viet@exoplatform.com">Julien Viet</a>
* @version $Revision$
*/
public class ManageableContainer extends AbstractInterceptor
{
/**
* The serial version UID
*/
private static final long serialVersionUID = 5573000068005815688L;
/**
* The logger
*/
private static final Log LOG = ExoLogger.getLogger("exo.kernel.container.ManageableContainer");
private static MBeanServer findMBeanServer()
{
J2EEServerInfo serverenv_ = new J2EEServerInfo();
return serverenv_.getMBeanServer();
}
/** . */
ManagementContextImpl managementContext;
/** . */
private MBeanServer server;
private volatile boolean objectNameSet;
private ObjectName objectName;
/** . */
private final Set<ManagementProvider> providers;
public ManageableContainer()
{
this.providers = new CopyOnWriteArraySet<ManagementProvider>();
}
public ManageableContainer(ExoContainer holder, ExoContainer parent)
{
this.providers = new CopyOnWriteArraySet<ManagementProvider>();
//
setHolder(holder);
setParent(parent);
}
/**
* {@inheritDoc}
*/
public void setParent(ExoContainer parent)
{
this.parent = parent;
//
ManagementContextImpl parentCtx = null;
if (parent != null)
{
parentCtx = (ManagementContextImpl)parent.getManagementContext();
}
//
if (parentCtx != null)
{
server = parentCtx.container.server;
managementContext = new ManagementContextImpl(parentCtx, this);
}
else
{
server = findMBeanServer();
managementContext = new ManagementContextImpl(this);
addProvider(new JMXManagementProvider(server));
}
}
/**
* {@inheritDoc}
*/
public ManagementContext getManagementContext()
{
return managementContext;
}
/**
* {@inheritDoc}
*/
public final MBeanServer getMBeanServer()
{
return server;
}
/**
* Gives the ObjectName of the container build from the scoping data
* @return
*/
public ObjectName getScopingObjectName()
{
if (!objectNameSet)
{
synchronized (this)
{
if (!objectNameSet)
{
Map<String, String> props = new LinkedHashMap<String, String>();
// Merge scoping properties
List<MBeanScopingData> list = managementContext.getScopingData(MBeanScopingData.class);
if (list != null && !list.isEmpty())
{
// Read in revert order because wee received list of parents in upward order
for (int i = list.size(); i > 0; i--)
{
MBeanScopingData scopingData = list.get(i - 1);
props.putAll(scopingData);
}
try
{
this.objectName = JMX.createObjectName("exo", props);
}
catch (MalformedObjectNameException e)
{
LOG.error("Could not create the object name", e);
}
}
this.objectNameSet = true;
}
}
}
return objectName;
}
/**
* {@inheritDoc}
*/
public <T> ComponentAdapter<T> registerComponentInstance(Object componentKey, T componentInstance)
throws ContainerException
{
ComponentAdapter<T> adapter = super.registerComponentInstance(componentKey, componentInstance);
if (managementContext != null)
{
managementContext.register(componentInstance);
// Register if it is a management provider
if (componentInstance instanceof ManagementProvider)
{
ManagementProvider provider = (ManagementProvider)componentInstance;
addProvider(provider);
}
}
return adapter;
}
/**
* {@inheritDoc}
*/
@Override
public ComponentAdapter<?> unregisterComponent(Object componentKey)
{
Object componentInstance;
try
{
componentInstance = getComponentInstance(componentKey, Object.class, false);
if (managementContext != null && componentInstance != null)
{
managementContext.unregister(componentInstance);
}
}
catch (Exception e)
{
if (LOG.isTraceEnabled())
{
LOG.trace("An exception occurred: " + e.getMessage());
}
}
return super.unregisterComponent(componentKey);
}
/**
* {@inheritDoc}
*/
@Override
public void stop()
{
if (managementContext != null)
{
// un-manage all registered MBeans
managementContext.unregisterAll();
}
super.stop();
};
/**
* Returns the list of the providers which are relevant for this container.
*
* @return the providers
*/
Collection<ManagementProvider> getProviders()
{
HashSet<ManagementProvider> allProviders = new HashSet<ManagementProvider>();
computeAllProviders(allProviders);
return allProviders;
}
private void computeAllProviders(Set<ManagementProvider> allProviders)
{
if (parent != null)
{
managementContext.parent.container.computeAllProviders(allProviders);
}
//
allProviders.addAll(providers);
}
boolean addProvider(ManagementProvider provider)
{
// Prevent double registration just in case...
if (providers.contains(provider))
{
return false;
}
//
providers.add(provider);
// Perform registration of already registered managed components
managementContext.install(provider);
//
return true;
}
/**
* @return the holder
*/
public ExoContainer getHolder()
{
return holder;
}
/**
* {@inheritDoc}
*/
public String getId()
{
return "Management";
}
}