/* ====================================================================
* Loom Software License, version 1.1
*
* Copyright (c) 2003, Loom Group. All rights reserved.
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. Neither the name of the Loom Group nor the name "Loom" 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
* COPYRIGHT OWNER 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.
*
* ====================================================================
*
* Loom includes code from the Apache Software Foundation
*
* ====================================================================
* The Apache Software License, Version 1.1
*
* Copyright (c) 1997-2003 The Apache Software Foundation. All rights
* reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions
* are met:
*
* 1. Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
*
* 2. 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.
*
* 3. The end-user documentation included with the redistribution,
* if any, must include the following acknowledgment:
* "This product includes software developed by the
* Apache Software Foundation (http://www.apache.org/)."
* Alternately, this acknowledgment may appear in the software
* itself, if and wherever such third-party acknowledgments
* normally appear.
*
* 4. The names "Jakarta", "Avalon", and "Apache Software Foundation"
* must not be used to endorse or promote products derived from this
* software without prior written permission. For written
* permission, please contact apache@apache.org.
*
* 5. Products derived from this software may not be called "Apache",
* nor may "Apache" appear in their name, without prior written
* permission of the Apache Software Foundation.
*
* THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED 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 APACHE SOFTWARE FOUNDATION OR
* ITS 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 org.codehaus.loom.components.manager;
import javax.management.MBeanServer;
import javax.management.MalformedObjectNameException;
import javax.management.ObjectName;
import org.codehaus.loom.interfaces.ContainerConstants;
import org.codehaus.loom.interfaces.LoomException;
import org.codehaus.metaclass.jmx.MBeanBinder;
import org.codehaus.spice.salt.i18n.ResourceManager;
import org.codehaus.spice.salt.i18n.Resources;
/**
* An abstract class via which JMX Managers can extend.
*
* @author Peter Donald
* @author <a href="mailto:Huw@mmlive.com">Huw Roberts</a>
* @version $Revision: 1.4 $ $Date: 2004/08/17 23:14:32 $
*/
public abstract class AbstractJMXManager
extends AbstractSystemManager
{
private static final Resources REZ =
ResourceManager.getPackageResources( AbstractJMXManager.class );
private static final MBeanBinder BINDER = new MBeanBinder();
private MBeanServer m_mBeanServer;
public void initialize()
throws Exception
{
super.initialize();
m_mBeanServer = createMBeanServer();
}
public void dispose()
{
m_mBeanServer = null;
super.dispose();
}
/**
* Export the object to the particular management medium using the supplied
* object and interfaces. This needs to be implemented by subclasses.
*
* @param name the name of object
* @param object the object
* @return the exported object
* @throws LoomException if an error occurs
*/
protected Object export( final String name,
final Object object )
throws LoomException
{
try
{
BINDER.bindMBean( object,
createObjectName( name ),
getMBeanServer() );
return object;
}
catch( final Exception e )
{
final String message = REZ.format( "jmxmanager.error.export.fail",
name );
getLogger().error( message, e );
throw new LoomException( message, e );
}
}
/**
* Stop the exported object from being managed.
*
* @param name the name of object
* @param exportedObject the object return by export
* @throws LoomException if an error occurs
*/
protected void unexport( final String name,
final Object exportedObject )
throws LoomException
{
try
{
BINDER.unbindMBean( exportedObject,
createObjectName( name ),
getMBeanServer() );
}
catch( final Exception e )
{
final String message =
REZ.format( "jmxmanager.error.unexport.fail", name );
throw new LoomException( message, e );
}
}
protected MBeanServer getMBeanServer()
{
return m_mBeanServer;
}
/**
* Creates a new MBeanServer. The subclass should implement this to create
* specific MBeanServer.
*/
protected abstract MBeanServer createMBeanServer()
throws Exception;
/**
* Create JMX name for object.
*
* @param name the name of object
* @return the {@link ObjectName} representing object
* @throws MalformedObjectNameException if malformed name
*/
private ObjectName createObjectName( final String name )
throws MalformedObjectNameException
{
return new ObjectName( ContainerConstants.SOFTWARE + ":" + name );
}
}