| java.lang.Object
 com.sun.jbi.framework.ComponentConfiguration
| ComponentConfiguration | | public class ComponentConfiguration implements com.sun.jbi.management.ComponentConfiguration(Code) | | 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. |
| Method Summary | |
| public String | addApplicationConfiguration(String name, Properties appCfgProps)
Add an application configuration. | | public String | addApplicationConfiguration(String name, CompositeData appConfig)
Add an application configuration. | | public String | addApplicationVariable(String name, CompositeData appVar)
This operation adds a new application variable. | | public String | deleteApplicationConfiguration(String name)
Delete an application configuration. | | public String | deleteApplicationVariable(String name)
This operation deletes an application variable, if a variable with the specified name does
not exist, it's an error.
Parameters:
name - - name of the application variable
throws:
MBeanException - on errors. | | public TabularData | getApplicationConfigurations()
Get a Map of all application configurations for the component.
a TabularData of all the application configurations for a component keyed by the configuration name. | | public TabularData | getApplicationVariables()
Get the Application Variable set for a component.
a TabularData which has all the applicationvariables set on the component. | | public Object | getAttribute(String attribute)
Obtain the value of a specific attribute of the Dynamic MBean. | | protected MBeanAttributeInfo | getAttributeInfo(String attribute)
| | public AttributeList | getAttributes(String[] attributes)
Get the values of several attributes of the Dynamic MBean.
Parameters:
attributes - A list of the attributes to be retrieved. | | protected String | getComponentConfigurationData(String compName)
Get the the "Configuration" element in the jbi.xml. | | protected String | getComponentConfigurationNS(String compName)
Get the namespace of the "Configuration" element in the jbi.xml, if one
exists. | | public MBeanInfo | getMBeanInfo()
Provides the exposed attributes and actions of the Dynamic MBean using
an MBeanInfo object. | | public Object | invoke(String actionName, Object[] params, String[] signature)
Allows an action to be invoked on the Dynamic MBean.
Parameters:
actionName - The name of the action to be invoked.
Parameters:
params - An array containing the parameters to be set when the action is invoked.
Parameters:
signature - An array containing the signature of the action. | | public boolean | isAppConfigSupported()
Detect the components support for application configuration. | | public boolean | isAppVarsSupported()
Detect the components support for application variables. | | public boolean | isComponentConfigSupported()
Detect the components support for component configuration. | | public CompositeType | queryApplicationConfigurationType()
| | public String | retrieveConfigurationDisplayData()
Retrieves the component configuration metadata. | | public String | retrieveConfigurationDisplaySchema()
Retrieves the component specific configuration schema. | | public String | setApplicationConfiguration(String name, Properties appCfgProps)
Update a application configuration. | | public String | setApplicationConfiguration(String name, CompositeData appConfig)
Update a application configuration. | | public String | setApplicationVariable(String name, CompositeData appVar)
This operation sets an application variable. | | public void | setAttribute(Attribute attribute)
Set the value of a specific attribute of the Dynamic MBean. | | public AttributeList | setAttributes(AttributeList attributes)
Sets the values of several attributes of the Dynamic MBean.
Parameters:
attributes - A list of attributes: The identification of theattributes to be set and the values they are to be set to. | | public String | setConfigurationAttribute(Attribute attrib)
Set a single configuration attribute on a target.
Parameters:
attrib - - the configuration attribute to be set. | | public String | setConfigurationAttributes(AttributeList attribList)
|
| addApplicationConfiguration | | public String addApplicationConfiguration(String name, Properties appCfgProps) throws MBeanException(Code) | | 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
Parameters:
name - - configuration name, must match the value of the field "name" in the namedConfig
Parameters:
appCfgProps - - application configuration properties
throws:
MBeanException - if the application configuration cannot be added. management message string which gives the status of the operation. For target=cluster, instance specific details are included. |
| addApplicationConfiguration | | public String addApplicationConfiguration(String name, CompositeData appConfig) throws MBeanException(Code) | | 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
Parameters:
name - - configuration name, must match the value of the field "name" in the namedConfig
Parameters:
appConfig - - application configuration composite
throws:
MBeanException - if the application configuration cannot be added. management message string which gives the status of the operation. For target=cluster, instance specific details are included. |
| addApplicationVariable | | public String addApplicationVariable(String name, CompositeData appVar) throws MBeanException(Code) | | This operation adds a new application variable. If a variable already exists with
the same name as that specified then the operation fails.
Parameters:
name - - name of the application variable
Parameters:
appVar - - this is the application variable compoiste
throws:
MBeanException - if an error occurs in adding the application variables to the component. management message string which gives the status of the operation. For target=cluster, instance specific details are included. |
| deleteApplicationConfiguration | | public String deleteApplicationConfiguration(String name) throws MBeanException(Code) | | Delete an application configuration.
Parameters:
name - - identification of the application configuration to be deleted
throws:
MBeanException - if the configuration cannot be deleted. management message string which gives the status of the operation. For target=cluster, instance specific details are included. |
| deleteApplicationVariable | | public String deleteApplicationVariable(String name) throws MBeanException(Code) | | This operation deletes an application variable, if a variable with the specified name does
not exist, it's an error.
Parameters:
name - - name of the application variable
throws:
MBeanException - on errors. management message string which gives the status of the operation. For target=cluster, instance specific details are included. |
| getApplicationConfigurations | | public TabularData getApplicationConfigurations()(Code) | | Get a Map of all application configurations for the component.
a TabularData of all the application configurations for a component keyed by the configuration name. |
| getApplicationVariables | | public TabularData getApplicationVariables()(Code) | | Get the Application Variable set for a component.
a TabularData which has all the applicationvariables set on the component. |
| getAttributeInfo | | protected MBeanAttributeInfo getAttributeInfo(String attribute)(Code) | |
Parameters:
attribute - identification of the attribute the MBeanAttributeInfo for the specified attribute |
| getComponentConfigurationData | | protected String getComponentConfigurationData(String compName)(Code) | | Get the the "Configuration" element in the jbi.xml. If the Configuration
element is missing in the jbi.xml a null value is returned
Parameters:
compName - - component name the configuration xml string |
| getComponentConfigurationNS | | protected String getComponentConfigurationNS(String compName)(Code) | | Get the namespace of the "Configuration" element in the jbi.xml, if one
exists. Return an empty string if a "Configuration" emenet is not
defined.
Parameters:
compName - - component name the configuration element namespace |
| getMBeanInfo | | public MBeanInfo getMBeanInfo()(Code) | | Provides the exposed attributes and actions of the Dynamic MBean using
an MBeanInfo object.
An instance of MBeanInfo allowing all attributes and actions exposed by this Dynamic MBean to be retrieved. |
| invoke | | public Object invoke(String actionName, Object[] params, String[] signature) throws MBeanException, ReflectionException(Code) | | Allows an action to be invoked on the Dynamic MBean.
Parameters:
actionName - The name of the action to be invoked.
Parameters:
params - An array containing the parameters to be set when the action is invoked.
Parameters:
signature - An array containing the signature of the action. The class objects will be loaded through the same class loader as theone used for loading the MBean on which the action is invoked. The object returned by the action, which represents the result ofinvoking the action on the MBean specified.
exception:
MBeanException - Wraps a java.lang.Exception thrownby the MBean's invoked method.
exception:
ReflectionException - Wraps a java.lang.Exception thrown while trying to invoke the method |
| isAppConfigSupported | | public boolean isAppConfigSupported() throws MBeanException(Code) | | 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.
true if the components configuration MBean implements all theoperations for application configuration.
throws:
MBeanException - if the component is not installed or is not in the Started state. |
| isAppVarsSupported | | public boolean isAppVarsSupported() throws MBeanException(Code) | | 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.
true if the components configuration MBean implements all theoperations for application variables.
throws:
MBeanException - if the component is not installed or is not in the Started state. |
| isComponentConfigSupported | | public boolean isComponentConfigSupported() throws MBeanException(Code) | | Detect the components support for component configuration. This method
returns true if the component has a configuration MBean with
configuration attributes.
true if the components configuration MBean has configurationattributes.
throws:
MBeanException - if the component is not installed or is not in the Started state. |
| queryApplicationConfigurationType | | public CompositeType queryApplicationConfigurationType()(Code) | | Get the CompositeType definition for the components application configuration
the CompositeType for the components application configuration. |
| retrieveConfigurationDisplayData | | public String retrieveConfigurationDisplayData()(Code) | | Retrieves the component configuration metadata.
The XML data conforms to the component
configuration schema.
a String containing the configuration metadata. |
| retrieveConfigurationDisplaySchema | | public String retrieveConfigurationDisplaySchema()(Code) | | Retrieves the component specific configuration schema.
a String containing the configuration schema. |
| setApplicationConfiguration | | public String setApplicationConfiguration(String name, Properties appCfgProps) throws MBeanException(Code) | | 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
Parameters:
name - - configuration name, must match the value of the field "configurationName" in the appConfig
Parameters:
appCfgProps - - application configuration properties.
throws:
MBeanException - if there are errors encountered when updating the configuration. management message string which gives the status of the operation. For target=cluster, instance specific details are included. |
| setApplicationConfiguration | | public String setApplicationConfiguration(String name, CompositeData appConfig) throws MBeanException(Code) | | 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
Parameters:
name - - configuration name, must match the value of the field "configurationName" in the appConfig
Parameters:
appConfig - - application configuration composite
throws:
MBeanException - if there are errors encountered when updating the configuration. management message string which gives the status of the operation. For target=cluster, instance specific details are included. |
| setApplicationVariable | | public String setApplicationVariable(String name, CompositeData appVar) throws MBeanException(Code) | | This operation sets an application variable. If a variable does not exist with
the same name, its an error.
Parameters:
name - - name of the application variable
Parameters:
appVar - - this is the application variable compoiste to be updated.
throws:
MBeanException - if one or more application variables cannot be deleted management message string which gives the status of the operation. For target=cluster, instance specific details are included. |
| setAttributes | | public AttributeList setAttributes(AttributeList attributes)(Code) | | Sets the values of several attributes of the Dynamic MBean.
Parameters:
attributes - A list of attributes: The identification of theattributes to be set and the values they are to be set to. The list of attributes that were set, with their new values.
See Also: ComponentConfiguration.getAttributes |
| setConfigurationAttribute | | public String setConfigurationAttribute(Attribute attrib) throws javax.jbi.JBIException(Code) | | Set a single configuration attribute on a target.
Parameters:
attrib - - the configuration attribute to be set. a management message string with the status of the operation. |
|
|