Top Description Methods
org.springframework.jmx.export

public Interface MBeanExportOperations

Known Direct Implementers
org.springframework.jmx.export.MBeanExporter
Imports
javax.management.ObjectName
Interface that defines the set of MBean export operations that are intended to be accessed by application developers during application runtime.

This interface should be used to export application resources to JMX using Spring's management interface generation capabilities and, optionally, it's ObjectName generation capabilities.

Author
Rob Harrop
Since
2.0
See Also
MBeanExporter

Method Summary

Modifier and TypeMethod and Description
public ObjectName

Returns:

the ObjectName under which the resource was exposed
registerManagedResource(Object
the resource to expose via JMX
managedResource)

Register the supplied resource with JMX.

public void
registerManagedResource(Object
the resource to expose via JMX
managedResource, ObjectName
the ObjectName under which to expose the resource
objectName)

Register the supplied resource with JMX.

public void
unregisterManagedResource(ObjectName
the ObjectName of the resource to remove
objectName)

Remove the specified MBean from the underlying MBeanServer registry.

Method Detail

registerManagedResourceback to summary
public ObjectName registerManagedResource(Object managedResource) throws MBeanExportException

Register the supplied resource with JMX. If the resource is not a valid MBean already, Spring will generate a management interface for it. The exact interface generated will depend on the implementation and its configuration. This call also generates an ObjectName for the managed resource and returns this to the caller.

Parameters
managedResource:Object

the resource to expose via JMX

Returns:ObjectName

the ObjectName under which the resource was exposed

Exceptions
MBeanExportException:
if Spring is unable to generate an ObjectName or register the MBean
registerManagedResourceback to summary
public void registerManagedResource(Object managedResource, ObjectName objectName) throws MBeanExportException

Register the supplied resource with JMX. If the resource is not a valid MBean already, Spring will generate a management interface for it. The exact interface generated will depend on the implementation and its configuration.

Parameters
managedResource:Object

the resource to expose via JMX

objectName:ObjectName

the ObjectName under which to expose the resource

Exceptions
MBeanExportException:
if Spring is unable to register the MBean
unregisterManagedResourceback to summary
public void unregisterManagedResource(ObjectName objectName)

Remove the specified MBean from the underlying MBeanServer registry.

Parameters
objectName:ObjectName

the ObjectName of the resource to remove