com.sun.jbi.management.facade

Class ComponentConfiguration

java.lang.Object

com.sun.jbi.management.facade.Facade

com.sun.jbi.management.facade.ComponentConfiguration

All Implemented Interfaces:

ComponentConfiguration, Constants, DynamicMBean

Direct Known Subclasses:

ClusterInstanceComponentConfiguration

public class ComponentConfiguration
extends Facade
implements ComponentConfiguration, Constants

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

Modifier and Type	Class and Description
protected class	ComponentConfiguration.ComponentConfigurationResponse The component configuration response for a target has two pieces of information The attributes which were set successfully A management XML message with details

Field Summary

Fields

Modifier and Type	Field and Description
protected ComponentConfigurationHelper	mCfgHlpr Component Configuration Helper
protected String	mComponentName The component name
protected ComponentType	mComponentType Component Type : BINDING / ENGINE ?
protected Document	mConfigDoc Configuration meta-data

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
ComponentConfiguration(EnvironmentContext ctx, String target, String compName, ComponentType compType)

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.
protected String	addApplicationConfigurationToInstance(String name, CompositeData appCfg, String instanceName) If the instance is running, add the application config
String	addApplicationVariable(String name, CompositeData appVar) This operation adds a new application variable.
protected String	addApplicationVariableToInstance(String name, CompositeData appVar, String instanceName) If the instance is running, set the attribute on the component configuration MBean.
protected void	applicationConfigurationCompositeIntegrityCheck(String name, CompositeData appConfig, boolean isUpdate) Check if the configurationName key exists and matches the name passed in.
protected void	applicationConfigurationCompositeIntegrityCheck(String name, Properties appCfgProps, boolean isUpdate) Check if the configurationName key exists and matches the name passed in.
protected void	applicationConfigurationExistsCheck(String configName, boolean throwIfMissing) Check if the application configuration by the name is already defined.
protected boolean	applicationConfigurationExistsInstanceCheck(String configName, String instance) Check if the application configuration by the name is already defined.
protected void	applicationVariableCompositeIntegrityCheck(String name, String type, CompositeData appVar, boolean isUpdate) Check if the name string matches the application variable name
protected String	applicationVariableExistsCheck(String name, boolean shouldExist) Check for the existance of an application variable.
protected boolean	applicationVariableExistsInstanceCheck(String name, String instance) Check for the existance of an application variable.
protected String	attribListToString(AttributeList attribList) Convert attribute list to a String value
protected void	attributeCheck(Attribute attribute) Check if the attribute is valid i.e. the MBeanInfo of the ComponentConfigurationMBean has these attributes and the values are of the same type.
protected void	attributeCheck(AttributeList attributeList) Check if all the attributes in the attribute list are valid i.e. the MBeanInfo of the ComponentConfigurationMBean has these attributes and the values are of the same type
protected void	attributeCheck(String attributeName) Check if the attribute is valid i.e. the MBeanInfo of the ComponentConfigurationMBean has this attribute.
protected void	attributeCheck(String[] attributeList) Check if all the attributes in the list are valid i.e. the MBeanInfo of the ComponentConfigurationMBean has these attributes
protected void	canListAppConfigCheck() Check if the component is started on the target, if it is not then a exception is thrown.
protected void	checkAppVarValue(String name, String type, String value) Ensures that values of BOOLEAN application variable types are either "true" or "false", and value of NUMBER types is a number
protected void	componentStartedOrStoppedOnTargetCheck() Check if the component is started or stopped on the target, if it is not then a exception is thrown.
protected TabularData	createEmptyAppConfigTable()
protected TabularData	createEmptyAppVarTable()
String	deleteApplicationConfiguration(String name) Delete an application configuration.
protected String	deleteApplicationConfigurationFromInstance(String name, String instanceName) If the instance is running, delete the application config
String	deleteApplicationVariable(String name) This operation deletes an application variable, if a variable with the specified name does not exist, it's an error.
protected String	deleteApplicationVariableFromInstance(String name, String instanceName) If the instance is running, delete the application variable from the component configuration MBean.
TabularData	getApplicationConfigurations() Get a Map of all application configurations for the component.
TabularData	getApplicationConfigurationsForInstance(String instance) Get a Map of all application configurations for the component on a instance.
TabularData	getApplicationVariables() Get the Application Variable set for a component.
TabularData	getApplicationVariablesForInstance(String instance) Get the Application Variable set for a component.
Object	getAttribute(String attribute) Obtain the value of a specific attribute of the Dynamic MBean.
protected MBeanAttributeInfo	getAttributeInfo(String attribute)
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.
protected Document	getConfigDoc()
MBeanInfo	getMBeanInfo() Provides the exposed attributes and actions of the Dynamic MBean using an MBeanInfo object.
protected ObjectName	getRemoteInstanceComponentConfigMBeanName(String instanceName) Get the name of the instance Configuration MBean.
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.
protected boolean	isBoolean(String str)
boolean	isComponentConfigSupported() Detect the components support for component configuration.
protected boolean	isNumber(String str)
protected MBeanOperationInfo[]	merge(MBeanOperationInfo[] a1, MBeanOperationInfo[] a2) Merge two MBeanOperationInfo arrays.
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.
protected String	setApplicationConfigurationOnInstance(String name, CompositeData appCfg, String instanceName) If the instance is running, set the application config
String	setApplicationVariable(String name, CompositeData appVar) This operation sets an application variable.
protected String	setApplicationVariableOnInstance(String name, CompositeData appVar, String instanceName) If the instance is running, set the application variable component configuration MBean.
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.
protected String	setConfigurationAttributeOnInstance(Attribute attrib, String instanceName) If the instance is running, set the attribute on the component configuration MBean.
String	setConfigurationAttributes(AttributeList attribList)
protected ComponentConfiguration.ComponentConfigurationResponse	setConfigurationAttributesOnInstance(AttributeList attribList, String instanceName) If the instance is running, set the attributes on the instance component configuration action MBean.
protected void	supportsAppConfigCheck() Check if the component supports application configuration.
protected void	supportsAppVarsCheck() Check if the component supports application variables.

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

Field Detail

mComponentName

protected String mComponentName

The component name

mComponentType

protected ComponentType mComponentType

Component Type : BINDING / ENGINE ?

mCfgHlpr

protected ComponentConfigurationHelper mCfgHlpr

Component Configuration Helper

mConfigDoc

protected Document mConfigDoc

Configuration meta-data

Constructor Detail

ComponentConfiguration

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

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

Parameters:

attribute - The name of the attribute to be retrieved

Returns:

The value of the attribute retrieved.

Throws:

AttributeNotFoundException

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

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

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

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

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

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.

Parameters:

attrib - - the configuration attribute to be set.

Returns:

a management message string with the status of the operation.

Throws:

JBIException

setConfigurationAttributes

public String setConfigurationAttributes(AttributeList attribList)
                                  throws JBIException

Throws:

JBIException

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

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

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

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

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

Returns:

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

getApplicationVariablesForInstance

public TabularData getApplicationVariablesForInstance(String instance)

Get the Application Variable set for a component.

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 configuration attributes.

Specified by:

isComponentConfigSupported in interface ComponentConfiguration

Returns:

true if the components configuration MBean has configuration 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

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

Returns:

the CompositeType for the components application configuration. If the target is not up a null value is returned.

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

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

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

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

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

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

Returns:

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

getApplicationConfigurationsForInstance

public TabularData getApplicationConfigurationsForInstance(String instance)

Get a Map of all application configurations for the component on a instance.

Parameters:

instance - the instance to check

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

Returns:

a String containing the configuration schema.

Throws:

MBeanException

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

Returns:

a String containing the configuration metadata.

Throws:

MBeanException

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.

getRemoteInstanceComponentConfigMBeanName

protected ObjectName getRemoteInstanceComponentConfigMBeanName(String instanceName)

Get the name of the instance Configuration MBean. This is the MBean registered by the ComponentFramework on behalf of the Component. This MBean is the action MBean for configuration on the instance. This MBean propagates the configuration calls to the actual configuration MBean registered by the component.

Parameters:

instanceName - - instance name

Returns:

the JMX ObjectName of the instance's Component Configuration MBean

setConfigurationAttributeOnInstance

protected String setConfigurationAttributeOnInstance(Attribute attrib,
                                         String instanceName)
                                              throws ManagementException

If the instance is running, set the attribute on the component configuration MBean.

Parameters:

attrib - - management attribute to set

instanceName - - instance name

Throws:

ManagementException

setConfigurationAttributesOnInstance

protected ComponentConfiguration.ComponentConfigurationResponse setConfigurationAttributesOnInstance(AttributeList attribList,
                                                                                         String instanceName)
                                                                                              throws ManagementException

If the instance is running, set the attributes on the instance component configuration action MBean.

Parameters:

attribList - - management attribute to set

instanceName - - instance name

Throws:

ManagementException

merge

protected MBeanOperationInfo[] merge(MBeanOperationInfo[] a1,
                         MBeanOperationInfo[] a2)

Merge two MBeanOperationInfo arrays.

Parameters:

array1 - -

array2 -

Returns:

an array containing the OperationInfos from both the arrays.

componentStartedOrStoppedOnTargetCheck

protected void componentStartedOrStoppedOnTargetCheck()
                                               throws JBIException

Check if the component is started or stopped on the target, if it is not then a exception is thrown. The component state persisted in the registry is used to determine if the component is started.

Throws:

JBIException - if the component is not started or stopped on the target.

canListAppConfigCheck

protected void canListAppConfigCheck()
                              throws JBIException

Check if the component is started on the target, if it is not then a exception is thrown. The component state persisted in the registry is used to determine if the component is started.

Throws:

JBIException - if the component is not started on the target, indicating one cannot list application configuration.

attributeCheck

protected void attributeCheck(AttributeList attributeList)
                       throws JBIException

Check if all the attributes in the attribute list are valid i.e. the MBeanInfo of the ComponentConfigurationMBean has these attributes and the values are of the same type

Parameters:

attributeList - - list of attributes

Throws:

JBIException - if a attribute value is not of the type expected or if the provided attributeList has an attribute which is not present in the AttributeInfo

attributeCheck

protected void attributeCheck(Attribute attribute)
                       throws JBIException

Check if the attribute is valid i.e. the MBeanInfo of the ComponentConfigurationMBean has these attributes and the values are of the same type.

Parameters:

attribute - - the attribute to be checked

Throws:

JBIException - if the attribute value is not of the type expected or if the provided attribute is not present in the AttributeInfo

attributeCheck

protected void attributeCheck(String[] attributeList)
                       throws JBIException

Check if all the attributes in the list are valid i.e. the MBeanInfo of the ComponentConfigurationMBean has these attributes

Parameters:

attributeList - - list of attribute names

Throws:

JBIException - if the provided attributeList has an attribute which is not present in the AttributeInfo

attributeCheck

protected void attributeCheck(String attributeName)
                       throws JBIException

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

Parameters:

attribute - - the attribute to be checked

Throws:

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

getAttributeInfo

protected MBeanAttributeInfo getAttributeInfo(String attribute)

Parameters:

attribName - - identification of the attribute

Returns:

the MBeanAttributeInfo for the specified attribute

applicationVariableExistsCheck

protected String applicationVariableExistsCheck(String name,
                                    boolean shouldExist)
                                         throws JBIException

Check for the existance of an application variable.

Throws:

JBIException

applicationVariableExistsInstanceCheck

protected boolean applicationVariableExistsInstanceCheck(String name,
                                             String instance)

Check for the existance of an application variable.

applicationVariableCompositeIntegrityCheck

protected void applicationVariableCompositeIntegrityCheck(String name,
                                              String type,
                                              CompositeData appVar,
                                              boolean isUpdate)
                                                   throws JBIException

Check if the name string matches the application variable name

Parameters:

name - - application variable should have the same name

type - - existing application variable type, if app var exists, null other wise.

appVar - - application variable compoiste to check

Throws:

JBIException

addApplicationVariableToInstance

protected String addApplicationVariableToInstance(String name,
                                      CompositeData appVar,
                                      String instanceName)
                                           throws ManagementException

If the instance is running, set the attribute on the component configuration MBean.

Parameters:

instanceName - - server name

name - - name of the application variable

appvar - - the application variable being set

Throws:

ManagementException

setApplicationVariableOnInstance

protected String setApplicationVariableOnInstance(String name,
                                      CompositeData appVar,
                                      String instanceName)
                                           throws ManagementException

If the instance is running, set the application variable component configuration MBean.

Parameters:

instanceName - - server name

name - - name of the application variable

appvar - - the application variable being set

Throws:

ManagementException

deleteApplicationVariableFromInstance

protected String deleteApplicationVariableFromInstance(String name,
                                           String instanceName)
                                                throws ManagementException

If the instance is running, delete the application variable from the component configuration MBean.

Parameters:

instanceName - - server name

name - - name of the application variable

appvar - - the application variable being set

Throws:

ManagementException

applicationConfigurationCompositeIntegrityCheck

protected void applicationConfigurationCompositeIntegrityCheck(String name,
                                                   CompositeData appConfig,
                                                   boolean isUpdate)
                                                        throws JBIException

Check if the configurationName key exists and matches the name passed in.

Parameters:

name - - application configuration should have the same name

appConfig - - application configuration compoiste to check

isUpdate - - true when this method is invoked when a config is being updated.

Throws:

JBIException

applicationConfigurationCompositeIntegrityCheck

protected void applicationConfigurationCompositeIntegrityCheck(String name,
                                                   Properties appCfgProps,
                                                   boolean isUpdate)
                                                        throws JBIException

Check if the configurationName key exists and matches the name passed in.

Parameters:

name - - application configuration should have the same name

appCfgProps - - application configuration properties to check

isUpdate - - true when this method is invoked when a config is being updated.

Throws:

JBIException

addApplicationConfigurationToInstance

protected String addApplicationConfigurationToInstance(String name,
                                           CompositeData appCfg,
                                           String instanceName)
                                                throws ManagementException

If the instance is running, add the application config

Parameters:

instanceName - - server name

name - - name of the application configuration

appCfg - - the application config being set

Throws:

ManagementException

setApplicationConfigurationOnInstance

protected String setApplicationConfigurationOnInstance(String name,
                                           CompositeData appCfg,
                                           String instanceName)
                                                throws ManagementException

If the instance is running, set the application config

Parameters:

instanceName - - server name

name - - name of the application configuration

appCfg - - the application config being set

Throws:

ManagementException

deleteApplicationConfigurationFromInstance

protected String deleteApplicationConfigurationFromInstance(String name,
                                                String instanceName)
                                                     throws ManagementException

If the instance is running, delete the application config

Parameters:

instanceName - - server name

name - - name of the application configuration

appCfg - - the application config being set

Throws:

ManagementException

applicationConfigurationExistsCheck

protected void applicationConfigurationExistsCheck(String configName,
                                       boolean throwIfMissing)
                                            throws JBIException

Check if the application configuration by the name is already defined. If the "throwIfMissing" flag is set to true and exception is thrown if the configuration is not defined, if this is false and exception is thrown if the configuration is defined.

Parameters:

configName - application configuration name

throwIfMissing - boolean flag if set to true anexception is thrown if the configuration is not defined, if this is false an exception is thrown if the configuration is defined.

Throws:

JBIException

applicationConfigurationExistsInstanceCheck

protected boolean applicationConfigurationExistsInstanceCheck(String configName,
                                                  String instance)

Check if the application configuration by the name is already defined. If the "throwIfMissing" flag is set to true and exception is thrown if the configuration is not defined, if this is false and exception is thrown if the configuration is defined.

Parameters:

configName - application configuration name

supportsAppVarsCheck

protected void supportsAppVarsCheck()
                             throws JBIException,
                                    MBeanException

Check if the component supports application variables. If it does not then an exception is thrown indicating that the component does not support application variables.

Throws:

JBIException - if the component does not support application variables

MBeanException

supportsAppConfigCheck

protected void supportsAppConfigCheck()
                               throws JBIException,
                                      MBeanException

Check if the component supports application configuration. If it does not then an exception is thrown indicating that the component does not support application configuration.

Throws:

JBIException - if the component does not support application configuration

MBeanException

createEmptyAppConfigTable

protected TabularData createEmptyAppConfigTable()
                                         throws OpenDataException

Throws:

OpenDataException

createEmptyAppVarTable

protected TabularData createEmptyAppVarTable()
                                      throws OpenDataException

Throws:

OpenDataException

getConfigDoc

protected Document getConfigDoc()
                         throws ManagementException

Throws:

ManagementException

attribListToString

protected String attribListToString(AttributeList attribList)

Convert attribute list to a String value

Parameters:

attribList - the AttributeList to be converted

Returns:

the list as string [ attribName, ..]

checkAppVarValue

protected void checkAppVarValue(String name,
                    String type,
                    String value)
                         throws JBIException

Ensures that values of BOOLEAN application variable types are either "true" or "false", and value of NUMBER types is a number

Parameters:

type -

value -

Throws:

JBIException

isNumber

protected boolean isNumber(String str)

Returns:

true if the value passed in is a number ( ex. 99, 99.99, +99, -99, 99.0 ) false otherwise

isBoolean

protected boolean isBoolean(String str)

Returns:

false if the passed in string is not a boolean string