org.apache.aries.jmx

Class AbstractCompendiumHandler

java.lang.Object

org.osgi.util.tracker.ServiceTracker

org.apache.aries.jmx.AbstractCompendiumHandler

All Implemented Interfaces:

MBeanHandler, org.osgi.util.tracker.ServiceTrackerCustomizer

Direct Known Subclasses:

ConfigurationAdminMBeanHandler, PermissionAdminMBeanHandler, ProvisioningServiceMBeanHandler, UserAdminMBeanHandler

public abstract class AbstractCompendiumHandler
extends org.osgi.util.tracker.ServiceTracker
implements MBeanHandler

Abstract implementation of MBeanHandler that provides a template with basic tracking of an optional compendium service. MBeanHandler implementations that manage a StandardMBean that is backed by a single OSGi compendium service should extend this class and implement the constructInjectMBean(Object) and getName() methods

Version:

$Rev: 1597603 $ $Date: 2014-05-26 17:17:52 +0200 (Mon, 26 May 2014) $

See Also:

MBeanHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected JMXAgentContext	agentContext
protected StandardMBean	mbean
protected AtomicLong	trackedId

Fields inherited from class org.osgi.util.tracker.ServiceTracker

context, filter

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractCompendiumHandler(JMXAgentContext agentContext, org.osgi.framework.Filter filter)
protected	AbstractCompendiumHandler(JMXAgentContext agentContext, String clazz)

Method Summary

Methods

Modifier and Type	Method and Description
Object	addingService(org.osgi.framework.ServiceReference reference)
protected abstract StandardMBean	constructInjectMBean(Object targetService) Implement this method to construct an appropriate StandardMBean instance which is backed by the supplied service tracked by this handler
protected abstract String	getBaseName() The base name of the MBean.
StandardMBean	getMbean() Gets the StandardMBean managed by this handler when the backing service is available or null
String	getName() Gets name of the MBean.
void	removedService(org.osgi.framework.ServiceReference reference, Object service)

Methods inherited from class org.osgi.util.tracker.ServiceTracker

close, getService, getService, getServiceReference, getServiceReferences, getServices, getServices, getTracked, getTrackingCount, isEmpty, modifiedService, open, open, remove, size, waitForService

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface org.apache.aries.jmx.MBeanHandler

close, open

Field Detail

agentContext

protected final JMXAgentContext agentContext

mbean

protected StandardMBean mbean

trackedId

protected final AtomicLong trackedId

Constructor Detail

AbstractCompendiumHandler

protected AbstractCompendiumHandler(JMXAgentContext agentContext,
                         org.osgi.framework.Filter filter)

Parameters:

agentContext -

filter -

AbstractCompendiumHandler

protected AbstractCompendiumHandler(JMXAgentContext agentContext,
                         String clazz)

Parameters:

agentContext -

clazz -

Method Detail

addingService

public Object addingService(org.osgi.framework.ServiceReference reference)

Specified by:

addingService in interface org.osgi.util.tracker.ServiceTrackerCustomizer

Overrides:

addingService in class org.osgi.util.tracker.ServiceTracker

removedService

public void removedService(org.osgi.framework.ServiceReference reference,
                  Object service)

Specified by:

removedService in interface org.osgi.util.tracker.ServiceTrackerCustomizer

Overrides:

removedService in class org.osgi.util.tracker.ServiceTracker

getMbean

public StandardMBean getMbean()

Gets the StandardMBean managed by this handler when the backing service is available or null

Specified by:

getMbean in interface MBeanHandler

Returns:

MBean @see StandardMBean.

See Also:

MBeanHandler.getMbean()

constructInjectMBean

protected abstract StandardMBean constructInjectMBean(Object targetService)

Implement this method to construct an appropriate StandardMBean instance which is backed by the supplied service tracked by this handler

Parameters:

targetService - the compendium service tracked by this handler

Returns:

The StandardMBean instance whose registration lifecycle will be managed by this handler

getBaseName

protected abstract String getBaseName()

The base name of the MBean. Will be expanded with the framework name and the UUID.

Returns:

getName

public String getName()

Description copied from interface: MBeanHandler

Gets name of the MBean.

Specified by:

getName in interface MBeanHandler

Returns:

MBean name.

See Also:

MBeanHandler.getName()