com.sun.jbi.management

Interface ComponentExtensionMBean

public interface ComponentExtensionMBean

This ComponentExtensionMBean is a facade MBean which provides component specific information such as the ObjectNames of the custom configuration MBeans registered by the component.

Author:

Sun Microsystems, Inc.

Method Summary

Methods

Modifier and Type	Method and Description
ObjectName	getComponentConfigurationFacadeMBeanName(String target) Get the ObjectName of the Component Configuration facade MBean for a target.
Map<String,ObjectName[]>	getCustomMBeanNames(String customName) Get the ObjectNames of all the custom MBeans registered by the component on the target.
Map<String,ObjectName[]>	getLoggerMBeanNames() Get the ObjectNames of all the Logger MBeans registered by the component on the target.

Method Detail

getComponentConfigurationFacadeMBeanName

ObjectName getComponentConfigurationFacadeMBeanName(String target)
                                                    throws JBIException

Get the ObjectName of the Component Configuration facade MBean for a target.

Parameters:

target - - target name

Returns:

the Component Configuration MBean name.

Throws:

JBIException

getCustomMBeanNames

Map<String,ObjectName[]> getCustomMBeanNames(String customName)
                                             throws JBIException

Get the ObjectNames of all the custom MBeans registered by the component on the target. If the target is :

• domain - the return map has all the instances the component is installed on, the corresponding value is the ObjectName(s) of the cutom MBeans registered on the instance.
• server - the return map has a single instance "server", the corresponding value is the ObjectName(s) of the cutom MBeans registered on the instance.
• "instance" - the return map has a single instance "instance", the corresponding value is the ObjectName(s) of the cutom MBeans registered on the instance.
• "cluster" - the return map has all the member instances in the cluster, the corresponding value is the ObjectName(s) of the cutom MBeans registered on the instance.

Parameters:

customName - - the custom control name which will filter the MBeans

Returns:

a Map of the MBeanNames, each map entry is keyed by the instance name and the value is an array of ObjectNames of custom MBeans registered by the component on the instance. Only those MBeans whose ObjectNames have been generated based on MBeanNames.createCustomComponentMBeanName() will be present in the array. If the component does not have any registered MBeans the ObjectName array is empty.

Throws:

JBIException - if some other failure occurs.

getLoggerMBeanNames

Map<String,ObjectName[]> getLoggerMBeanNames()
                                             throws JBIException

Get the ObjectNames of all the Logger MBeans registered by the component on the target. If the target is :

• domain - the return map has all the instances the component is installed on, the corresponding value is the ObjectName(s) of the Logger MBeans registered on the instance.
• server - the return map has a single instance "server", the corresponding value is the ObjectName(s) of the Logger MBeans registered on the instance.
• "instance" - the return map has a single instance "instance", the corresponding value is the ObjectName(s) of the Logger MBeans registered on the instance.
• "cluster" - the return map has all the member instances in the cluster, the corresponding value is the ObjectName(s) of the Logger MBeans registered on the instance.

Returns:

a Map of the MBeanNames, each map entry is keyed by the instance name and the value is an array of ObjectNames of Logger MBeans registered by the component on the instance. Only those MBeans whose ObjectNames have been generated based on MBeanNames.createCustomComponentMBeanName() will be present in the array. If the component does not have any registered MBeans the ObjectName array is empty.

Throws:

JBIException - if some other failure occurs.