javax.jbi.management

Interface MBeanNames

public interface MBeanNames

This interface provides methods to create JMX object names for component- supplied MBeans. This ensures that component-supplied MBeans follow the JBI implementation-determined naming convention.

Components obtain instances of this name creator using ComponentContext.getMBeanNames().

Author:

JSR208 Expert Group

Field Summary

Fields

Modifier and Type	Field and Description
static String	BOOTSTRAP_EXTENSION The custom name that must be used for bootstrap extensions
static String	COMPONENT_LIFE_CYCLE_EXTENSION The custom name that must be used for component life cycle extensions

Method Summary

Methods

Modifier and Type	Method and Description
ObjectName	createCustomComponentMBeanName(String customName) Formulate and return an MBean ObjectName for a custom control of this name creator's JBI component.
String	getJmxDomainName() Retrieve the default JMX Domain Name for MBeans registered in this instance of the JBI implementation.

Field Detail

BOOTSTRAP_EXTENSION

static final String BOOTSTRAP_EXTENSION

The custom name that must be used for bootstrap extensions

See Also:

Constant Field Values

COMPONENT_LIFE_CYCLE_EXTENSION

static final String COMPONENT_LIFE_CYCLE_EXTENSION

The custom name that must be used for component life cycle extensions

See Also:

Constant Field Values

Method Detail

getJmxDomainName

String getJmxDomainName()

Retrieve the default JMX Domain Name for MBeans registered in this instance of the JBI implementation.

Returns:

the JMX domain name for this instance of the JBI implemention; must be non-null and non-empty

createCustomComponentMBeanName

ObjectName createCustomComponentMBeanName(String customName)

Formulate and return an MBean ObjectName for a custom control of this name creator's JBI component.

This is used by components to create JMX names for their own JMX controls, allowing the JBI implementation to prefix the created name to fit within the implementation's own naming scheme.

Standard extensions must use the following custom name constants:

• Bootstrap (installer) extension: BOOTSTRAP_EXTENSION.
• Component life cycle extension: COMPONENT_LIFE_CYCLE_EXTENSION.

All other custom component MBeans must use custom names that do not collide with the standard extension names.

Parameters:

customName - the name of the custom control; must be non-null and non-empty; must be legal for use in a JMX object name

Returns:

the JMX ObjectName of the MBean, or null if the customName is invalid