com.sun.jbi.management

Interface ComponentConfiguration

All Superinterfaces:

DynamicMBean

public interface ComponentConfiguration
extends DynamicMBean

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

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.
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.
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) Update a application configuration.
String	setApplicationVariable(String name, CompositeData appVar) This operation sets an application variable.

Methods inherited from interface javax.management.DynamicMBean

getAttribute, getAttributes, getMBeanInfo, invoke, setAttribute, setAttributes

Method Detail

isComponentConfigSupported

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.

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.

isAppVarsSupported

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.

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

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.

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

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.

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

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.

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

TabularData getApplicationVariables()

Get the Application Variable set for a component.

Returns:

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

isAppConfigSupported

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.

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

CompositeType queryApplicationConfigurationType()

Get the CompositeType definition for the components application configuration

Returns:

the CompositeType for the components application configuration.

addApplicationConfiguration

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

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

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

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

String deleteApplicationConfiguration(String name)
                                      throws MBeanException

Delete an application configuration.

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

String setApplicationConfiguration(String name,
                                 Properties appCfgProps)
                                   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

Parameters:

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

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 there are errors encountered when updating the configuration.

setApplicationConfiguration

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

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

TabularData getApplicationConfigurations()

Get a Map of all application configurations for the component.

Returns:

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

retrieveConfigurationDisplaySchema

String retrieveConfigurationDisplaySchema()
                                          throws MBeanException

Retrieves the component specific configuration schema.

Returns:

a String containing the configuration schema.

Throws:

MBeanException - on errors.

retrieveConfigurationDisplayData

String retrieveConfigurationDisplayData()
                                        throws MBeanException

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

Returns:

a String containing the configuration metadata.

Throws:

MBeanException - on errors