Proposed Changes to Common Client APIs for Runtime Configuration

The following two methods will be added to the Common Client interface

public interface com.sun.jbi.ui.common.JBIAdminCommands {

    /**
     * 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.
     *
     * @param targetName cluster or instance name ( e.g. cluster1, instance1 ) on 
     * which configuration parameters will be set.  null to represent the default
     * instance which is admin server
     *
     * @param params Properties object that contains name/value pairs corresponding 
     * to the configuration parameters to be set on the runtime.
     *
     * @throws JBIRemoteException if there is a jmx error or a invalid parameter is
     * passed in the params properties object. In case of an error setting the a
     * particular parameter, the error message should list the invalid parameters.
     */
    public void setConfiguration(Properties params, String targetName) 
       throws JBIRemoteException;
    
    /**
     * 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 <min> - <max> 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.
     *
     * @param targetName cluster or instance name ( e.g. cluster1, instance1 ) on 
     * which configuration parameters will be set.  null to represent the default
     * instance which is admin server
     *
     * @return TabularData that represents the list of configuration parameter descriptors.
     *
     * @throws JBIRemoteException if there is a jmx error accessing the instance
     */
    public javax.management.openmbean.TabularData listConfiguration(String targetName) 
       throws JBIRemoteException;

}

This page (revision-3) was last changed on 23-Apr-07 18:09 PM, -0700 by srini_chikkala.
This page was created on 23-Apr-07 18:05 PM, -0700 by srini_chikkala.

More info...