com.sun.jbi.management.support

Class MBeanNamesImpl

java.lang.Object

com.sun.jbi.management.support.MBeanNamesImpl

All Implemented Interfaces:

MBeanNames

public class MBeanNamesImpl
extends Object
implements MBeanNames

Implementation of MBeanNames interface.

Author:

Sun Microsystems, Inc.

Nested Class Summary

Nested classes/interfaces inherited from interface com.sun.jbi.management.MBeanNames

MBeanNames.ComponentServiceType, MBeanNames.ServiceName, MBeanNames.ServiceType

Field Summary

Fields

Modifier and Type	Field and Description
static String	JBI_DOMAIN
static String	SERVICE_NAME_KEY
static String	SERVICE_TYPE_KEY

Fields inherited from interface com.sun.jbi.management.MBeanNames

COMPONENT_ID_KEY, COMPONENT_TYPE_INSTALLED, COMPONENT_TYPE_KEY, COMPONENT_TYPE_SYSTEM, CONTROL_TYPE_ADMIN_SERVICE, CONTROL_TYPE_CONFIG_SERVICE, CONTROL_TYPE_CONFIGURATION, CONTROL_TYPE_CONTROLLER, CONTROL_TYPE_CUSTOM, CONTROL_TYPE_DEPLOY_SERVICE, CONTROL_TYPE_DEPLOYER, CONTROL_TYPE_INSTALL_SERVICE, CONTROL_TYPE_INSTALLER, CONTROL_TYPE_KEY, CONTROL_TYPE_LIFECYCLE, CONTROL_TYPE_LOGGER, CONTROL_TYPE_LOGGING_SERVICE, CONTROL_TYPE_MESSAGE_SERVICE, CONTROL_TYPE_NOTIFICATION, CONTROL_TYPE_STATISTICS, CONTROL_TYPE_SYSTEM, CUSTOM_CONTROL_NAME_KEY, EVENT_MANAGEMENT_MBEAN_NAME, EVENTMANAGEMENT_CONTROLLER_MBEAN_NAME, INSTALLED_TYPE_BINDING, INSTALLED_TYPE_ENGINE, INSTALLED_TYPE_KEY, INSTANCE_NAME_KEY, LOGGER_NAME_KEY, SERVICE_NAME_ADMIN_SERVICE, SERVICE_NAME_CONFIG_SERVICE, SERVICE_NAME_DEPLOY_SERVICE, SERVICE_NAME_FRAMEWORK, SERVICE_NAME_INSTALL_SERVICE, SERVICE_NAME_JBI, SERVICE_NAME_LOGGING_SERVICE, SERVICE_NAME_MESSAGE_SERVICE

Fields inherited from interface javax.jbi.management.MBeanNames

BOOTSTRAP_EXTENSION, COMPONENT_LIFE_CYCLE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
MBeanNamesImpl(String jmxDomain, String instanceName) Constructor.

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.
ObjectName	getBindingMBeanName(String bindingName, MBeanNames.ComponentServiceType serviceType, String target) Returns object name of type a Binding Object Name: com.sun.jbi:Target={target}, ServiceType={serviceType}, ComponentName="bindingName"
ObjectName	getBindingMBeanName(String bindingName, String controlType) Formulate and return the MBean ObjectName of a control MBean for a Binding Component.
ObjectName	getComponentExtensionFacadeMBeanName(String componentName, String target) Returns the ObjectName of the ComponentExtension facade MBean registered for the component.
ObjectName	getComponentLoggerMBeanNameFilter(String instanceName, String componentName) Returns the ObjectName to be used to filter Logger MBeans registered for a component : com.sun.jbi:JbiName=instanceName,CustomControlName=logName,ComponentName=mComponentName,ControlType=Logger,*
ObjectName	getComponentMBeanName(String compName, ComponentType compType, MBeanNames.ComponentServiceType serviceType, String target) Utility method to get a component's MBean name based on the component's type (binding or engine).
ObjectName	getCustomBindingMBeanName(String customName, String bindingName) Formulate and return the MBean ObjectName of custom control MBean for a Binding Component.
ObjectName	getCustomComponentMBeanNameFilter(String instanceName, String customName, String componentName) Returns the ObjectName to be used to filter component registered custom MBeans : com.sun.jbi:JbiName={instanceName}, ControlType=Custom
ObjectName	getCustomEngineMBeanName(String customName, String engineName) Formulate and return the MBean ObjectName of custom control MBean for a Service Engine.
ObjectName	getEngineMBeanName(String engineName, MBeanNames.ComponentServiceType serviceType, String target) Returns object name of type a Engine Object Name: com.sun.jbi:Target={target}, ServiceType={serviceType}, ComponentName="engineName"
ObjectName	getEngineMBeanName(String engineName, String controlType) Formulate and return the MBean ObjectName of a control MBean for a Service Engine.
String	getJbiInstanceName() Return the name of this JBI Framework runtime
String	getJmxDomainName() Retrieve the default JMX Domain Name for MBeans registered in this instance of the JBI implementation.
ObjectName	getLocalSystemServiceMBeanName(String name, String type) Formulate and return the MBean ObjectName of a local JBI Framework schemaorg_apache_xmlbeans.system service.
ObjectName	getSystemServiceLoggerMBeanName(String name, Logger logger) Formulate and return the LoggerMBean ObjectName of a JBI Framework schemaorg_apache_xmlbeans.system service.
ObjectName	getSystemServiceMBeanName(MBeanNames.ServiceName serviceName, MBeanNames.ServiceType serviceType, String target) Returns object name of type a SystemService Object Name: com.sun.jbi:Target={target},ServiceName={serviceName},ServiceType={serviceType}
ObjectName	getSystemServiceMBeanName(String serviceName, String type) Formulate and return the MBean ObjectName of control MBean for a JBI schemaorg_apache_xmlbeans.system service.
ObjectName	getSystemServiceMBeanName(String serviceName, String type, String instanceName) Formulate and return the MBean ObjectName of control MBean for a JBI schemaorg_apache_xmlbeans.system service for the specified instance name.

Methods inherited from class java.lang.Object

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

Field Detail

JBI_DOMAIN

public static final String JBI_DOMAIN

See Also:

Constant Field Values

SERVICE_TYPE_KEY

public static final String SERVICE_TYPE_KEY

See Also:

Constant Field Values

SERVICE_NAME_KEY

public static final String SERVICE_NAME_KEY

See Also:

Constant Field Values

Constructor Detail

MBeanNamesImpl

public MBeanNamesImpl(String jmxDomain,
              String instanceName)

Constructor.

Parameters:

jmxDomain - - JMX Domain Name.

instanceName - - instance name of the runtime.

Method Detail

getJmxDomainName

public String getJmxDomainName()

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

Specified by:

getJmxDomainName in interface MBeanNames

Returns:

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

createCustomComponentMBeanName

public 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: MBeanNames.BOOTSTRAP_EXTENSION.
• Component life cycle extension: MBeanNames.COMPONENT_LIFE_CYCLE_EXTENSION.

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

Specified by:

createCustomComponentMBeanName in interface MBeanNames

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

getComponentMBeanName

public ObjectName getComponentMBeanName(String compName,
                               ComponentType compType,
                               MBeanNames.ComponentServiceType serviceType,
                               String target)

Utility method to get a component's MBean name based on the component's type (binding or engine). This saves clients from coding the same conditional (e.g. if type == binding call getBindingMBeanName) over and over again.

Parameters:

componentName - component name

serviceType - type of MBean

target - administration target

Returns:

ObjectName in the component's namespace for the given service

getBindingMBeanName

public ObjectName getBindingMBeanName(String bindingName,
                             String controlType)

Formulate and return the MBean ObjectName of a control MBean for a Binding Component.

Parameters:

bindingName - the name of the Binding Component.

controlType - the type of control (MBean type).

Returns:

the JMX ObjectName of the MBean, or null if controlType is invalid.

getCustomBindingMBeanName

public ObjectName getCustomBindingMBeanName(String customName,
                                   String bindingName)

Formulate and return the MBean ObjectName of custom control MBean for a Binding Component.

Parameters:

customName - the name of the custom control.

bindingName - the name of the Binding Component.

Returns:

the JMX ObjectName or null if illegal name.

getCustomEngineMBeanName

public ObjectName getCustomEngineMBeanName(String customName,
                                  String engineName)

Formulate and return the MBean ObjectName of custom control MBean for a Service Engine.

Parameters:

customName - the name of the custom control.

engineName - the name of the Service Engine.

Returns:

the JMX ObjectName or null if illegal name.

getEngineMBeanName

public ObjectName getEngineMBeanName(String engineName,
                            String controlType)

Formulate and return the MBean ObjectName of a control MBean for a Service Engine.

Parameters:

engineName - the name of the Service Engine.

controlType - the type of control (MBean type).

Returns:

the JMX ObjectName of the MBean, or null if controlType is invalid.

getSystemServiceMBeanName

public ObjectName getSystemServiceMBeanName(String serviceName,
                                   String type)

Formulate and return the MBean ObjectName of control MBean for a JBI schemaorg_apache_xmlbeans.system service.

Parameters:

serviceName - the name of the schemaorg_apache_xmlbeans.system service.

type - the type of the MBean.

Returns:

the JMX ObjectName of the specified MBean, or null if the serviceName or type is illegal.

getSystemServiceMBeanName

public ObjectName getSystemServiceMBeanName(String serviceName,
                                   String type,
                                   String instanceName)

Formulate and return the MBean ObjectName of control MBean for a JBI schemaorg_apache_xmlbeans.system service for the specified instance name.

Parameters:

serviceName - the name of the schemaorg_apache_xmlbeans.system service.

type - the type of the MBean.

instanceName - the name of the server instance.

Returns:

the JMX ObjectName of the specified MBean, or null if the serviceName or type is illegal.

getSystemServiceLoggerMBeanName

public ObjectName getSystemServiceLoggerMBeanName(String name,
                                         Logger logger)

Formulate and return the LoggerMBean ObjectName of a JBI Framework schemaorg_apache_xmlbeans.system service.

Parameters:

name - - the name of the schemaorg_apache_xmlbeans.system service.

logger - - the Logger instance.

Returns:

the JMX ObjectName of the service, or null if illegal name.

getJbiInstanceName

public String getJbiInstanceName()

Return the name of this JBI Framework runtime

Returns:

the instance name of this runtime.

getLocalSystemServiceMBeanName

public ObjectName getLocalSystemServiceMBeanName(String name,
                                        String type)

Formulate and return the MBean ObjectName of a local JBI Framework schemaorg_apache_xmlbeans.system service. A local services does not include the jbi runtime instance name.

Parameters:

name - - the name of the schemaorg_apache_xmlbeans.system service

type - - the type of the MBean

Returns:

the JMX ObjectName of the service, or null if illegal name

getBindingMBeanName

public ObjectName getBindingMBeanName(String bindingName,
                             MBeanNames.ComponentServiceType serviceType,
                             String target)

Returns object name of type a Binding Object Name: com.sun.jbi:Target={target}, ServiceType={serviceType}, ComponentName="bindingName"

Parameters:

bindingName - - binding component name

serviceType -

target - - administration target

Returns:

the Object name of the facade AdminServiceMBean for the desired target.

getEngineMBeanName

public ObjectName getEngineMBeanName(String engineName,
                            MBeanNames.ComponentServiceType serviceType,
                            String target)

Returns object name of type a Engine Object Name: com.sun.jbi:Target={target}, ServiceType={serviceType}, ComponentName="engineName"

Parameters:

engineName - - service engine name

serviceType -

target - - administration target

Returns:

the Object name of the facade AdminServiceMBean for the desired target.

getSystemServiceMBeanName

public ObjectName getSystemServiceMBeanName(MBeanNames.ServiceName serviceName,
                                   MBeanNames.ServiceType serviceType,
                                   String target)

Returns object name of type a SystemService Object Name: com.sun.jbi:Target={target},ServiceName={serviceName},ServiceType={serviceType}

Parameters:

serviceName - the schemaorg_apache_xmlbeans.system service name

serviceType - the schemaorg_apache_xmlbeans.system service type

target - - administration target

Returns:

the Object name of the facade AdminServiceMBean for the desired target.

getCustomComponentMBeanNameFilter

public ObjectName getCustomComponentMBeanNameFilter(String instanceName,
                                           String customName,
                                           String componentName)

Returns the ObjectName to be used to filter component registered custom MBeans : com.sun.jbi:JbiName={instanceName}, ControlType=Custom

Parameters:

instanceName - - instance name

customName - - custom control name

componentName - - component name

Returns:

the custom component MBean ObjectName

getComponentLoggerMBeanNameFilter

public ObjectName getComponentLoggerMBeanNameFilter(String instanceName,
                                           String componentName)

Returns the ObjectName to be used to filter Logger MBeans registered for a component : com.sun.jbi:JbiName=instanceName,CustomControlName=logName,ComponentName=mComponentName,ControlType=Logger,*

Parameters:

instanceName - - target instance name

componentName - - target component name

Returns:

the ObjectName to be used to filter component registered custom MBeans

getComponentExtensionFacadeMBeanName

public ObjectName getComponentExtensionFacadeMBeanName(String componentName,
                                              String target)

Returns the ObjectName of the ComponentExtension facade MBean registered for the component.

Parameters:

target - - target name

componentName - - target component name

Returns:

the ObjectName of the component extension facade MBean.