Design Details

The following methods will be added in JBIAdminCommands. This is the common interface implemented by both client and server sides of common client.

     /**
     * 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.
     *
     * @param applicationURL the URL for the application zip file
     * @param targetName the target on which the application has to be verified
     * @param generateTemplates true if templates have to be generated
     * @param templateDir the dir to store the generated templates
     * @param includeDeployCommand true if the generated script should include
     * deploy command 
     *
     * @returns CompositeData the verification report
     * 
     * CompositeType of verification report
     *  String          - "ServiceAssemblyName",
     *  String          - "ServiceAssemblyDescription",
     *  Integer         - "NumServiceUnits",
     *  Boolean         - "AllComponentsInstalled",
     *  String[]        - "MissingComponentsList",
     *  CompositeData[] - "EndpointInfo",
     *  String          - "TemplateZIPID"
     * 
     * CompositeType of each EndpointInfo
     *  String    - "EndpointName",
     *  String    - "ServiceUnitName",
     *  String    - "ComponentName",
     *  String    - "Status"
     * 
     * @throws JBIRemoteException if the application could not be verified
     * 
     * Note: param templateDir is used between ant/cli and common client client.
     * TemplateZIPID is used between common client server and common client client.
     */
     public CompositeData verifyApplication(
             String applicationURL, 
             String targetName, 
             boolean generateTemplates,
             String templateDir,
             boolean includeDeployCommand) 
     throws JBIRemoteException;    
     
    /**
     * This method is used to export the application variables and 
     * application configuration objects used by the given 
     * application in the specified target. 
     *
     * @param applicationName the name of the application
     * @param targetName the target whose configuration has to be exported
     * @param configDir the dir to store the configurations
     * @returns String the id for the zip file with exported configurations
     *
     * @throws JBIRemoteException if the application configuration could not be exported
     *
     * Note: param configDir is used between ant/cli and common client client.
     * The return value is used between common client server and common client client.
     */
     public String exportApplicationConfiguration(
             String applicationName, 
             String targetName,
             String configDir) 
     throws JBIRemoteException;   

Ant commands

ant -f jbi_admin.xml verify-application
-Djbi.host=<host> -Djbi.port=<port> 
-Djbi.username=<user> -Djbi.password=<password> 
-Djbi.deploy.file=c:\tmp\sa1.zip -Djbi.target=server
-Djbi.generate.templates=true -Djbi.templates.dir=c:\tmp
-Djbi.include.deploy.command=true

ant -f jbi_admin.xml export-application-configuration
-Djbi.host=<host> -Djbi.port=<port> 
-Djbi.username=<user> -Djbi.password=<password> 
-Djbi.service.assembly.name=CompApp1 -Djbi.target=server
-Djbi.config.dir=c:\tmp