com.sun.jbi.management

Interface MBeanNames

All Superinterfaces:

MBeanNames

public interface MBeanNames
extends MBeanNames

Extends the functionality of the public javax.jbi.management.MBeanNames interface, by defining constants used in MBean ObjectName attributes, and by providing additional operations to support multiple named logger MBeans.

Author:

Sun Microsystems, Inc.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MBeanNames.ComponentServiceType
static class	MBeanNames.ServiceName System services' names.
static class	MBeanNames.ServiceType System services' types.

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPONENT_ID_KEY ComponentName is defined to be the unique name assigned where ComponentType is Installed.
static String	COMPONENT_TYPE_INSTALLED An Installed component MBean.
static String	COMPONENT_TYPE_KEY The type of component represented by this MBean: either System or Installed Value is "ComponentType".
static String	COMPONENT_TYPE_SYSTEM A schemaorg_apache_xmlbeans.system component MBean.
static String	CONTROL_TYPE_ADMIN_SERVICE The JBI runtime AdministrationService MBean.
static String	CONTROL_TYPE_CONFIG_SERVICE The JBI runtime ConfigurationService MBean.
static String	CONTROL_TYPE_CONFIGURATION A Configuration MBean.
static String	CONTROL_TYPE_CONTROLLER A Controller MBean.
static String	CONTROL_TYPE_CUSTOM A custom vendor-installed MBean.
static String	CONTROL_TYPE_DEPLOY_SERVICE The JBI runtime DeploymentService MBean.
static String	CONTROL_TYPE_DEPLOYER A Deployer MBean.
static String	CONTROL_TYPE_INSTALL_SERVICE The JBI runtime InstallationService MBean.
static String	CONTROL_TYPE_INSTALLER An Installer MBean.
static String	CONTROL_TYPE_KEY The property name key for the MBean type.
static String	CONTROL_TYPE_LIFECYCLE A Lifecycle MBean.
static String	CONTROL_TYPE_LOGGER A Logger MBean.
static String	CONTROL_TYPE_LOGGING_SERVICE The JBI runtime LoggingService MBean.
static String	CONTROL_TYPE_MESSAGE_SERVICE The JBI runtime MessageService MBean.
static String	CONTROL_TYPE_NOTIFICATION A Notification MBean.
static String	CONTROL_TYPE_STATISTICS A Statistics MBean.
static String	CONTROL_TYPE_SYSTEM A System MBean.
static String	CUSTOM_CONTROL_NAME_KEY CustomControlName is the custom name of a vendor control where ControlType is Custom.
static String	EVENT_MANAGEMENT_MBEAN_NAME The event management forwarder mbean is used to forward event from components and application to interested clients that registered for them
static String	EVENTMANAGEMENT_CONTROLLER_MBEAN_NAME The event management controller mbean is used to configure and manage the event forwarding mbean.
static String	INSTALLED_TYPE_BINDING Installed type for a binding component.
static String	INSTALLED_TYPE_ENGINE Installed type for an engine component.
static String	INSTALLED_TYPE_KEY The type of installation: either Engine or Binding.
static String	INSTANCE_NAME_KEY The Objectname attribute key for the JBI runtime instance name.
static String	LOGGER_NAME_KEY LoggerName is the name of the Logger instance when ControlType is Logger.
static String	SERVICE_NAME_ADMIN_SERVICE The name of the JBI runtime AdminService management service.
static String	SERVICE_NAME_CONFIG_SERVICE The name of the JBI runtime ConfigurationService management service.
static String	SERVICE_NAME_DEPLOY_SERVICE The name of the JBI runtime DeploymentService management service.
static String	SERVICE_NAME_FRAMEWORK The name of the JBI runtime Framework service.
static String	SERVICE_NAME_INSTALL_SERVICE The name of the JBI runtime InstallationService management service.
static String	SERVICE_NAME_JBI The name of the JBI runtime top-level service.
static String	SERVICE_NAME_KEY ServiceName is the name of the service where ComponentType is System.
static String	SERVICE_NAME_LOGGING_SERVICE The name of the JBI runtime LoggingService management service.
static String	SERVICE_NAME_MESSAGE_SERVICE The name of the JBI runtime MessageService service.

Fields inherited from interface javax.jbi.management.MBeanNames

BOOTSTRAP_EXTENSION, COMPONENT_LIFE_CYCLE_EXTENSION

Method Summary

Methods

Modifier and Type	Method and Description
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,CustomControlName=customName,ComponentName=mComponentName,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
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 a specific instance.

Methods inherited from interface javax.jbi.management.MBeanNames

createCustomComponentMBeanName, getJmxDomainName

Field Detail

INSTANCE_NAME_KEY

static final String INSTANCE_NAME_KEY

The Objectname attribute key for the JBI runtime instance name. Value is "JbiName".

See Also:

Constant Field Values

SERVICE_NAME_ADMIN_SERVICE

static final String SERVICE_NAME_ADMIN_SERVICE

The name of the JBI runtime AdminService management service. Value is "AdminService".

See Also:

Constant Field Values

SERVICE_NAME_CONFIG_SERVICE

static final String SERVICE_NAME_CONFIG_SERVICE

The name of the JBI runtime ConfigurationService management service. Value is "ConfigurationService".

See Also:

Constant Field Values

SERVICE_NAME_DEPLOY_SERVICE

static final String SERVICE_NAME_DEPLOY_SERVICE

The name of the JBI runtime DeploymentService management service. Value is "DeploymentService".

See Also:

Constant Field Values

SERVICE_NAME_INSTALL_SERVICE

static final String SERVICE_NAME_INSTALL_SERVICE

The name of the JBI runtime InstallationService management service. Value is "InstallationService".

See Also:

Constant Field Values

SERVICE_NAME_LOGGING_SERVICE

static final String SERVICE_NAME_LOGGING_SERVICE

The name of the JBI runtime LoggingService management service. Value is "LoggingService".

See Also:

Constant Field Values

SERVICE_NAME_MESSAGE_SERVICE

static final String SERVICE_NAME_MESSAGE_SERVICE

The name of the JBI runtime MessageService service. Value is "MessageService".

See Also:

Constant Field Values

SERVICE_NAME_FRAMEWORK

static final String SERVICE_NAME_FRAMEWORK

The name of the JBI runtime Framework service. Value is "Framework".

See Also:

Constant Field Values

SERVICE_NAME_JBI

static final String SERVICE_NAME_JBI

The name of the JBI runtime top-level service. Value is "JBI".

See Also:

Constant Field Values

CONTROL_TYPE_KEY

static final String CONTROL_TYPE_KEY

The property name key for the MBean type. Value is "ControlType".

See Also:

Constant Field Values

CONTROL_TYPE_ADMIN_SERVICE

static final String CONTROL_TYPE_ADMIN_SERVICE

The JBI runtime AdministrationService MBean. Value is "AdministrationService".

See Also:

Constant Field Values

CONTROL_TYPE_CONFIG_SERVICE

static final String CONTROL_TYPE_CONFIG_SERVICE

The JBI runtime ConfigurationService MBean. Value is "ConfigurationService".

See Also:

Constant Field Values

CONTROL_TYPE_DEPLOY_SERVICE

static final String CONTROL_TYPE_DEPLOY_SERVICE

The JBI runtime DeploymentService MBean. Value is "DeploymentService".

See Also:

Constant Field Values

CONTROL_TYPE_INSTALL_SERVICE

static final String CONTROL_TYPE_INSTALL_SERVICE

The JBI runtime InstallationService MBean. Value is "InstallationService".

See Also:

Constant Field Values

CONTROL_TYPE_LOGGING_SERVICE

static final String CONTROL_TYPE_LOGGING_SERVICE

The JBI runtime LoggingService MBean. Value is "LoggingService".

See Also:

Constant Field Values

CONTROL_TYPE_MESSAGE_SERVICE

static final String CONTROL_TYPE_MESSAGE_SERVICE

The JBI runtime MessageService MBean. Value is "MessageService".

See Also:

Constant Field Values

CONTROL_TYPE_LIFECYCLE

static final String CONTROL_TYPE_LIFECYCLE

A Lifecycle MBean. Value is "Lifecycle".

See Also:

Constant Field Values

CONTROL_TYPE_LOGGER

static final String CONTROL_TYPE_LOGGER

A Logger MBean. Value is "Logger".

See Also:

Constant Field Values

CONTROL_TYPE_CONFIGURATION

static final String CONTROL_TYPE_CONFIGURATION

A Configuration MBean. Value is "Configuration".

See Also:

Constant Field Values

CONTROL_TYPE_CONTROLLER

static final String CONTROL_TYPE_CONTROLLER

A Controller MBean. Value is "Controller".

See Also:

Constant Field Values

CONTROL_TYPE_DEPLOYER

static final String CONTROL_TYPE_DEPLOYER

A Deployer MBean. Value is "Deployer".

See Also:

Constant Field Values

CONTROL_TYPE_INSTALLER

static final String CONTROL_TYPE_INSTALLER

An Installer MBean. Value is "Installer".

See Also:

Constant Field Values

CONTROL_TYPE_NOTIFICATION

static final String CONTROL_TYPE_NOTIFICATION

A Notification MBean. Value is "Notification".

See Also:

Constant Field Values

CONTROL_TYPE_STATISTICS

static final String CONTROL_TYPE_STATISTICS

A Statistics MBean. Value is "Statistics".

See Also:

Constant Field Values

CONTROL_TYPE_CUSTOM

static final String CONTROL_TYPE_CUSTOM

A custom vendor-installed MBean. Value is "Custom".

See Also:

Constant Field Values

CONTROL_TYPE_SYSTEM

static final String CONTROL_TYPE_SYSTEM

A System MBean.

See Also:

Constant Field Values

COMPONENT_TYPE_KEY

static final String COMPONENT_TYPE_KEY

The type of component represented by this MBean: either System or Installed Value is "ComponentType".

See Also:

Constant Field Values

COMPONENT_TYPE_SYSTEM

static final String COMPONENT_TYPE_SYSTEM

A schemaorg_apache_xmlbeans.system component MBean. Value is "System".

See Also:

Constant Field Values

COMPONENT_TYPE_INSTALLED

static final String COMPONENT_TYPE_INSTALLED

An Installed component MBean. Value is "Installed".

See Also:

Constant Field Values

INSTALLED_TYPE_KEY

static final String INSTALLED_TYPE_KEY

The type of installation: either Engine or Binding. Value is "InstalledType".

See Also:

Constant Field Values

INSTALLED_TYPE_ENGINE

static final String INSTALLED_TYPE_ENGINE

Installed type for an engine component. Value is "Engine".

See Also:

Constant Field Values

INSTALLED_TYPE_BINDING

static final String INSTALLED_TYPE_BINDING

Installed type for a binding component. Value is "Binding".

See Also:

Constant Field Values

SERVICE_NAME_KEY

static final String SERVICE_NAME_KEY

ServiceName is the name of the service where ComponentType is System. Value is "ServiceName".

See Also:

Constant Field Values

COMPONENT_ID_KEY

static final String COMPONENT_ID_KEY

ComponentName is defined to be the unique name assigned where ComponentType is Installed. Value is "ComponentName".

See Also:

Constant Field Values

LOGGER_NAME_KEY

static final String LOGGER_NAME_KEY

LoggerName is the name of the Logger instance when ControlType is Logger. Value is "LoggerName".

See Also:

Constant Field Values

CUSTOM_CONTROL_NAME_KEY

static final String CUSTOM_CONTROL_NAME_KEY

CustomControlName is the custom name of a vendor control where ControlType is Custom. Value is "CustomControlName".

See Also:

Constant Field Values

EVENT_MANAGEMENT_MBEAN_NAME

static final String EVENT_MANAGEMENT_MBEAN_NAME

The event management forwarder mbean is used to forward event from components and application to interested clients that registered for them

See Also:

Constant Field Values

EVENTMANAGEMENT_CONTROLLER_MBEAN_NAME

static final String EVENTMANAGEMENT_CONTROLLER_MBEAN_NAME

The event management controller mbean is used to configure and manage the event forwarding mbean.

See Also:

Constant Field Values

Method Detail

getBindingMBeanName

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

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

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

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

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

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 a specific instance.

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

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

String getJbiInstanceName()

Return the name of this JBI Framework runtime

Returns:

the instance name of this runtime.

getLocalSystemServiceMBeanName

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

getComponentMBeanName

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

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

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

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 name of the schemaorg_apache_xmlbeans.system service, e.g, InstallationService

serviceType - the type of the schemaorg_apache_xmlbeans.system service, e.g, Installation

target - - administration target

Returns:

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

getCustomComponentMBeanNameFilter

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,CustomControlName=customName,ComponentName=mComponentName,ControlType=Custom,*

Parameters:

instanceName - - target instance name

customName - - target custom control name

componentName - - target component name

Returns:

the ObjectName to be used to filter component registered custom MBeans

getComponentLoggerMBeanNameFilter

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

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.