| com.sun.esb.management.base.services.AbstractListStateServiceMBeansImpl
 com.sun.esb.management.impl.configuration.ConfigurationServiceMBeanImpl
| 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.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | addApplicationConfiguration(String componentName, String targetName, String name, CompositeData appConfig)
Add an application configuration. | | public 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. | | protected String | convertToString(Collection colxn)
Convert the objects in the collection to a printable string. | | public String | deleteApplicationConfiguration(String componentName, String targetName, String name)
Delete a named application configuration in a component installed on a
given target.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the 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. | | public TabularData | getApplicationConfigurationsAsTabularData(String componentName, String targetName)
Get a Map of all application configurations for the component. | | protected Map<String, Properties> | getApplicationConfigurationsMap(TabularData td)
Convert a application configuration TabularData to a Map keyed by the
"configurationName". | | public Properties | getApplicationVariables(String componentName, String targetName)
Get all the application variables set on a component.
all the application variables et on the component. | | public TabularData | getApplicationVariablesAsTabularData(String componentName, String targetName)
Get the Application Variable set for a component. | | public Properties | getComponentConfiguration(String componentName, String targetName)
| | public Map<String /*attributeName*/, Object | getComponentConfigurationAsMap(String componentName, String targetName)
| | protected ObjectName | getComponentConfigurationFacadeMBeanName(String componentName, String targetName)
Get the component configuration facade MBean name for the target. | | protected Properties | getComponentConfigurationForClusteredServer(String componentName, String targetName)
| | public Map<String, ObjectName[]> | getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName)
| | public ObjectName[] | getComponentExtensionMBeanObjectNames(String componentName, String extensionName, String targetName, String targetInstanceName)
| | public Map<String, String> | getComponentLoggerDisplayNames(String componentName, String targetName, String targetInstanceName)
Gets the component custom loggers and their display names. | | public Map<String, Level> | getComponentLoggerLevels(String componentName, String targetName, String targetInstanceName)
| | protected ObjectName | getConfigMBeanName(String componentName, String targetName)
| | protected Properties | getConfigurationAttributeValues(ObjectName objectName)
| | protected Map<String /*attributeName*/, Object | getConfigurationAttributeValuesAsMap(ObjectName objectName)
| | public ObjectName | getConfigurationMBeanObjectName(String targetName, String configurationType)
| | 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 Map<String /*attributeName*/, Object | getDefaultRuntimeConfigurationAsMapInternal(String targetName)
This method returns a tabular data of a complex open data objects that
represent the runtime configuration parameter descriptor. | | protected Properties | getDefaultRuntimeConfigurationInternal(String targetName)
| | protected String | getExistingAppVarType(String compName, String targetName, String appVarName)
| | protected ObjectName | getExtensionMBeanObjectName(String componentName, String targetName)
returns the ObjectName for the Extension Mbean of this component. | | public ObjectName | getLoggingServiceMBeanObjectName(String targetName)
returns the ObjectName for the LoggingService Mbean of this target. | | 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 | getRuntimeConfigurationInternal(String targetName)
| | public Properties | getRuntimeConfigurationMetaData(String propertyKeyName)
This method returns the runtime configuration metadata associated with
the specified property. | | Map<String /* propertyKeyName */, Properties> | getRuntimeConfigurationMetadataInternal(String targetName)
| | protected ObjectName | getRuntimeLoggerConfigFacadeMBeanName(String target)
| | public String | getRuntimeLoggerDisplayName(String runtimeLoggerName, String targetName)
Return the display name for a runtime logger
Parameters:
runtimeLoggerName - name of the logger (e.g. | | 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 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)
Gets all the runtime loggers and their levels. | | 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 need 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 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. | | 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.
Parameters:
componentName - component identification
Parameters:
targetName - identification of the target. | | public String | setApplicationConfiguration(String componentName, String targetName, String name, CompositeData appConfig)
Update a application configuration. | | public 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)
Set the component static configuration. | | 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. | | String | setComponentConfigurationForClusteredServer(String componentName, String targetName, Properties configurationValues)
Set component configuration for a clustered server (that is up)
Parameters:
componentName -
Parameters:
targetName -
Parameters:
configurationValues - a management message indicating the status of the operation. | | public void | setComponentLoggerLevel(String componentName, String loggerCustomName, Level logLevel, String targetName, String targetInstanceName)
| | protected String | setLevel(Level logLevel)
| | 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 properties, 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. | | protected boolean | setRuntimeConfigurationInternal(Properties properties, String targetName)
| | 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. |
| serialVersionUID | | final static long serialVersionUID(Code) | | |
| ConfigurationServiceMBeanImpl | | public ConfigurationServiceMBeanImpl(EnvironmentContext anEnvContext)(Code) | | Constructor - Constructs a new instance of ConfigurationServiceMBeanImpl
Parameters:
anEnvContext - |
| addApplicationConfiguration | | public 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 theoperation. For target=cluster, instance specific details areincluded.
throws:
ManagementRemoteException - if the application configuration cannot be added. |
| addApplicationVariable | | public 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 composite management message string which gives the status of theoperation. For target=cluster, instance specific details areincluded.
throws:
ManagementRemoteException - if an error occurs in adding the application variables to thecomponent. |
| convertToString | | protected String convertToString(Collection colxn)(Code) | | Convert the objects in the collection to a printable string.
Parameters:
set - a non-empty set |
| getApplicationConfigurationsAsTabularData | | public 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 acomponent keyed by the configuration name.
throws:
ManagementRemoteException - if there are errors encountered when updating theconfiguration. |
| getApplicationConfigurationsMap | | protected Map<String, Properties> getApplicationConfigurationsMap(TabularData td)(Code) | | Convert a application configuration TabularData to a Map keyed by the
"configurationName". The value is the application configuration
represented as properties.
a Map of application configuration properties |
| getComponentConfigurationFacadeMBeanName | | protected ObjectName getComponentConfigurationFacadeMBeanName(String componentName, String targetName) throws ManagementRemoteException(Code) | | Get the component configuration facade MBean name for the target. If the
component is not installed on the target, this returns a null.
Parameters:
componentName - -component id
Parameters:
targetName - -target name the ObjectName of the components facade Configuration MBean for atarget. |
| getComponentConfigurationForClusteredServer | | protected Properties getComponentConfigurationForClusteredServer(String componentName, String targetName) throws ManagementRemoteException(Code) | | Retrieve component configuration for a clustered server (that is up)
Parameters:
componentName -
Parameters:
targetName - the targetName as key and the name/value pairs as properties |
| 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
See Also: com.sun.esb.management.api.configuration.ConfigurationService.getComponentExtensionMBeanObjectNames(java.lang.Stringjava.lang.Stringjava.lang.Stringjava.lang.String) |
| getConfigMBeanName | | protected ObjectName getConfigMBeanName(String componentName, String targetName) throws ManagementRemoteException(Code) | | Find the actual object config MBean Name -- used by both g/setting
component configuations for clustered servers
Parameters:
componentName -
Parameters:
targetName - the actual component's config MBean name |
| 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
See Also: com.sun.esb.management.api.configuration.ConfigurationService.getDefaultRuntimeConfiguration |
| 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.
Map that represents the list of configuration parameterdescriptors.
throws:
ManagementRemoteException - if there is a jmx error accessing the instance |
| getDefaultRuntimeConfigurationAsMapInternal | | public Map<String /*attributeName*/, Object getDefaultRuntimeConfigurationAsMapInternal(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 |
| getExistingAppVarType | | protected String getExistingAppVarType(String compName, String targetName, String appVarName)(Code) | | the type of the actual application variable |
| getExtensionMBeanObjectName | | protected ObjectName getExtensionMBeanObjectName(String componentName, String targetName) throws ManagementRemoteException(Code) | | returns the ObjectName for the Extension Mbean of this component.
Parameters:
componentName -
Parameters:
targetName - the ObjectName of the Extension MBean or null. |
| getLoggingServiceMBeanObjectName | | public ObjectName getLoggingServiceMBeanObjectName(String targetName)(Code) | | returns the ObjectName for the LoggingService Mbean of this target.
Parameters:
targetName - the ObjectName of the LoggingService MBean or null. |
| 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
See Also: com.sun.esb.management.api.configuration.ConfigurationService.getRuntimeConfiguration(java.lang.String) |
| 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 | | public 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 -
See Also: com.sun.esb.management.api.configuration.ConfigurationService.getRuntimeConfigurationMetaData(java.lang.String) |
| getRuntimeLoggerConfigFacadeMBeanName | | protected ObjectName getRuntimeLoggerConfigFacadeMBeanName(String target)(Code) | | the runtime logger configuration facade MBean Name for the specific target. |
| 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:
ManagementRemoteException - on error |
| 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:
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.)
Parameters:
targetInstanceName - name of the target instance (e.g., cluster1-instance1, etc.) the matching Log Level.
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 MBeans
throws:
ManagementRemoteException - on error |
| getRuntimeLoggerNames | | public Map<String /* display name */, String getRuntimeLoggerNames(String targetName) 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 MBeans
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. |
| queryApplicationConfigurationType | | public 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 - on errors |
| 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 - on errors. |
| setApplicationConfiguration | | public 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 theoperation. For target=cluster, instance specific details areincluded.
throws:
ManagementRemoteException - if there are errors encountered when updating theconfiguration. |
| setApplicationVariable | | public 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 composite 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 |
| 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 |
| setComponentConfigurationForClusteredServer | | String setComponentConfigurationForClusteredServer(String componentName, String targetName, Properties configurationValues) throws ManagementRemoteException(Code) | | Set component configuration for a clustered server (that is up)
Parameters:
componentName -
Parameters:
targetName -
Parameters:
configurationValues - a management message indicating the status of the operation. Ifthe operation fails a JBIException ( encapsulated in theManagementRemoteException ) is thrown, the exception message is amanagement XML message and gives the failure details. |
| 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 logger
Parameters:
componentName - name of the component
Parameters:
loggerName - the component logger name
Parameters:
logLevel - the level to set the logger; when null, reverts the logger toinherit its level from its parent 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
See Also: com.sun.esb.management.api.configuration.ConfigurationService.setComponentLoggerLevel(java.lang.Stringjava.lang.Stringjava.util.logging.Leveljava.lang.Stringjava.lang.String) |
| setLevel | | protected String setLevel(Level logLevel)(Code) | | Return the "verb" (the setXXX MBean operation) for the given log level
Parameters:
logLevel - log level to set logger to a MBean operation to set the logger to that level |
| 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:
Properties - params Properties object that contains name/value pairscorresponding to the configuration parameters to be set on theruntime.
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.
See Also: com.sun.esb.management.api.configuration.ConfigurationService.setRuntimeConfiguration(java.util.Propertiesjava.lang.String) |
| setRuntimeConfiguration | | public boolean setRuntimeConfiguration(Map<String /*attributeName*/, Object properties, 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) 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 include deploy 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 clientclient
See Also: com.sun.esb.management.api.configuration.ConfigurationService.verifyApplication(java.lang.Stringjava.lang.Stringbooleanjava.lang.Stringboolean) |
| Methods inherited from com.sun.esb.management.base.services.AbstractListStateServiceMBeansImpl | protected void componentStartedOnTargetCheck(String componentName, String target) throws ManagementRemoteException(Code)(Java Doc)
protected ObjectName getComponentLifeCycleMBeanObjectName(String componentName, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected Collection getComponentNamesDependentOnServiceAssembly(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String saName, String targetName)(Code)(Java Doc)
protected Collection getComponentNamesDependentOnServiceAssembly(String saId, String targetName)(Code)(Java Doc)
protected Collection getComponentNamesDependentOnSharedLibrary(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String slibName, String targetName)(Code)(Java Doc)
protected Collection getComponentNamesDependentOnSharedLibrary(String slibName, String targetName)(Code)(Java Doc)
protected Collection getComponentNamesDependentOnSharedLibraryAndServiceAssembly(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String slibName, String saName, String targetName)(Code)(Java Doc)
protected Set getComponentNamesWithStatus(ComponentType frameworkCompType, ComponentState frameworkCompStatus, String targetName)(Code)(Java Doc)
protected String getComponentState(String componentName, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected Map<String, Descriptor> getConfigurationDescriptors(ObjectName objectName) throws ManagementRemoteException(Code)(Java Doc)
protected List getFrameworkComponentInfoList(Collection compNameList, String targetName)(Code)(Java Doc)
protected List getFrameworkComponentInfoListForEnginesAndBindings(ComponentType frameworkCompType, ComponentState frameworkCompState, String sharedLibraryName, String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected List getFrameworkComponentInfoListForSharedLibraries(String componentName, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected List getFrameworkComponentInfoListForSharedLibraryNames(Collection slibNameList, String targetName)(Code)(Java Doc)
protected ComponentQuery getFrameworkComponentQuery(String targetName)(Code)(Java Doc)
protected List getServiceAssemblyInfoList(String frameworkState, String componentName, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected ObjectName[] getSystemLoggerMBeans(String instanceName)(Code)(Java Doc)
protected List getUiComponentInfoList(ComponentType frameworkCompType, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected boolean isExistingComponent(String componentName, String targetName)(Code)(Java Doc)
protected boolean isExistingSharedLibrary(String sharedLibraryName, String targetName)(Code)(Java Doc)
protected String listComponents(ComponentType type, String state, String sharedLibraryName, String serviceAssemblyName, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected static ComponentState toFrameworkComponentInfoState(String uiCompState)(Code)(Java Doc)
protected static ComponentType toFrameworkComponentInfoType(String uiCompType)(Code)(Java Doc)
protected static String toFrameworkServiceAssemblyState(String uiState)(Code)(Java Doc)
protected JBIComponentInfo toUiComponentInfo(ComponentInfo frameworkCompInfo, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected List toUiComponentInfoList(List frameworkCompList, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected static String toUiComponentInfoState(ComponentState frameworkCompState)(Code)(Java Doc)
protected static String toUiComponentInfoType(ComponentType frameworkCompType)(Code)(Java Doc)
protected static String toUiServiceAssemblyState(String frameworkState)(Code)(Java Doc)
protected static String toUiServiceUnitState(String frameworkState)(Code)(Java Doc)
protected void updateEachServiceUnitInfoStateInServiceAssemblyInfo(ServiceAssemblyInfo saInfo, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected void updateServiceAssemblyInfoState(ServiceAssemblyInfo saInfo, String targetName) throws ManagementRemoteException(Code)(Java Doc)
protected void updateServiceUnitInfoState(ServiceUnitInfo suInfo, ObjectName deploymentServiceMBean)(Code)(Java Doc)
protected void validateUiJBIComponentInfoState(String state) throws ManagementRemoteException(Code)(Java Doc)
protected void validateUiServiceAssemblyInfoState(String state) throws ManagementRemoteException(Code)(Java Doc)
|
|
|