| com.sun.jbi.management.ComponentConfiguration
All known Subclasses: com.sun.jbi.framework.ComponentConfiguration,
| ComponentConfiguration | | public interface ComponentConfiguration extends javax.management.DynamicMBean(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. |
| addApplicationConfiguration | | 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 | | 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 | | 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 | | 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 | | 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 | | 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 | | TabularData getApplicationVariables()(Code) | | Get the Application Variable set for a component.
a TabularData which has all the applicationvariables set on the component. |
| 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 | | CompositeType queryApplicationConfigurationType()(Code) | | Get the CompositeType definition for the components application configuration
the CompositeType for the components application configuration. |
| retrieveConfigurationDisplayData | | public String retrieveConfigurationDisplayData() throws MBeanException(Code) | | Retrieves the component configuration metadata.
The XML data conforms to the component
configuration schema.
a String containing the configuration metadata.
throws:
MBeanException - on errors |
| retrieveConfigurationDisplaySchema | | public String retrieveConfigurationDisplaySchema() throws MBeanException(Code) | | Retrieves the component specific configuration schema.
a String containing the configuration schema.
throws:
MBeanException - on errors. |
| setApplicationConfiguration | | 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 | | 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 | | 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. |
|
|