com.sun.esb.management.api.configuration

Interface ConfigurationService

All Known Implementing Classes:

ConfigurationServiceImpl

public interface ConfigurationService

Defines operations for common configuration services across the JBI Runtime, component containers, configuring logger levels, etc.

Author:

graj

Method Summary

Methods

Modifier and Type	Method and Description
String	addApplicationConfiguration(String componentName, String targetName, String name, CompositeData appConfig) Add an application configuration.
String	addApplicationConfiguration(String componentName, String targetName, String name, Properties config) Add a named application configuration to a component installed on a given target.
String	addApplicationVariable(String componentName, String targetName, String name, CompositeData appVar) This operation adds a new application variable.
String	addApplicationVariables(String componentName, String targetName, Properties appVariables) Add application variables to a component installed on a given target.
String	deleteApplicationConfiguration(String componentName, String targetName, String name) Delete a named application configuration in a component installed on a given target.
String	deleteApplicationVariables(String componentName, String targetName, String[] appVariableNames) Delete application variables from a component installed on a given target.
String	exportApplicationConfiguration(String applicationName, String targetName, String configDir) This method is used to export the application variables and application configuration objects used by the given application in the specified target.
Properties	getApplicationConfiguration(String componentName, String name, String targetName) Get a specific named configuration.
Map<String,Properties>	getApplicationConfigurations(String componentName, String targetName) Get all the application configurations set on a component.
TabularData	getApplicationConfigurationsAsTabularData(String componentName, String targetName) Get a Map of all application configurations for the component.
Properties	getApplicationVariables(String componentName, String targetName) Get all the application variables set on a component.
TabularData	getApplicationVariablesAsTabularData(String componentName, String targetName) Get the Application Variable set for a component.
Properties	getComponentConfiguration(String componentName, String targetName) Retrieve component configuration
Map<String,Object>	getComponentConfigurationAsMap(String componentName, String targetName) Retrieve component configuration
Map<String,ObjectName[]>	getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName) Gets the extension MBean object names
ObjectName[]	getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName, String targetInstanceName) Gets the extension MBean object names
Map<String,String>	getComponentLoggerDisplayNames(String componentName, String targetName, String targetInstanceName) Gets the component custom loggers and their display names.
Map<String,Level>	getComponentLoggerLevels(String componentName, String targetName, String targetInstanceName) Gets the component custom loggers and their levels
Properties	getDefaultRuntimeConfiguration() This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor.
Map<String,Object>	getDefaultRuntimeConfigurationAsMap() This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor.
Properties	getRuntimeConfiguration(String targetName) This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor.
Map<String,Object>	getRuntimeConfigurationAsMap(String targetName) This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor.
Properties	getRuntimeConfigurationMetaData(String propertyKeyName) This method returns the runtime configuration metadata associated with the specified property.
String	getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName) Return the display name for a runtime logger
String	getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName, String targetInstanceName) Deprecated.
Level	getRuntimeLoggerLevel(String runtimeLoggerName, String targetName) Lookup the level of one runtime logger
Level	getRuntimeLoggerLevel(String runtimeLoggerName, String targetName, String targetInstanceName) Deprecated.
Map<String,Level>	getRuntimeLoggerLevels(String targetName) Gets all the runtime loggers and their levels
Map<String,Level>	getRuntimeLoggerLevels(String targetName, String targetInstanceName) Deprecated.
Map<String,String>	getRuntimeLoggerNames(String targetName) Gets all the runtime loggers and their display names
Map<String,String>	getRuntimeLoggerNames(String targetName, String targetInstanceName) Deprecated.
Object	invokeExtensionMBeanOperation(String componentName, String extensionName, String operationName, Object[] parameters, String[] signature, String targetName, String targetInstanceName) Invokes an operation on an Extension MBean.
boolean	isAppConfigSupported(String componentName, String targetName) Detect the components support for application configuration.
boolean	isAppVarsSupported(String componentName, String targetName) Detect the components support for application variables.
boolean	isComponentConfigSupported(String componentName, String targetName) Detect the components support for component configuration.
boolean	isServerRestartRequired() checks if the server need to be restarted to apply the changes made to some of the configuration parameters.
String[]	listApplicationConfigurationNames(String componentName, String targetName) List all the application configurations in a component.
CompositeType	queryApplicationConfigurationType(String componentName, String targetName) Get the CompositeType definition for the components application configuration
String	retrieveConfigurationDisplayData(String componentName, String targetName) Retrieves the component configuration metadata.
String	retrieveConfigurationDisplaySchema(String componentName, String targetName) Retrieves the component specific configuration schema.
String	setApplicationConfiguration(String componentName, String name, Properties config, String targetName) Update a named application configuration in a component installed on a given target.
String	setApplicationConfiguration(String componentName, String targetName, String name, CompositeData appConfig) Update a application configuration.
String	setApplicationVariable(String componentName, String targetName, String name, CompositeData appVar) This operation sets an application variable.
String	setApplicationVariables(String componentName, Properties appVariables, String targetName) Set application variables on a component installed on a given target.
String	setComponentConfiguration(String componentName, Map<String,Object> configurationValues, String targetName) Will return jbi mgmt message with success, failure, or partial success per instance.
String	setComponentConfiguration(String componentName, Properties configurationValues, String targetName) Will return jbi mgmt message with success, failure, or partial success per instance.
void	setComponentLoggerLevel(String componentName, String loggerCustomName, Level logLevel, String targetName, String targetInstanceName) Sets the component log level for a given custom logger
boolean	setRuntimeConfiguration(Map<String,Object> parameters, String targetName) This method sets one or more configuration parameters on the runtime with a list of name/value pairs passed as a properties object.
boolean	setRuntimeConfiguration(Properties parameters, String targetName) This method sets one or more configuration parameters on the runtime with a list of name/value pairs passed as a properties object.
void	setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName) Sets the log level for a given runtime logger
void	setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName, String targetInstanceName) Deprecated.
String	verifyApplication(String applicationURL, boolean generateTemplates, String templateDir, boolean includeDeployCommand, String targetName, String clientSAFilePath) This method is used to verify if the application variables and application configuration objects used in the given application are available in JBI runtime in the specified target.

Method Detail

getComponentConfiguration

Properties getComponentConfiguration(String componentName,
                                   String targetName)
                                     throws ManagementRemoteException

Retrieve component configuration

Parameters:

componentName -

targetName -

Returns:

the targetName as key and the name/value pairs as properties

Throws:

ManagementRemoteException - on error

getComponentExtensionMBeanObjectNames

Map<String,ObjectName[]> getComponentExtensionMBeanObjectNames(String componentName,
                                                             String extensionName,
                                                             String targetName)
                                                               throws ManagementRemoteException

Gets the extension MBean object names

Parameters:

componentName - name of the component

extensionName - the name of the extension (e.g., Configuration, Logger, etc.)

targetName - name of the target (e.g., cluster1, server, etc.)

Returns:

Throws:

ManagementRemoteException - on error

getComponentExtensionMBeanObjectNames

ObjectName[] getComponentExtensionMBeanObjectNames(String componentName,
                                                 String extensionName,
                                                 String targetName,
                                                 String targetInstanceName)
                                                   throws ManagementRemoteException

Gets the extension MBean object names

Parameters:

componentName - name of the component

extensionName - the name of the extension (e.g., Configuration, Logger, etc.)

targetName - name of the target (e.g., cluster1, server, etc.)

targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)

Returns:

an array of ObjectName(s)

Throws:

ManagementRemoteException - on error

getComponentLoggerLevels

Map<String,Level> getComponentLoggerLevels(String componentName,
                                         String targetName,
                                         String targetInstanceName)
                                           throws ManagementRemoteException

Gets the component custom loggers and their levels

Parameters:

componentName - name of the component

targetName - name of the target (e.g., cluster1, server, etc.)

targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)

Returns:

a Map of loggerCustomName to their log levels

Throws:

ManagementRemoteException - on error

getComponentLoggerDisplayNames

Map<String,String> getComponentLoggerDisplayNames(String componentName,
                                                String targetName,
                                                String targetInstanceName)
                                                  throws ManagementRemoteException

Gets the component custom loggers and their display names.

Parameters:

componentName - name of the component

targetName - name of the target (e.g., cluster1, server, etc.)

targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)

Returns:

a Map of loggerCustomName to their display names

Throws:

ManagementRemoteException - on error

getDefaultRuntimeConfiguration

Properties getDefaultRuntimeConfiguration()
                                          throws ManagementRemoteException

This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor. The parameter descriptor should contain the following data that represents the parameter. name : name of the parameter value : value of the parameter as a String type. type : type of the parameter. Basic data types only. description: (optional) description of the parameter. displayName: (optional) display name of the parameter readOnly : true/false validValues : (optional) list of string values with ',' as delimiter. or a range value with - with a '-' as delimiter. min and max strings will be converted to the parameter type and then used to validate the value of the parameter.

Parameters:

targetName - cluster or instance name ( e.g. cluster1, instance1 ) on which configuration parameters will be set. null to represent the default instance which is admin server

Returns:

Properties that represents the list of configuration parameter descriptors.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

getRuntimeConfiguration

Properties getRuntimeConfiguration(String targetName)
                                   throws ManagementRemoteException

This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor. The parameter descriptor should contain the following data that represents the parameter. name : name of the parameter value : value of the parameter as a String type. type : type of the parameter. Basic data types only. description: (optional) description of the parameter. displayName: (optional) display name of the parameter readOnly : true/false validValues : (optional) list of string values with ',' as delimiter. or a range value with - with a '-' as delimiter. min and max strings will be converted to the parameter type and then used to validate the value of the parameter.

Parameters:

targetName - cluster or instance name ( e.g. cluster1, instance1 ) on which configuration parameters will be set. null to represent the default instance which is admin server

Returns:

Properties that represents the list of configuration parameter descriptors.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

getRuntimeConfigurationMetaData

Properties getRuntimeConfigurationMetaData(String propertyKeyName)
                                           throws ManagementRemoteException

This method returns the runtime configuration metadata associated with the specified property. The metadata contain name-value pairs like: default, descriptionID, descriptorType, displayName, displayNameId, isStatic, name, resourceBundleName, tooltip, tooltipId, etc.

Parameters:

propertyKeyName -

Returns:

Properties that represent runtime configuration metadata

Throws:

ManagementRemoteException

getRuntimeLoggerLevel

Level getRuntimeLoggerLevel(String runtimeLoggerName,
                          String targetName,
                          String targetInstanceName)
                            throws ManagementRemoteException

Deprecated.

Lookup the level of one runtime logger

Parameters:

runtimeLoggerName - name of the runtime logger (e.g. com.sun.jbi.framework

targetName - name of the target (e.g., cluster1, server, etc.)

targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)

Returns:

a Map of loggerCustomName to their log levels

Throws:

ManagementRemoteException - on error

getRuntimeLoggerNames

Map<String,String> getRuntimeLoggerNames(String targetName,
                                       String targetInstanceName)
                                         throws ManagementRemoteException

Deprecated.

Gets all the runtime loggers and their display names

Parameters:

targetName - name of the target (e.g., cluster1, server, etc.)

targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)

Returns:

a Map of display names to their logger names

Throws:

ManagementRemoteException - on error

getRuntimeLoggerLevels

Map<String,Level> getRuntimeLoggerLevels(String targetName,
                                       String targetInstanceName)
                                         throws ManagementRemoteException

Deprecated.

Gets all the runtime loggers and their levels

Parameters:

targetName - name of the target (e.g., cluster1, server, etc.)

targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)

Returns:

a Map of loggerCustomName to their log levels

Throws:

ManagementRemoteException - on error

getRuntimeLoggerLevel

Level getRuntimeLoggerLevel(String runtimeLoggerName,
                          String targetName)
                            throws ManagementRemoteException

Lookup the level of one runtime logger

Parameters:

runtimeLoggerName - name of the runtime logger (e.g. com.sun.jbi.framework

targetName - name of the target (e.g., cluster1, server, etc.)

Returns:

a Map of loggerCustomName to their log levels

Throws:

ManagementRemoteException - on error

getRuntimeLoggerNames

Map<String,String> getRuntimeLoggerNames(String targetName)
                                         throws ManagementRemoteException

Gets all the runtime loggers and their display names

Parameters:

targetName - name of the target (e.g., cluster1, server, etc.)

Returns:

a Map of display names to their logger names

Throws:

ManagementRemoteException - on error

getRuntimeLoggerLevels

Map<String,Level> getRuntimeLoggerLevels(String targetName)
                                         throws ManagementRemoteException

Gets all the runtime loggers and their levels

Parameters:

targetName - name of the target (e.g., cluster1, server, etc.)

Returns:

a Map of loggerCustomName to their log levels

Throws:

ManagementRemoteException - on error

isServerRestartRequired

boolean isServerRestartRequired()
                                throws ManagementRemoteException

checks if the server need to be restarted to apply the changes made to some of the configuration parameters.

Returns:

true if server needs to be restarted for updated configuration to take effect. false if no server restart is needed.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

setComponentConfiguration

String setComponentConfiguration(String componentName,
                               Properties configurationValues,
                               String targetName)
                                 throws ManagementRemoteException

Will return jbi mgmt message with success, failure, or partial success per instance. The entry per instance will have value as part of the management message (XML) String.

Parameters:

componentName -

configurationValue -

targetName -

Returns:

value as part of the management message (XML) String.

Throws:

ManagementRemoteException - on error

setComponentLoggerLevel

void setComponentLoggerLevel(String componentName,
                           String loggerCustomName,
                           Level logLevel,
                           String targetName,
                           String targetInstanceName)
                             throws ManagementRemoteException

Sets the component log level for a given custom logger

Parameters:

componentName - name of the component

loggerCustomName - the custom logger name

logLevel - the level to set the logger

targetName - name of the target (e.g., cluster1, server, etc.)

targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)

Throws:

ManagementRemoteException - on error

setRuntimeConfiguration

boolean setRuntimeConfiguration(Properties parameters,
                              String targetName)
                                throws ManagementRemoteException

This method sets one or more configuration parameters on the runtime with a list of name/value pairs passed as a properties object. The property name in the properties object should be an existing configuration parameter name. If user try to set the parameter that is not in the configuration parameters list, this method will throw an exception. The value of the property can be any object. If the value is non string object, its string value (Object.toString()) will be used as a value that will be set on the configuration. This method first validates whether all the paramters passed in properties object exist in the runtime configuration or not. If any one the parameters passed is not existing, it will return an error without settings the parameters that are passed in the properties including a valid parameters. If there is an error in setting a paramter, this method throws an exception with the list of parameters that were not set.

Parameters:

params - Properties object that contains name/value pairs corresponding to the configuration parameters to be set on the runtime.

targetName - cluster or instance name ( e.g. cluster1, instance1 ) on which configuration parameters will be set. null to represent the default instance which is admin server

Returns:

true if server restart is required, false if not

Throws:

ManagementRemoteException - if there is a jmx error or a invalid parameter is passed in the params properties object. In case of an error setting the a particular parameter, the error message should list the invalid parameters.

setRuntimeLoggerLevel

void setRuntimeLoggerLevel(String runtimeLoggerName,
                         Level logLevel,
                         String targetName,
                         String targetInstanceName)
                           throws ManagementRemoteException

Deprecated.

Sets the log level for a given runtime logger

Parameters:

runtimeLoggerName - name of the runtime logger

logLevel - the level to set the logger

targetName - name of the target (e.g., cluster1, server, etc.)

targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)

Throws:

ManagementRemoteException - on error

setRuntimeLoggerLevel

void setRuntimeLoggerLevel(String runtimeLoggerName,
                         Level logLevel,
                         String targetName)
                           throws ManagementRemoteException

Sets the log level for a given runtime logger

Parameters:

runtimeLoggerName - name of the runtime logger

logLevel - the level to set the logger

targetName - name of the target (e.g., cluster1, server, etc.)

Throws:

ManagementRemoteException - on error

getRuntimeLoggerDisplayName

String getRuntimeLoggerDisplayName(String runtimeLoggerName,
                                 String targetName,
                                 String targetInstanceName)
                                   throws ManagementRemoteException

Deprecated.

Return the display name for a runtime logger

Parameters:

runtimeLoggerName - name of the logger (e.g. com.sun.jbi.framework)

targetName - name of the target (e.g., cluster1, server, etc.)

targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)

Returns:

the display name for the given logger

Throws:

JBIRemoteException - on error

ManagementRemoteException

getRuntimeLoggerDisplayName

String getRuntimeLoggerDisplayName(String runtimeLoggerName,
                                 String targetName)
                                   throws ManagementRemoteException

Return the display name for a runtime logger

Parameters:

runtimeLoggerName - name of the logger (e.g. com.sun.jbi.framework)

targetName - name of the target (e.g., cluster1, server, etc.)

Returns:

the display name for the given logger

Throws:

JBIRemoteException - on error

ManagementRemoteException

verifyApplication

String verifyApplication(String applicationURL,
                       boolean generateTemplates,
                       String templateDir,
                       boolean includeDeployCommand,
                       String targetName,
                       String clientSAFilePath)
                         throws ManagementRemoteException

This method is used to verify if the application variables and application configuration objects used in the given application are available in JBI runtime in the specified target. Also this method verifies if all necessary components are installed. If generateTemplates is true templates for missing application variables and application configurations are generated. A command script that uses the template files to set configuration objects is generated.

Parameters:

applicationURL - the URL for the application zip file

generateTemplates - true if templates have to be generated

templateDir - the dir to store the generated templates

includeDeployCommand - true if the generated script should include deploy command

targetName - the target on which the application has to be verified

clientSAFilePath - is used to pass on the file path to the SA in the client side - used in remote server use cases.

Throws:

ManagementRemoteException - if the application could not be verified Note: param templateDir is used between ant/cli and common client client TemplateZIPID is used between common client server and common client client

exportApplicationConfiguration

String exportApplicationConfiguration(String applicationName,
                                    String targetName,
                                    String configDir)
                                      throws ManagementRemoteException

This method is used to export the application variables and application configuration objects used by the given application in the specified target.

Parameters:

applicationName - the name of the application

targetName - the target whose configuration has to be exported

configDir - the dir to store the configurations

Throws:

ManagementRemoteException - if the application configuration could not be exported Note: param configDir is used between ant/cli and common client client. The return value is used between common client server and common client client.

isComponentConfigSupported

boolean isComponentConfigSupported(String componentName,
                                 String targetName)
                                   throws ManagementRemoteException

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

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

true if the components configuration MBean has configuration attributes

Throws:

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

isAppConfigSupported

boolean isAppConfigSupported(String componentName,
                           String targetName)
                             throws ManagementRemoteException

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.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

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

Throws:

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

isAppVarsSupported

boolean isAppVarsSupported(String componentName,
                         String targetName)
                           throws ManagementRemoteException

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.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

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

Throws:

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

addApplicationVariables

String addApplicationVariables(String componentName,
                             String targetName,
                             Properties appVariables)
                               throws ManagementRemoteException

Add application variables to a component installed on a given target. If even a variable from the set is already set on the component, this operation fails.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

appVariables - - set of application variables to add. The values of the application variables have the application variable type and value and the format is "[type]value"

Returns:

a JBI Management message indicating the status of the operation. In case a variable is not added the management message has a ERROR task status message giving the details of the failure.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

setApplicationVariables

String setApplicationVariables(String componentName,
                             Properties appVariables,
                             String targetName)
                               throws ManagementRemoteException

Set application variables on a component installed on a given target. If even a variable from the set has not been added to the component, this operation fails.

Parameters:

componentName - component identification

appVariables - - set of application variables to update. The values of the application variables have the application variable type and value and the format is "[type]value"

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

a JBI Management message indicating the status of the operation. In case a variable is not set the management message has a ERROR task status message giving the details of the failure.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

deleteApplicationVariables

String deleteApplicationVariables(String componentName,
                                String targetName,
                                String[] appVariableNames)
                                  throws ManagementRemoteException

Delete application variables from a component installed on a given target. If even a variable from the set has not been added to the component, this operation fails.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

appVariableNames - - names of application variables to delete.

Returns:

a JBI Management message indicating the status of the operation. In case a variable is not deleted the management message has a ERROR task status message giving the details of the failure.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

getApplicationVariables

Properties getApplicationVariables(String componentName,
                                 String targetName)
                                   throws ManagementRemoteException

Get all the application variables set on a component.

Returns:

all the application variables et on the component. The return proerties set has the name="[type]value" pairs for the application variables.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

queryApplicationConfigurationType

CompositeType queryApplicationConfigurationType(String componentName,
                                              String targetName)
                                                throws ManagementRemoteException

Get the CompositeType definition for the components application configuration

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

the CompositeType for the components application configuration.

Throws:

ManagementRemoteException

addApplicationConfiguration

String addApplicationConfiguration(String componentName,
                                 String targetName,
                                 String name,
                                 Properties config)
                                   throws ManagementRemoteException

Add a named application configuration to a component installed on a given target.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

name - application configuration name

config - application configuration represented as a set of properties.

Returns:

a JBI Management message indicating the status of the operation.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

setApplicationConfiguration

String setApplicationConfiguration(String componentName,
                                 String name,
                                 Properties config,
                                 String targetName)
                                   throws ManagementRemoteException

Update a named application configuration in a component installed on a given target.

Parameters:

componentName - component identification

name - application configuration name

config - application configuration represented as a set of properties.

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

a JBI Management message indicating the status of the operation.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

deleteApplicationConfiguration

String deleteApplicationConfiguration(String componentName,
                                    String targetName,
                                    String name)
                                      throws ManagementRemoteException

Delete a named application configuration in a component installed on a given target.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

name - name of application configuration to be deleted

Returns:

a JBI Management message indicating the status of the operation.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

listApplicationConfigurationNames

String[] listApplicationConfigurationNames(String componentName,
                                         String targetName)
                                           throws ManagementRemoteException

List all the application configurations in a component.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

an array of names of all the application configurations.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

getApplicationConfiguration

Properties getApplicationConfiguration(String componentName,
                                     String name,
                                     String targetName)
                                       throws ManagementRemoteException

Get a specific named configuration. If the named configuration does not exist in the component the returned properties is an empty set.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

the application configuration represented as a set of properties.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

getApplicationConfigurations

Map<String,Properties> getApplicationConfigurations(String componentName,
                                                  String targetName)
                                                    throws ManagementRemoteException

Get all the application configurations set on a component.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

a map of all the application configurations keyed by the configuration name.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

retrieveConfigurationDisplaySchema

String retrieveConfigurationDisplaySchema(String componentName,
                                        String targetName)
                                          throws ManagementRemoteException

Retrieves the component specific configuration schema.

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

a String containing the configuration schema.

Throws:

ManagementRemoteException - if the config schema cannot be retrieved.

retrieveConfigurationDisplayData

String retrieveConfigurationDisplayData(String componentName,
                                      String targetName)
                                        throws ManagementRemoteException

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

Parameters:

componentName - component identification

targetName - identification of the target. Can be a standalone server, cluster or clustered instance.

Returns:

a String containing the configuration metadata.

Throws:

ManagementRemoteException - if the config data cannot be retrieved.

addApplicationConfiguration

String addApplicationConfiguration(String componentName,
                                 String targetName,
                                 String name,
                                 CompositeData appConfig)
                                   throws ManagementRemoteException

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:

componentName -

targetName -

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:

ManagementRemoteException - if the application configuration cannot be added.

setApplicationConfiguration

String setApplicationConfiguration(String componentName,
                                 String targetName,
                                 String name,
                                 CompositeData appConfig)
                                   throws ManagementRemoteException

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:

componentName -

targetName -

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:

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

getApplicationConfigurationsAsTabularData

TabularData getApplicationConfigurationsAsTabularData(String componentName,
                                                    String targetName)
                                                      throws ManagementRemoteException

Get a Map of all application configurations for the component.

Parameters:

componentName -

targetName -

Returns:

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

Throws:

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

getApplicationVariablesAsTabularData

TabularData getApplicationVariablesAsTabularData(String componentName,
                                               String targetName)
                                                 throws ManagementRemoteException

Get the Application Variable set for a component.

Parameters:

componentName -

targetName -

Returns:

a TabularData which has all the application variables set on the component.

Throws:

ManagementRemoteException

addApplicationVariable

String addApplicationVariable(String componentName,
                            String targetName,
                            String name,
                            CompositeData appVar)
                              throws ManagementRemoteException

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

Parameters:

componentName -

targetName -

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:

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

setApplicationVariable

String setApplicationVariable(String componentName,
                            String targetName,
                            String name,
                            CompositeData appVar)
                              throws ManagementRemoteException

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

Parameters:

componentName -

targetName -

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:

ManagementRemoteException - if one or more application variables cannot be deleted

getDefaultRuntimeConfigurationAsMap

Map<String,Object> getDefaultRuntimeConfigurationAsMap()
                                                       throws ManagementRemoteException

This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor. The parameter descriptor should contain the following data that represents the parameter. name : name of the parameter value : value of the parameter as a String type. type : type of the parameter. Basic data types only. description: (optional) description of the parameter. displayName: (optional) display name of the parameter readOnly : true/false validValues : (optional) list of string values with ',' as delimiter. or a range value with - with a '-' as delimiter. min and max strings will be converted to the parameter type and then used to validate the value of the parameter.

Parameters:

targetName - cluster or instance name ( e.g. cluster1, instance1 ) on which configuration parameters will be set. null to represent the default instance which is admin server

Returns:

Map that represents the list of configuration parameter descriptors.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

getRuntimeConfigurationAsMap

Map<String,Object> getRuntimeConfigurationAsMap(String targetName)
                                                throws ManagementRemoteException

This method returns a tabular data of a complex open data objects that represent the runtime configuration parameter descriptor. The parameter descriptor should contain the following data that represents the parameter. name : name of the parameter value : value of the parameter as a String type. type : type of the parameter. Basic data types only. description: (optional) description of the parameter. displayName: (optional) display name of the parameter readOnly : true/false validValues : (optional) list of string values with ',' as delimiter. or a range value with - with a '-' as delimiter. min and max strings will be converted to the parameter type and then used to validate the value of the parameter.

Parameters:

targetName - cluster or instance name ( e.g. cluster1, instance1 ) on which configuration parameters will be set. null to represent the default instance which is admin server

Returns:

Map that represents the list of configuration parameter descriptors.

Throws:

ManagementRemoteException - if there is a jmx error accessing the instance

setRuntimeConfiguration

boolean setRuntimeConfiguration(Map<String,Object> parameters,
                              String targetName)
                                throws ManagementRemoteException

This method sets one or more configuration parameters on the runtime with a list of name/value pairs passed as a properties object. The property name in the properties object should be an existing configuration parameter name. If user try to set the parameter that is not in the configuration parameters list, this method will throw an exception. The value of the property can be any object. If the value is non string object, its string value (Object.toString()) will be used as a value that will be set on the configuration. This method first validates whether all the paramters passed in properties object exist in the runtime configuration or not. If any one the parameters passed is not existing, it will return an error without settings the parameters that are passed in the properties including a valid parameters. If there is an error in setting a paramter, this method throws an exception with the list of parameters that were not set.

Parameters:

params - Map object that contains name/value pairs corresponding to the configuration parameters to be set on the runtime.

targetName - cluster or instance name ( e.g. cluster1, instance1 ) on which configuration parameters will be set. null to represent the default instance which is admin server

Returns:

true if server restart is required, false if not

Throws:

ManagementRemoteException - if there is a jmx error or a invalid parameter is passed in the params properties object. In case of an error setting the a particular parameter, the error message should list the invalid parameters.

getComponentConfigurationAsMap

Map<String,Object> getComponentConfigurationAsMap(String componentName,
                                                String targetName)
                                                  throws ManagementRemoteException

Retrieve component configuration

Parameters:

componentName -

targetName -

Returns:

the targetName as key and the name/value pairs as Map

Throws:

ManagementRemoteException - on error

setComponentConfiguration

String setComponentConfiguration(String componentName,
                               Map<String,Object> configurationValues,
                               String targetName)
                                 throws ManagementRemoteException

Will return jbi mgmt message with success, failure, or partial success per instance. The entry per instance will have value as part of the management message (XML) String.

Parameters:

componentName -

configurationValues -

targetName -

Returns:

value as part of the management message (XML) String.

Throws:

ManagementRemoteException - on error

invokeExtensionMBeanOperation

Object invokeExtensionMBeanOperation(String componentName,
                                   String extensionName,
                                   String operationName,
                                   Object[] parameters,
                                   String[] signature,
                                   String targetName,
                                   String targetInstanceName)
                                     throws ManagementRemoteException

Invokes an operation on an Extension MBean.

Parameters:

componentName -

extensionName - the name of the extension (e.g., Configuration, Logger, etc.)

operationName - The name of the operation to be invoked.

parameters - An array containing the parameters to be set when the operation is invoked

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

targetName - name of the target (e.g., server, Cluster1, StandloneServer2, etc.)

targetInstanceName - name of the target instance (e.g., Cluster1-Instance1, Cluster2-Instance10, etc.)

Returns:

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

Throws:

ManagementRemoteException