com.sun.jbi.management.facade

Class ComponentExtension

java.lang.Object

com.sun.jbi.management.facade.Facade

com.sun.jbi.management.facade.ComponentExtension

All Implemented Interfaces:

ComponentExtensionMBean

public class ComponentExtension
extends Facade
implements 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. This ComponentExtension MBean is registered for each installation of the component on a target i.e it is target specific.

Author:

Sun Microsystems, Inc.

Field Summary

Fields inherited from class com.sun.jbi.management.facade.Facade

CONFIG_SCHEMA_PATH, DOMAIN, MASKED_FIELD_VALUE, mComponentConfigSchema, mEnvCtx, mLog, mMBeanNames, mMBeanSvr, mMgtCtx, mMsgBuilder, mPlatform, mTarget, mTranslator, PASSWORD, SERVER, sTypeMap, WORKSPACE_ROOT

Constructor Summary

Constructors

Constructor and Description
ComponentExtension(EnvironmentContext ctx, String target, String compName, ComponentType compType)

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.

Methods inherited from class com.sun.jbi.management.facade.Facade

archiveEqualityCheck, areAllInstancesUp, componentInstallationCheck, convertToString, fromFileURL, getAllTargets, getComponentConfigurationData, getComponentConfigurationNS, getComponentConfigurationSchema, getComponentLifeCycleMBeanName, getComponentQuery, getComponentQuery, getComponentState, getComponentStateOnInstance, getComponentType, getFacadeInstallerMBeanName, getFacadeInstallerMBeanName, getGenericQuery, getMBeanServerConnection, getRegistry, getRemoteAdminServiceObjectName, getRemoteAttribute, getRemoteAttributes, getServiceAssemblyQuery, getUpdater, handleClusteredInstanceFailures, initPrimitiveTypeMap, instanceRunningCheck, invokeLocalOperation, invokeRemoteOperation, invokeRemoteVoidOperation, isComponentInstalled, isInstanceRunning, isMBeanRegisteredOnInstance, isSharedLibraryInstalled, isTargetUp, mbeanRegistrationCheck, setRemoteAttribute, setRemoteAttributes, sharedLibraryInstallationCheck, throwNotSupportedManagementException, toFileURL, unregisterComponentConfigurationMBean, unregisterComponentConfigurationMBean, unregisterComponentExtensionMBean, unregisterComponentExtensionMBean, unregisterComponentLifeCycleMBean, unregisterComponentLifeCycleMBean, uploadFile, validateArchive

Methods inherited from class java.lang.Object

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

Constructor Detail

ComponentExtension

public ComponentExtension(EnvironmentContext ctx,
                  String target,
                  String compName,
                  ComponentType compType)
                   throws ManagementException

Throws:

ManagementException

Method Detail

getComponentConfigurationFacadeMBeanName

public ObjectName getComponentConfigurationFacadeMBeanName(String target)
                                                    throws JBIException

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

Specified by:

getComponentConfigurationFacadeMBeanName in interface ComponentExtensionMBean

Parameters:

target - - target name

Returns:

the Component Configuration MBean name.

Throws:

JBIException

getCustomMBeanNames

public 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.

Specified by:

getCustomMBeanNames in interface ComponentExtensionMBean

Parameters:

customName - - custom control name

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.

See Also:

javax.jbi.management.MBeanNames#createCustomComponentMBeanName()

getLoggerMBeanNames

public 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.

Specified by:

getLoggerMBeanNames in interface ComponentExtensionMBean

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.