Top Description Fields Methods
org.apache.derby.iapi.services.jmx

public Interface ManagementService

extends ManagementMBean
Known Direct Implementers
org.apache.derby.impl.services.jmx.JMXManagementService, org.apache.derby.impl.services.jmxnone.NoManagementService
Imports
org.apache.derby.shared.common.error.StandardException, org.apache.derby.mbeans.ManagementMBean

This interface represents a Management Service. An implementation of this service is started by the Derby monitor if the system property derby.system.jmx has been set. The following services are provided:

The following code can be used to locate an instance of this service if running.

ManagementService ms = (ManagementService) Monitor.getSystemModule(Module.JMX);

Field Summary

Modifier and TypeField and Description
public static final String
DERBY_JMX_DOMAIN

The domain for all of derby's mbeans: org.apache.derby

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

the quoted value
quotePropertyValue(String
the value to quote
value)

Quote an MBean key property value, so that it is safe to pass to registerMBean even if it potentially contains special characters.

public <
The kind of bean
T> Object

Returns:

An identifier that can later be used to unregister the mbean.
registerMBean(T
The MBean to wrap with a StandardMBean and register
bean, Class<T>
The management interface for the MBean.
beanInterface, String
The String representation of the MBean's key properties, they will be added into the ObjectName with Derby's domain. Key type should be first with a short name for the bean, typically the class name without the package.
keyProperties)

Registers an MBean with the MBean server.

public void
unregisterMBean(Object
An identifier returned by registerMBean.
mbeanIdentifier)

Unregister a mbean previously registered with registerMBean.

Inherited from org.apache.derby.mbeans.ManagementMBean:
getSystemIdentifierisManagementActivestartManagementstopManagement

Field Detail

DERBY_JMX_DOMAINback to summary
public static final String DERBY_JMX_DOMAIN

The domain for all of derby's mbeans: org.apache.derby

Method Detail

quotePropertyValueback to summary
public String quotePropertyValue(String value)

Quote an MBean key property value, so that it is safe to pass to registerMBean even if it potentially contains special characters.

Parameters
value:String

the value to quote

Returns:String

the quoted value

See Also
javax.management.ObjectName#quote(String)
registerMBeanback to summary
public <T> Object registerMBean(T bean, Class<T> beanInterface, String keyProperties) throws StandardException

Registers an MBean with the MBean server. The mbean will be unregistered automatically when Derby shuts down.

Parameters
<T>
The kind of bean
bean:T

The MBean to wrap with a StandardMBean and register

beanInterface:Class<T>

The management interface for the MBean.

keyProperties:String

The String representation of the MBean's key properties, they will be added into the ObjectName with Derby's domain. Key type should be first with a short name for the bean, typically the class name without the package.

Returns:Object

An identifier that can later be used to unregister the mbean.

Exceptions
StandardException:
on error
unregisterMBeanback to summary
public void unregisterMBean(Object mbeanIdentifier)

Unregister a mbean previously registered with registerMBean.

Parameters
mbeanIdentifier:Object

An identifier returned by registerMBean.