com.sun.jbi.management.facade

Class ClusterInstanceComponentConfiguration

java.lang.Object

com.sun.jbi.management.facade.Facade

com.sun.jbi.management.facade.ComponentConfiguration

com.sun.jbi.management.facade.ClusterInstanceComponentConfiguration

All Implemented Interfaces:

ComponentConfiguration, Constants, DynamicMBean

public class ClusterInstanceComponentConfiguration
extends ComponentConfiguration
implements ComponentConfiguration

The ComponentConfiguration is a dynamic facade MBean for component configuration. This MBean provides a facade for managing component static, variable and named configuration. This ComponentExtension MBean is registered for each installation of the component on a target i.e it is target specific.

Author:

Sun Microsystems, Inc.

Nested Class Summary

Nested classes/interfaces inherited from class com.sun.jbi.management.facade.ComponentConfiguration

ComponentConfiguration.ComponentConfigurationResponse

Field Summary

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

mCfgHlpr, mComponentName, mComponentType, mConfigDoc

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

Fields inherited from interface com.sun.jbi.util.Constants

ADMIN_RUNNING_FILE, ADMIN_STOPPED_FILE, CONFIG_NAME_KEY, LOG_LEVEL_DEFAULT, TMP_FOLDER

Constructor Summary

Constructors

Constructor and Description
ClusterInstanceComponentConfiguration(EnvironmentContext ctx, String instanceName, String clusterName, String compName, ComponentType compType) Create an instance of this class.

Method Summary

Methods

Modifier and Type	Method and Description
String	addApplicationConfiguration(String name, CompositeData appConfig) Add an application configuration.
String	addApplicationConfiguration(String name, Properties appCfgProps) Add an application configuration.
String	addApplicationVariable(String name, CompositeData appVar) This operation adds a new application variable.
protected void	attributeCheck(String attributeName) Check if the attribute is valid i.e. the MBeanInfo of the ComponentConfigurationMBean has this attribute.
String	deleteApplicationConfiguration(String name) Delete an application configuration.
String	deleteApplicationVariable(String name) This operation deletes an application variable, if a variable with the specified name does not exist, it's an error.
TabularData	getApplicationConfigurations() Get a Map of all application configurations for the component.
TabularData	getApplicationVariables() Get the Application Variable set for a component.
Object	getAttribute(String attribute) Obtain the value of a specific attribute of the Dynamic MBean.
AttributeList	getAttributes(String[] attributes) Get the values of several attributes of the Dynamic MBean.
protected MBeanInfo	getComponentMBeanInfo() Get the MBeanInfo from the actual component configuration MBean.
MBeanInfo	getMBeanInfo() Provides the exposed attributes and actions of the Dynamic MBean using an MBeanInfo object.
Object	invoke(String actionName, Object[] params, String[] signature) Allows an action to be invoked on the Dynamic MBean.
boolean	isAppConfigSupported() Detect the components support for application configuration.
boolean	isAppVarsSupported() Detect the components support for application variables.
boolean	isComponentConfigSupported() Detect the components support for component configuration.
CompositeType	queryApplicationConfigurationType() Get the CompositeType definition for the components application configuration
String	retrieveConfigurationDisplayData() Retrieves the component configuration metadata.
String	retrieveConfigurationDisplaySchema() Retrieves the component specific configuration schema.
String	setApplicationConfiguration(String name, CompositeData appConfig) Update a application configuration.
String	setApplicationConfiguration(String name, Properties appCfgProps) Set an application configuration.
String	setApplicationVariable(String name, CompositeData appVar) This operation sets an application variable.
void	setAttribute(Attribute attribute) Set the value of a specific attribute of the Dynamic MBean.
AttributeList	setAttributes(AttributeList attributes) Sets the values of several attributes of the Dynamic MBean.
String	setConfigurationAttribute(Attribute attrib) Set a single configuration attribute on a target.
String	setConfigurationAttributes(AttributeList attribList)

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

addApplicationConfigurationToInstance, addApplicationVariableToInstance, applicationConfigurationCompositeIntegrityCheck, applicationConfigurationCompositeIntegrityCheck, applicationConfigurationExistsCheck, applicationConfigurationExistsInstanceCheck, applicationVariableCompositeIntegrityCheck, applicationVariableExistsCheck, applicationVariableExistsInstanceCheck, attribListToString, attributeCheck, attributeCheck, attributeCheck, canListAppConfigCheck, checkAppVarValue, componentStartedOrStoppedOnTargetCheck, createEmptyAppConfigTable, createEmptyAppVarTable, deleteApplicationConfigurationFromInstance, deleteApplicationVariableFromInstance, getApplicationConfigurationsForInstance, getApplicationVariablesForInstance, getAttributeInfo, getConfigDoc, getRemoteInstanceComponentConfigMBeanName, isBoolean, isNumber, merge, setApplicationConfigurationOnInstance, setApplicationVariableOnInstance, setConfigurationAttributeOnInstance, setConfigurationAttributesOnInstance, supportsAppConfigCheck, supportsAppVarsCheck

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

ClusterInstanceComponentConfiguration

public ClusterInstanceComponentConfiguration(EnvironmentContext ctx,
                                     String instanceName,
                                     String clusterName,
                                     String compName,
                                     ComponentType compType)
                                      throws ManagementException

Create an instance of this class.

Parameters:

ctx - - Environment Context

instanceName - - clustered instance name

clusterName - - parent cluster name

compName - - component name

compType - - component type

Throws:

ManagementException

Method Detail

getAttribute

public Object getAttribute(String attribute)
                    throws AttributeNotFoundException,
                           MBeanException,
                           ReflectionException

Obtain the value of a specific attribute of the Dynamic MBean.

Specified by:

getAttribute in interface DynamicMBean

Overrides:

getAttribute in class ComponentConfiguration

Parameters:

attribute - The name of the attribute to be retrieved

Returns:

The value of the attribute retrieved.

Throws:

AttributeNotFoundException - if an attribute is not found

MBeanException - Wraps a java.lang.Exception thrown by the MBean's getter.

ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the getter.

See Also:

setAttribute(javax.management.Attribute)

setAttribute

public void setAttribute(Attribute attribute)
                  throws AttributeNotFoundException,
                         InvalidAttributeValueException,
                         MBeanException,
                         ReflectionException

Set the value of a specific attribute of the Dynamic MBean.

Specified by:

setAttribute in interface DynamicMBean

Overrides:

setAttribute in class ComponentConfiguration

Parameters:

attribute - The identification of the attribute to be set and the value it is to be set to.

Throws:

AttributeNotFoundException

InvalidAttributeValueException

MBeanException - Wraps a java.lang.Exception thrown by the MBean's setter.

ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the MBean's setter.

See Also:

getAttribute(java.lang.String)

invoke

public Object invoke(String actionName,
            Object[] params,
            String[] signature)
              throws MBeanException,
                     ReflectionException

Allows an action to be invoked on the Dynamic MBean.

Specified by:

invoke in interface DynamicMBean

Overrides:

invoke in class ComponentConfiguration

Parameters:

actionName - The name of the action to be invoked.

params - An array containing the parameters to be set when the action is invoked.

signature - An array containing the signature of the action. The class objects will be loaded through the same class loader as the one used for loading the MBean on which the action is invoked.

Returns:

The object returned by the action, which represents the result of invoking the action on the MBean specified.

Throws:

MBeanException - Wraps a java.lang.Exception thrown by the MBean's invoked method.

ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the method

setAttributes

public AttributeList setAttributes(AttributeList attributes)

Sets the values of several attributes of the Dynamic MBean.

Specified by:

setAttributes in interface DynamicMBean

Overrides:

setAttributes in class ComponentConfiguration

Parameters:

attributes - A list of attributes: The identification of the attributes to be set and the values they are to be set to.

Returns:

The list of attributes that were set, with their new values.

See Also:

getAttributes(java.lang.String[])

getMBeanInfo

public MBeanInfo getMBeanInfo()

Provides the exposed attributes and actions of the Dynamic MBean using an MBeanInfo object.

Specified by:

getMBeanInfo in interface DynamicMBean

Overrides:

getMBeanInfo in class ComponentConfiguration

Returns:

An instance of MBeanInfo allowing all attributes and actions exposed by this Dynamic MBean to be retrieved.

getAttributes

public AttributeList getAttributes(String[] attributes)

Get the values of several attributes of the Dynamic MBean.

Specified by:

getAttributes in interface DynamicMBean

Overrides:

getAttributes in class ComponentConfiguration

Parameters:

attributes - A list of the attributes to be retrieved.

Returns:

The list of attributes retrieved.

See Also:

setAttributes(javax.management.AttributeList)

setConfigurationAttribute

public String setConfigurationAttribute(Attribute attrib)
                                 throws JBIException

Set a single configuration attribute on a target.

Overrides:

setConfigurationAttribute in class ComponentConfiguration

Parameters:

attrib - - the configuration attribute to be set.

Returns:

a management message string with the status of the operation.

Throws:

JBIException - on errors

setConfigurationAttributes

public String setConfigurationAttributes(AttributeList attribList)
                                  throws JBIException

Overrides:

setConfigurationAttributes in class ComponentConfiguration

Parameters:

attribList - List of configuration attributes to set

Returns:

updated attribute list

Throws:

JBIException - on errors

isAppVarsSupported

public boolean isAppVarsSupported()
                           throws MBeanException

Detect the components support for application variables. This method returns true if the component has a configuration MBean and implements all the operations for application variable management.

Specified by:

isAppVarsSupported in interface ComponentConfiguration

Overrides:

isAppVarsSupported in class ComponentConfiguration

Returns:

true if the components configuration MBean implements all the operations for application variables.

Throws:

MBeanException - if the component is not installed or is not in the Started state.

addApplicationVariable

public String addApplicationVariable(String name,
                            CompositeData appVar)
                              throws MBeanException

This operation adds a new application variable. If a variable already exists with the same name as that specified then the operation fails.

Specified by:

addApplicationVariable in interface ComponentConfiguration

Overrides:

addApplicationVariable in class ComponentConfiguration

Parameters:

name - - name of the application variable

appVar - - this is the application variable compoiste

Returns:

management message string which gives the status of the operation. For target=cluster, instance specific details are included.

Throws:

MBeanException - if an error occurs in adding the application variables to the component.

setApplicationVariable

public String setApplicationVariable(String name,
                            CompositeData appVar)
                              throws MBeanException

This operation sets an application variable. If a variable does not exist with the same name, its an error.

Specified by:

setApplicationVariable in interface ComponentConfiguration

Overrides:

setApplicationVariable in class ComponentConfiguration

Parameters:

name - - name of the application variable

appVar - - this is the application variable compoiste to be updated.

Returns:

management message string which gives the status of the operation. For target=cluster, instance specific details are included.

Throws:

MBeanException - if one or more application variables cannot be deleted

deleteApplicationVariable

public String deleteApplicationVariable(String name)
                                 throws MBeanException

This operation deletes an application variable, if a variable with the specified name does not exist, it's an error.

Specified by:

deleteApplicationVariable in interface ComponentConfiguration

Overrides:

deleteApplicationVariable in class ComponentConfiguration

Parameters:

name - - name of the application variable

Returns:

management message string which gives the status of the operation. For target=cluster, instance specific details are included.

Throws:

MBeanException - on errors.

getApplicationVariables

public TabularData getApplicationVariables()

Get the Application Variable set for a component.

Specified by:

getApplicationVariables in interface ComponentConfiguration

Overrides:

getApplicationVariables in class ComponentConfiguration

Returns:

a TabularData which has all the applicationvariables set on the component.

isComponentConfigSupported

public boolean isComponentConfigSupported()
                                   throws MBeanException

Detect the components support for component configuration. This method returns true if the component has a configuration MBean with configurable attributes.

Specified by:

isComponentConfigSupported in interface ComponentConfiguration

Overrides:

isComponentConfigSupported in class ComponentConfiguration

Returns:

true if the components configuration MBean has configurable attributes.

Throws:

MBeanException - if the component is not installed or is not in the Started state.

isAppConfigSupported

public boolean isAppConfigSupported()
                             throws MBeanException

Detect the components support for application configuration. This method returns true if the component has a configuration MBean and implements all the operations for application configuration management.

Specified by:

isAppConfigSupported in interface ComponentConfiguration

Overrides:

isAppConfigSupported in class ComponentConfiguration

Returns:

true if the components configuration MBean implements all the operations for application configuration.

Throws:

MBeanException - if the component is not installed or is not in the Started state.

queryApplicationConfigurationType

public CompositeType queryApplicationConfigurationType()

Get the CompositeType definition for the components application configuration

Specified by:

queryApplicationConfigurationType in interface ComponentConfiguration

Overrides:

queryApplicationConfigurationType in class ComponentConfiguration

Returns:

the CompositeType for the components application configuration.

addApplicationConfiguration

public String addApplicationConfiguration(String name,
                                 Properties appCfgProps)
                                   throws MBeanException

Add an application configuration. The configuration name is a part of the CompositeData. The itemName for the configuration name is "configurationName" and the type is SimpleType.STRING

Specified by:

addApplicationConfiguration in interface ComponentConfiguration

Overrides:

addApplicationConfiguration in class ComponentConfiguration

Parameters:

name - - configuration name, must match the value of the field "name" in the namedConfig

appCfgProps - - application configuration properties

Returns:

management message string which gives the status of the operation. For target=cluster, instance specific details are included.

Throws:

MBeanException - if the application configuration cannot be added.

addApplicationConfiguration

public String addApplicationConfiguration(String name,
                                 CompositeData appConfig)
                                   throws MBeanException

Add an application configuration. The configuration name is a part of the CompositeData. The itemName for the configuration name is "configurationName" and the type is SimpleType.STRING

Specified by:

addApplicationConfiguration in interface ComponentConfiguration

Overrides:

addApplicationConfiguration in class ComponentConfiguration

Parameters:

name - - configuration name, must match the value of the field "name" in the namedConfig

appConfig - - application configuration composite

Returns:

management message string which gives the status of the operation. For target=cluster, instance specific details are included.

Throws:

MBeanException - if the application configuration cannot be added.

deleteApplicationConfiguration

public String deleteApplicationConfiguration(String name)
                                      throws MBeanException

Delete an application configuration.

Specified by:

deleteApplicationConfiguration in interface ComponentConfiguration

Overrides:

deleteApplicationConfiguration in class ComponentConfiguration

Parameters:

name - - identification of the application configuration to be deleted

Returns:

management message string which gives the status of the operation. For target=cluster, instance specific details are included.

Throws:

MBeanException - if the configuration cannot be deleted.

setApplicationConfiguration

public String setApplicationConfiguration(String name,
                                 Properties appCfgProps)
                                   throws MBeanException

Set an application configuration. The configuration name is a part of the CompositeData. The itemName for the configuration name is "configurationName" and the type is SimpleType.STRING

Specified by:

setApplicationConfiguration in interface ComponentConfiguration

Overrides:

setApplicationConfiguration in class ComponentConfiguration

Parameters:

name - - configuration name, must match the value of the field "name" in the namedConfig

appCfgProps - - application configuration properties

Returns:

management message string which gives the status of the operation. For target=cluster, instance specific details are included.

Throws:

MBeanException - if the application configuration cannot be set.

setApplicationConfiguration

public String setApplicationConfiguration(String name,
                                 CompositeData appConfig)
                                   throws MBeanException

Update a application configuration. The configuration name is a part of the CompositeData. The itemName for the configuration name is "configurationName" and the type is SimpleType.STRING

Specified by:

setApplicationConfiguration in interface ComponentConfiguration

Overrides:

setApplicationConfiguration in class ComponentConfiguration

Parameters:

name - - configuration name, must match the value of the field "configurationName" in the appConfig

appConfig - - application configuration composite

Returns:

management message string which gives the status of the operation. For target=cluster, instance specific details are included.

Throws:

MBeanException - if there are errors encountered when updating the configuration.

getApplicationConfigurations

public TabularData getApplicationConfigurations()

Get a Map of all application configurations for the component.

Specified by:

getApplicationConfigurations in interface ComponentConfiguration

Overrides:

getApplicationConfigurations in class ComponentConfiguration

Returns:

a TabularData of all the application configurations for a component keyed by the configuration name.

retrieveConfigurationDisplaySchema

public String retrieveConfigurationDisplaySchema()
                                          throws MBeanException

Retrieves the component specific configuration schema.

Specified by:

retrieveConfigurationDisplaySchema in interface ComponentConfiguration

Overrides:

retrieveConfigurationDisplaySchema in class ComponentConfiguration

Returns:

a String containing the configuration schema.

Throws:

MBeanException - on errors

retrieveConfigurationDisplayData

public String retrieveConfigurationDisplayData()
                                        throws MBeanException

Retrieves the component configuration metadata. The XML data conforms to the component configuration schema.

Specified by:

retrieveConfigurationDisplayData in interface ComponentConfiguration

Overrides:

retrieveConfigurationDisplayData in class ComponentConfiguration

Returns:

a String containing the configuration metadata.

Throws:

MBeanException - on errors

getComponentMBeanInfo

protected MBeanInfo getComponentMBeanInfo()

Get the MBeanInfo from the actual component configuration MBean. If the component is off-line, this information is not available and a blank MBeanInfo is returned. If the component does not have a configuration MBean then a empty MBeanInfo is returned.

Overrides:

getComponentMBeanInfo in class ComponentConfiguration

attributeCheck

protected void attributeCheck(String attributeName)
                       throws JBIException

Check if the attribute is valid i.e. the MBeanInfo of the ComponentConfigurationMBean has this attribute.

Overrides:

attributeCheck in class ComponentConfiguration

Parameters:

attribute - - the attribute to be checked

Throws:

JBIException - if the provided attribute is not present in the AttributeInfo