Top Description Methods
org.apache.derby.mbeans

public Interface ManagementMBean

Known Direct Subinterfaces
org.apache.derby.iapi.services.jmx.ManagementService
Known Direct Implementers
org.apache.derby.mbeans.Management

JMX MBean inteface to control visibility of Derby's MBeans. When Derby boots it attempts to register its MBeans. It may fail due to lack of valid permissions. If Derby does not register its MBeans then an application may register the Management implementation of ManagementMBean itself and use it to start Derby's JMX management.

Key properties for registered MBean when registered by Derby:

See Also
Management, ManagementMBean#getSystemIdentifier()

Method Summary

Modifier and TypeMethod and Description
public String

Returns:

Runtime identifier for the system, null if Derby is not running.
getSystemIdentifier
()

Get the system identifier that this MBean is managing.

public boolean

Returns:

true Derby has registered beans, false Derby has not registered any beans.
isManagementActive
()

Is Derby's JMX management active.

public void
startManagement()

Inform Derby to start its JMX management by registering MBeans relevant to its current state.

public void
stopManagement()

Inform Derby to stop its JMX management by unregistering its MBeans.

Method Detail

getSystemIdentifierback to summary
public String getSystemIdentifier()

Get the system identifier that this MBean is managing. The system identifier is a runtime value to disambiguate multiple Derby systems in the same virtual machine but different class loaders.

Returns:String

Runtime identifier for the system, null if Derby is not running.

isManagementActiveback to summary
public boolean isManagementActive()

Is Derby's JMX management active. If active then Derby has registered MBeans relevant to its current state.

Returns:boolean

true Derby has registered beans, false Derby has not registered any beans.

startManagementback to summary
public void startManagement()

Inform Derby to start its JMX management by registering MBeans relevant to its current state. If Derby is not booted then no action is taken.

Require SystemPermission("jmx", "control") if a security manager is installed.

See Also
org.apache.derby.shared.common.security.SystemPermission
stopManagementback to summary
public void stopManagement()

Inform Derby to stop its JMX management by unregistering its MBeans. If Derby is not booted then no action is taken.

Require SystemPermission("jmx", "control") if a security manager is installed.

See Also
org.apache.derby.shared.common.security.SystemPermission