| com.sun.esb.management.api.configuration.ConfigurationService
All known Subclasses: com.sun.esb.management.impl.configuration.ConfigurationServiceImpl, com.sun.esb.management.impl.configuration.ConfigurationServiceMBeanImpl,
| ConfigurationService | | public interface ConfigurationService (Code) | | Defines operations for common configuration services across the JBI Runtime,
component containers, configuring logger levels, etc.
author:
graj |
| Method Summary | |
| public String | addApplicationConfiguration(String componentName, String targetName, String name, Properties config)
Add a named application configuration to a component installed on a given target. | | String | addApplicationConfiguration(String componentName, String targetName, String name, CompositeData appConfig)
Add an application configuration. | | String | addApplicationVariable(String componentName, String targetName, String name, CompositeData appVar)
This operation adds a new application variable. | | public String | addApplicationVariables(String componentName, String targetName, Properties appVariables)
Add application variables to a component installed on a given target. | | public String | deleteApplicationConfiguration(String componentName, String targetName, String name)
Delete a named application configuration in a component installed on a given target. | | public String | deleteApplicationVariables(String componentName, String targetName, String[] appVariableNames)
Delete application variables from a component installed on a given target. | | public 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. | | public Properties | getApplicationConfiguration(String componentName, String name, String targetName)
Get a specific named configuration. | | public Map<String, Properties> | getApplicationConfigurations(String componentName, String targetName)
Get all the application configurations set on a component.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | TabularData | getApplicationConfigurationsAsTabularData(String componentName, String targetName)
Get a Map of all application configurations for the component.
Parameters:
componentName -
Parameters:
targetName - a TabularData of all the application configurations for a component keyed by the configuration name. | | public Properties | getApplicationVariables(String componentName, String targetName)
Get all the application variables set on a component.
all the application variables et on the component. | | TabularData | getApplicationVariablesAsTabularData(String componentName, String targetName)
Get the Application Variable set for a component.
Parameters:
componentName -
Parameters:
targetName - a TabularData which has all the application variables set on the component. | | public Properties | getComponentConfiguration(String componentName, String targetName)
| | public Map<String /*attributeName*/, Object | getComponentConfigurationAsMap(String componentName, String targetName)
| | public Map<String /* targetInstanceName */, ObjectName[]> | getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName)
| | public ObjectName[] | getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName, String targetInstanceName)
| | public Map<String /* loggerCustomName */, String | getComponentLoggerDisplayNames(String componentName, String targetName, String targetInstanceName)
Gets the component custom loggers and their display names. | | public Map<String /* loggerCustomName */, Level | getComponentLoggerLevels(String componentName, String targetName, String targetInstanceName)
| | public Properties | getDefaultRuntimeConfiguration()
This method returns a tabular data of a complex open data objects that
represent the runtime configuration parameter descriptor. | | public Map<String /*attributeName*/, Object | getDefaultRuntimeConfigurationAsMap()
This method returns a tabular data of a complex open data objects that
represent the runtime configuration parameter descriptor. | | public Properties | getRuntimeConfiguration(String targetName)
This method returns a tabular data of a complex open data objects that
represent the runtime configuration parameter descriptor. | | public Map<String /*attributeName*/, 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. | | public String | getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName, String targetInstanceName)
Return the display name for a runtime logger
Parameters:
runtimeLoggerName - name of the logger (e.g. | | public String | getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName)
Return the display name for a runtime logger
Parameters:
runtimeLoggerName - name of the logger (e.g. | | public Level | getRuntimeLoggerLevel(String runtimeLoggerName, String targetName, String targetInstanceName)
Lookup the level of one runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger (e.g. | | public Level | getRuntimeLoggerLevel(String runtimeLoggerName, String targetName)
Lookup the level of one runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger (e.g. | | public Map<String /* runtimeLoggerName */, Level | getRuntimeLoggerLevels(String targetName, String targetInstanceName)
| | public Map<String /* runtimeLoggerName */, Level | getRuntimeLoggerLevels(String targetName)
| | public Map<String /* display name */, String | getRuntimeLoggerNames(String targetName, String targetInstanceName)
| | public Map<String /* display name */, String | getRuntimeLoggerNames(String targetName)
| | public Object | invokeExtensionMBeanOperation(String componentName, String extensionName, String operationName, Object[] parameters, String[] signature, String targetName, String targetInstanceName)
Invokes an operation on an Extension MBean.
Parameters:
componentName -
Parameters:
extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
Parameters:
operationName - The name of the operation to be invoked.
Parameters:
parameters - An array containing the parameters to be set when the operation is invoked
Parameters:
signature - An array containing the signature of the operation. | | public boolean | isAppConfigSupported(String componentName, String targetName)
Detect the components support for application configuration. | | public boolean | isAppVarsSupported(String componentName, String targetName)
Detect the components support for application variables. | | public boolean | isComponentConfigSupported(String componentName, String targetName)
Detect the components support for component configuration. | | public boolean | isServerRestartRequired()
checks if the server need to be restarted to apply the changes made to
some of the configuration parameters.
true if server needs to be restarted for updated configuration totake effect. | | public String[] | listApplicationConfigurationNames(String componentName, String targetName)
List all the application configurations in a component.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public javax.management.openmbean.CompositeType | queryApplicationConfigurationType(String componentName, String targetName)
Get the CompositeType definition for the components application configuration
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | retrieveConfigurationDisplayData(String componentName, String targetName)
Retrieves the component configuration metadata.
The XML data conforms to the component
configuration schema.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | retrieveConfigurationDisplaySchema(String componentName, String targetName)
Retrieves the component specific configuration schema.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public 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. | | public String | setApplicationVariables(String componentName, Properties appVariables, String targetName)
Set application variables on a component installed on a given target. | | public String | setComponentConfiguration(String componentName, Properties configurationValues, String targetName)
Will return jbi mgmt message with success, failure, or partial success
per instance. | | public String | setComponentConfiguration(String componentName, Map<String /*attributeName*/, Object configurationValues, String targetName)
Will return jbi mgmt message with success, failure, or partial success
per instance. | | public void | setComponentLoggerLevel(String componentName, String loggerCustomName, Level logLevel, String targetName, String targetInstanceName)
| | public 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. | | public boolean | setRuntimeConfiguration(Map<String /*attributeName*/, 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. | | public void | setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName, String targetInstanceName)
| | public void | setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName)
| | public String | verifyApplication(String applicationURL, boolean generateTemplates, String templateDir, boolean includeDeployCommand, String targetName)
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. |
| addApplicationConfiguration | | public String addApplicationConfiguration(String componentName, String targetName, String name, Properties config) throws ManagementRemoteException(Code) | | Add a named application configuration to a component installed on a given target.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.
Parameters:
name - application configuration name
Parameters:
config - application configuration represented as a set of properties.a JBI Management message indicating the status of the operation.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| addApplicationConfiguration | | String addApplicationConfiguration(String componentName, String targetName, String name, CompositeData appConfig) throws ManagementRemoteException(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:
componentName -
Parameters:
targetName -
Parameters:
name - - configuration name, must match the value of the field "name" in the namedConfig
Parameters:
appConfig - - application configuration composite 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. |
| addApplicationVariable | | String addApplicationVariable(String componentName, String targetName, String name, CompositeData appVar) throws ManagementRemoteException(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:
componentName -
Parameters:
targetName -
Parameters:
name - - name of the application variable
Parameters:
appVar - - this is the application variable compoiste 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. |
| addApplicationVariables | | public String addApplicationVariables(String componentName, String targetName, Properties appVariables) throws ManagementRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.
Parameters:
appVariables - - set of application variables to add. The values of theapplication variables have the application variable type andvalue and the format is "[type]value"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 |
| deleteApplicationConfiguration | | public String deleteApplicationConfiguration(String componentName, String targetName, String name) throws ManagementRemoteException(Code) | | Delete a named application configuration in a component installed on a given target.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.
Parameters:
name - name of application configuration to be deleteda JBI Management message indicating the status of the operation.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| deleteApplicationVariables | | public String deleteApplicationVariables(String componentName, String targetName, String[] appVariableNames) throws ManagementRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server, cluster or clustered instance.
Parameters:
appVariableNames - - names of application variables to delete.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 |
| exportApplicationConfiguration | | public String exportApplicationConfiguration(String applicationName, String targetName, String configDir) throws ManagementRemoteException(Code) | | 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
Parameters:
targetName - the target whose configuration has to be exported
Parameters:
configDir - the dir to store the configurations
throws:
ManagementRemoteException - if the application configuration could not be exportedNote: param configDir is used between ant/cli and common client client.The return value is used between common client server and common client client. |
| getApplicationConfiguration | | public Properties getApplicationConfiguration(String componentName, String name, String targetName) throws ManagementRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. the application configuration represented as a set of properties.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| getApplicationConfigurations | | public Map<String, Properties> getApplicationConfigurations(String componentName, String targetName) throws ManagementRemoteException(Code) | | Get all the application configurations set on a component.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. a map of all the application configurations keyed by the configuration name.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| getApplicationConfigurationsAsTabularData | | TabularData getApplicationConfigurationsAsTabularData(String componentName, String targetName) throws ManagementRemoteException(Code) | | Get a Map of all application configurations for the component.
Parameters:
componentName -
Parameters:
targetName - 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. |
| getApplicationVariables | | public Properties getApplicationVariables(String componentName, String targetName) throws ManagementRemoteException(Code) | | Get all the application variables set on a component.
all the application variables et on the component. The return proertiesset has the name="[type]value" pairs for the application variables.a JBI Management message indicating the status of the operation.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| getComponentExtensionMBeanObjectNames | | public Map<String /* targetInstanceName */, ObjectName[]> getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName) throws ManagementRemoteException(Code) | | Gets the extension MBean object names
Parameters:
componentName - name of the component
Parameters:
extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
throws:
ManagementRemoteException - on error |
| getComponentExtensionMBeanObjectNames | | public ObjectName[] getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Gets the extension MBean object names
Parameters:
componentName - name of the component
Parameters:
extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) an array of ObjectName(s)
throws:
ManagementRemoteException - on error |
| getComponentLoggerDisplayNames | | public Map<String /* loggerCustomName */, String getComponentLoggerDisplayNames(String componentName, String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Gets the component custom loggers and their display names.
Parameters:
componentName - name of the component
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of loggerCustomName to their display names
throws:
ManagementRemoteException - on error |
| getComponentLoggerLevels | | public Map<String /* loggerCustomName */, Level getComponentLoggerLevels(String componentName, String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Gets the component custom loggers and their levels
Parameters:
componentName - name of the component
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of loggerCustomName to their log levels
throws:
ManagementRemoteException - on error |
| getDefaultRuntimeConfiguration | | public Properties getDefaultRuntimeConfiguration() throws ManagementRemoteException(Code) | | 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 whichconfiguration parameters will be set. null to represent thedefault instance which is admin server Properties that represents the list of configuration parameterdescriptors.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| getDefaultRuntimeConfigurationAsMap | | public Map<String /*attributeName*/, Object getDefaultRuntimeConfigurationAsMap() throws ManagementRemoteException(Code) | | 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 whichconfiguration parameters will be set. null to represent thedefault instance which is admin server Map that represents the list of configuration parameterdescriptors.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| getRuntimeConfiguration | | public Properties getRuntimeConfiguration(String targetName) throws ManagementRemoteException(Code) | | 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 whichconfiguration parameters will be set. null to represent thedefault instance which is admin server Properties that represents the list of configuration parameterdescriptors.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| getRuntimeConfigurationAsMap | | public Map<String /*attributeName*/, Object getRuntimeConfigurationAsMap(String targetName) throws ManagementRemoteException(Code) | | 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 whichconfiguration parameters will be set. null to represent thedefault instance which is admin server Map that represents the list of configuration parameterdescriptors.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| getRuntimeConfigurationMetaData | | Properties getRuntimeConfigurationMetaData(String propertyKeyName) throws ManagementRemoteException(Code) | | 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 - Properties that represent runtime configuration metadata
throws:
ManagementRemoteException - |
| getRuntimeLoggerDisplayName | | public String getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Return the display name for a runtime logger
Parameters:
runtimeLoggerName - name of the logger (e.g. com.sun.jbi.framework)
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) the display name for the given logger
throws:
JBIRemoteException - on error |
| getRuntimeLoggerDisplayName | | public String getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName) throws ManagementRemoteException(Code) | | Return the display name for a runtime logger
Parameters:
runtimeLoggerName - name of the logger (e.g. com.sun.jbi.framework)
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.) the display name for the given logger
throws:
JBIRemoteException - on error |
| getRuntimeLoggerLevel | | public Level getRuntimeLoggerLevel(String runtimeLoggerName, String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Lookup the level of one runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger (e.g. com.sun.jbi.framework
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of loggerCustomName to their log levels
throws:
ManagementRemoteException - on error |
| getRuntimeLoggerLevel | | public Level getRuntimeLoggerLevel(String runtimeLoggerName, String targetName) throws ManagementRemoteException(Code) | | Lookup the level of one runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger (e.g. com.sun.jbi.framework
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.) a Map of loggerCustomName to their log levels
throws:
ManagementRemoteException - on error |
| getRuntimeLoggerLevels | | public Map<String /* runtimeLoggerName */, Level getRuntimeLoggerLevels(String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Gets all the runtime loggers and their levels
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of loggerCustomName to their log levels
throws:
ManagementRemoteException - on error |
| getRuntimeLoggerNames | | public Map<String /* display name */, String getRuntimeLoggerNames(String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Gets all the runtime loggers and their display names
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) a Map of display names to their logger names
throws:
ManagementRemoteException - on error |
| invokeExtensionMBeanOperation | | public Object invokeExtensionMBeanOperation(String componentName, String extensionName, String operationName, Object[] parameters, String[] signature, String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Invokes an operation on an Extension MBean.
Parameters:
componentName -
Parameters:
extensionName - the name of the extension (e.g., Configuration, Logger, etc.)
Parameters:
operationName - The name of the operation to be invoked.
Parameters:
parameters - An array containing the parameters to be set when the operation is invoked
Parameters:
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.
Parameters:
targetName - name of the target (e.g., server, Cluster1, StandloneServer2, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., Cluster1-Instance1, Cluster2-Instance10, etc.) The object returned by the operation, which represents the result of invoking the operation on the Extension MBean specified.
throws:
ManagementRemoteException - |
| isAppConfigSupported | | public boolean isAppConfigSupported(String componentName, String targetName) throws ManagementRemoteException(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.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. true if the components configuration MBean implements all theoperations for application configuration.
throws:
ManagementRemoteException - if the component is not installed or is not in the Started state. |
| isAppVarsSupported | | public boolean isAppVarsSupported(String componentName, String targetName) throws ManagementRemoteException(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.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. true if the components configuration MBean implements all theoperations for application variables.
throws:
ManagementRemoteException - if the component is not installed or is not in the Started state. |
| isComponentConfigSupported | | public boolean isComponentConfigSupported(String componentName, String targetName) throws ManagementRemoteException(Code) | | 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
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. true if the components configuration MBean has configuration attributes
throws:
ManagementRemoteException - if the component is not installed or is not in the Started state. |
| isServerRestartRequired | | public boolean isServerRestartRequired() throws ManagementRemoteException(Code) | | checks if the server need to be restarted to apply the changes made to
some of the configuration parameters.
true if server needs to be restarted for updated configuration totake effect. false if no server restart is needed.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| listApplicationConfigurationNames | | public String[] listApplicationConfigurationNames(String componentName, String targetName) throws ManagementRemoteException(Code) | | List all the application configurations in a component.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.an array of names of all the application configurations.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| queryApplicationConfigurationType | | public javax.management.openmbean.CompositeType queryApplicationConfigurationType(String componentName, String targetName) throws ManagementRemoteException(Code) | | Get the CompositeType definition for the components application configuration
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. the CompositeType for the components application configuration. |
| retrieveConfigurationDisplayData | | public String retrieveConfigurationDisplayData(String componentName, String targetName) throws ManagementRemoteException(Code) | | Retrieves the component configuration metadata.
The XML data conforms to the component
configuration schema.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. a String containing the configuration metadata.
throws:
ManagementRemoteException - if the config data cannot be retrieved. |
| retrieveConfigurationDisplaySchema | | public String retrieveConfigurationDisplaySchema(String componentName, String targetName) throws ManagementRemoteException(Code) | | Retrieves the component specific configuration schema.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance. a String containing the configuration schema.
throws:
ManagementRemoteException - if the config schema cannot be retrieved. |
| setApplicationConfiguration | | public String setApplicationConfiguration(String componentName, String name, Properties config, String targetName) throws ManagementRemoteException(Code) | | Update a named application configuration in a component installed on a given target.
Parameters:
componentName - component identification
Parameters:
name - application configuration name
Parameters:
config - application configuration represented as a set of properties.
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.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 targetName, String name, CompositeData appConfig) throws ManagementRemoteException(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:
componentName -
Parameters:
targetName -
Parameters:
name - - configuration name, must match the value of the field "configurationName" in the appConfig
Parameters:
appConfig - - application configuration composite 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. |
| setApplicationVariable | | String setApplicationVariable(String componentName, String targetName, String name, CompositeData appVar) throws ManagementRemoteException(Code) | | This operation sets an application variable. If a variable does not exist with
the same name, its an error.
Parameters:
componentName -
Parameters:
targetName -
Parameters:
name - - name of the application variable
Parameters:
appVar - - this is the application variable compoiste to be updated. 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 |
| setApplicationVariables | | public String setApplicationVariables(String componentName, Properties appVariables, String targetName) throws ManagementRemoteException(Code) | | 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
Parameters:
appVariables - - set of application variables to update. The values of theapplication variables have the application variable type andvalue and the format is "[type]value"
Parameters:
targetName - identification of the target. Can be a standalone server,cluster or clustered instance.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 |
| setComponentConfiguration | | public String setComponentConfiguration(String componentName, Properties configurationValues, String targetName) throws ManagementRemoteException(Code) | | 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 -
Parameters:
configurationValue -
Parameters:
targetName - value as part of the management message (XML) String.
throws:
ManagementRemoteException - on error |
| setComponentConfiguration | | public String setComponentConfiguration(String componentName, Map<String /*attributeName*/, Object configurationValues, String targetName) throws ManagementRemoteException(Code) | | 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 -
Parameters:
configurationValues -
Parameters:
targetName - value as part of the management message (XML) String.
throws:
ManagementRemoteException - on error |
| setComponentLoggerLevel | | public void setComponentLoggerLevel(String componentName, String loggerCustomName, Level logLevel, String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Sets the component log level for a given custom logger
Parameters:
componentName - name of the component
Parameters:
loggerCustomName - the custom logger name
Parameters:
logLevel - the level to set the logger
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
throws:
ManagementRemoteException - on error |
| setRuntimeConfiguration | | public boolean setRuntimeConfiguration(Properties parameters, String targetName) throws ManagementRemoteException(Code) | | 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 correspondingto the configuration parameters to be set on the runtime.
Parameters:
targetName - cluster or instance name ( e.g. cluster1, instance1 ) on whichconfiguration parameters will be set. null to represent thedefault instance which is admin server true if server restart is required, false if not
throws:
ManagementRemoteException - if there is a jmx error or a invalid parameter is passed inthe params properties object. In case of an error setting thea particular parameter, the error message should list theinvalid parameters. |
| setRuntimeConfiguration | | public boolean setRuntimeConfiguration(Map<String /*attributeName*/, Object parameters, String targetName) throws ManagementRemoteException(Code) | | 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 correspondingto the configuration parameters to be set on the runtime.
Parameters:
targetName - cluster or instance name ( e.g. cluster1, instance1 ) on whichconfiguration parameters will be set. null to represent thedefault instance which is admin server true if server restart is required, false if not
throws:
ManagementRemoteException - if there is a jmx error or a invalid parameter is passed inthe params properties object. In case of an error setting thea particular parameter, the error message should list theinvalid parameters. |
| setRuntimeLoggerLevel | | public void setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName, String targetInstanceName) throws ManagementRemoteException(Code) | | Sets the log level for a given runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger
Parameters:
logLevel - the level to set the logger
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.)
throws:
ManagementRemoteException - on error |
| setRuntimeLoggerLevel | | public void setRuntimeLoggerLevel(String runtimeLoggerName, Level logLevel, String targetName) throws ManagementRemoteException(Code) | | Sets the log level for a given runtime logger
Parameters:
runtimeLoggerName - name of the runtime logger
Parameters:
logLevel - the level to set the logger
Parameters:
targetName - name of the target (e.g., cluster1, server, etc.)
throws:
ManagementRemoteException - on error |
| verifyApplication | | public String verifyApplication(String applicationURL, boolean generateTemplates, String templateDir, boolean includeDeployCommand, String targetName) throws ManagementRemoteException(Code) | | 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
Parameters:
generateTemplates - true if templates have to be generated
Parameters:
templateDir - the dir to store the generated templates
Parameters:
includeDeployCommand - true if the generated script should includedeploy command
Parameters:
targetName - the target on which the application has to be verified
throws:
ManagementRemoteException - if the application could not be verifiedNote: param templateDir is used between ant/cli and common client clientTemplateZIPID is used between common client server and common client client |
|
|