Index Changes

JBI Ant Tasks

In Sierra, the following Ant tasks will be added to the management of JBI runtime and component.

Ant Tasks for Runtime Loggers

  • Ant task to set runtime logger levels
  • Ant task to list runtime logger levels

Ant Tasks for Component Loggers

  • Ant task to set component logger levels
  • Ant task to list component logger levels

Ant Tasks for Runtime Configurations

  • Ant task to set runtime configurations
  • Ant task to list runtime configurations

Ant Tasks for Component Configurations

  • Ant task to set component configurations
  • Ant task to list component configurations

Ant Tasks for Application Confiugrations

  • Ant task to create application configurations
  • Ant task to update application configurations
  • Ant task to list application configurations
  • Ant task to delete application configurations

Ant Tasks for Application Variables

  • Ant task to create application variables
  • Ant task to update application variables
  • Ant task to list application variables
  • Ant task to delete application variables

Ant task to list monitoring statistics data, it includes six options

  • For framework
  • For NMR
  • For components
  • For endpoints
  • For service assemblies
  • all (default)

Ant task to upgrade a component:

  • Change existing JBI Ant task jbi-update-component to function like jbi-upgrade-component, and to issue a warning message that the task is deprecated and jbi-upgrade-component should be used instead.
  • New JBI ant task jbi-upgrade-component.

Ant tasks to verify/export application environment

  • The tasks will aid the system administrator in verifying if all the configurations needed by an application can be resolved during deployment.

Use Cases

Actor Inventory

  • Installed JBI component (Binding Component or Service Engine)
  • JBI Common Client
  • JBI Ant
  • Administrator: this is the administrative user using asant, asadmin, or the admin console
Use Case Name
Set configuration for JBI runtime or an installed component
Date written
08/03/2007
Description
This task modifies parameters for several different configuration types for JBI runtime or an installed component (SE or BC). Typically these configuration types include runtime/component configuration, application configuration, application variable and logger.
Actors
Installed JBI component, JBI Ant, Administrator, JBI common client
Preconditions & Assumptions
1. Based on different configuration type, the configuration parameters could be specified directly from command line, or in an input XML file, or in an input property file.
2. Component is assumed to be installed if the configuration for a component is going to be set.
3. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
4. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
5. If the target option is specified as a <cluster-name>, the task is executed against all instances in the specified cluster.
6. If the target option is specified as a <instance-name>, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the set configuration task which specifies an installed component (optional), the type of the configuration, the name of a configuration, the path to the file which contains the configuration parameters (optional), and a server instance name ("domain", or a cluster name, or not being specified).
Basic Flow: System Action
1. JBI Ant interprets the task and gets the configuration parameters.
2. JBI Ant passes all the parameters to JBI common client.
Error Flow: System Action
1. If the path to the input file is not a valid location, an error message should be returned from JBI Ant.
2. If the failure is due to the reason other than invalid file/path location, JBI Ant should print out the detailed failure message returned from JBI common client.
3. Administrator should get a failure message, detailing the reason why the set named configuration command fails.


Use Case Name
List configuration value for JBI runtime or an installed component.
Date written
08/03/2007
Description
This task lists parameters for several different configuration types for JBI runtime or an installed component (SE or BC). Typically these configuration types include runtime/component configuration, application configuration, application variable and logger.
Actors
Installed JBI component, JBI Ant, Administrator, JBI common client
Preconditions & Assumptions
1. Component is assumed to be installed if the configuration data is queried for an installed component.
2. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
3. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
4. If the target option is specified as a <cluster-name>, the task is executed against all instances in the specified cluster.
5. If the target option is specified as a <instance-name>, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the list configuration task with the required input such as configuration name key, configuration type, a component, a server instance name (or a cluster name, or not being specified).
Basic Flow: System Action
1. JBI Ant interprets the task, as well as the input parameters.
2. JBI Ant passes all the parameters to JBI common client.
3. JBI Ant prints out the configuration value (i.e., the query result) which is returned from JBI component client.


Use Case Name
Add application configuration data to an installed component.
Date written
08/03/2007
Description
This task adds configuration data for an installed component. The configuration data which can be added includes two configuration types: application configuration and application variable.
Actors
Installed JBI component, JBI Ant, Administrator, JBI common client
Preconditions & Assumptions
1. The specified component is assumed to be installed.
2. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
3. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
4. If the target option is specified as a <cluster-name>, the task is executed against all instances in the specified cluster.
5. If the target option is specified as a <instance-name>, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the add configuration task which specifies input parameters such as a configuration type, the name of the application configuration, application variable tuples (key/type/value), the component name, a server instance name ("domain", or a cluster name, or not being specified).
Basic Flow: System Action
1. JBI Ant interprets the task, as well as the input parameters.
2. JBI Ant passes all the parameters to JBI common client.


Use Case Name
Delete application configuration data from an installed component.
Date written
08/03/2007
Description
This task deletes configuration data for an installed component. The configuration data which can be deleted includes two configuration types: application configuration and application variable.
Actors
Installed JBI component, JBI Ant, Administrator, JBI common client
Preconditions & Assumptions
1. The specified component is assumed to be installed.
2. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
3. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
4. If the target option is specified as a <cluster-name>, the task is executed against all instances in the specified cluster.
5. If the target option is specified as a <instance-name>, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the delete configuration task which specifies input parameters such as a configuration type, the name of the named configuration, component environment variable tuples (key/type/value), the component name, a server instance name (or "domain", or a cluster name, or not being specified).
Basic Flow: System Action
1. JBI Ant interprets the task, as well as the input parameters.
2. JBI Ant passes all the parameters to JBI common client.


Use Case Name
List monitoring statistics data for JBI runtime or an installed component
Date written
08/03/2007
Description
This task prints out monitoring statistics data for JBI framework, or NMR, or an installed component, or an endpoint.
Actors
Installed JBI component, JBI Ant, Administrator, JBI common client
Preconditions & Assumptions
1. Component is assumed to be installed if the monitoring statistics data of the component is going to be queried.
2. When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
3. When the target option is the literal string 'domain', the task is executed against the domain itself, but not to any instances or clusters running on the domain.
4. If the target option is specified as a <cluster-name>, the task is executed against all instances in the specified cluster.
5. If the target option is specified as a <instance-name>, the task is executed against the specific instance specified.
Basic Flow: User Action
Administrator executes the list monitoring statistics task which specified the input parameters, such as the type of monitoring statistics data, an installed component name (optional), a server instance name (or "domain", or a cluster name, or not being specified).
Basic Flow: System Action
1. JBI Ant interprets the task and the included parameters.
2. JBI Ant passes all the parameters to JBI common client.
3. JBI Ant prints out the monitoring statistics data returned from JBI common client.


Use Case Name
Upgrade component
Date written
08/03/2007
Description
This command is to provide a simple way to upgrade a JBI component in a non-destructive way, preserving all existing deployments to that component.
Actors
Installed JBI component, JBI Ant, Administrator, JBI common client
Preconditions & Assumptions
The precondition is that the component, which will be upgraded, has already been deployed.
Basic Flow: User Action
Administrator executes the component upgrade task, specifying where the new archive is located.
Basic Flow: System Action
1. JBI Ant interprets the task and gets the input parameters.
2. Before calling JBI common client, JBI Ant validates the location of the archive.
3. JBI Ant passes all the parameters to JBI common client.
Error Flow: System Action
1. If the path to the new archive location is not a valid location, an error message should be returned from JBI Ant.
2. If the failure is due to the reason other than invalid archive location, JBI Ant should print out the detailed failure message returned from JBI common client.
3. Administrator should get a failure message, detailing the reason why the upgrade command fails.


Use Case Name
Application Verifier tasks
Date written
08/03/2007
Description
This project would aid the system administrator in verifying if all the configurations needed by an application can be resolved during deployment. For this use case, please refer to SierraUpdateAppVerifier


Jbi Ant Tasks Details

Tasks for Runtime Loggers

JbiSetRuntimeLoggersTask

  • Set runtime logger levels.

JbiListRuntimeLoggersTask

  • List runtime logger levels.

Tasks for Component Loggers

JbiSetComponentLoggersTask

  • Set logger levels for a component.

JbiListComponentLoggersTask

  • List logger levels for a component.

Runtime Configurations

JbiSetRuntimeConfigurationTask

  • Set runtime configurations.

JbiListRuntimeConfigurationTask

  • List runtime configurations.

Component Configurations

JbiSetComponentConfigurationTask

  • Set component configurations for a component.

JbiListComponentConfigurationTask

  • List component configurations for a component.

Application Configurations

JbiCreateApplicationConfigurationTask

  • Create an application configuration for a component

JbiUpdateApplicationConfigurationTask

  • Update an application configuration for a component

JbiListApplicationConfigurationsTask

  • List application configurations for a component

JbiDeleteApplicationConfigurationsTask

  • Delete application configurations for a component

Application Variables

JbiCreateApplicationVariablesTask

  • Create component environment variables for a component

JbiUpdateApplicationVariablesTask

  • Update component environment variables for a component

JbiListApplicationVariablesTask

  • List component environment variables for a component

JbiDeleteApplicationVariablesTask

  • Delete component environment variables for a component

Monitoring

JbiListStatisticsTask

  • List everything
  • List statistics values for NMR only
  • This option will list statistics values for framework only
  • List statistics values for all components for a target.
  • List statistics values for a particular component.
  • List statistics values for all endpoints for a target.
  • List statistics values for a particular service assembly.
  • List statistics values for all service assemblies for a target.

Component Upgrade

JbiUpgradeComponentTask

  • This task upgrades the specified component in the JBI runtime.
  • jbi-update-component will not be supported any more. In case users still use this task, we will issue a "not supported" message and suggest users to start to use jbi-upgrade-component.

Application Environment Verify/Export tasks

JbiVerifyApplicationEnvTask

  • Ant task that would aid the system administrator in verifying if all the configurations needed by an application can be resolved during deployment.

JbiExportApplicationEnvTask

  • Ant task that would aid the system administrator in verifying if all the configurations needed by an application can be resolved during deployment.


Runtime Configuration

set-runtime-configuration

  • Specified in a properties file
    • -Djbi.config.params.file
  • Specified as name/value pair
    • -Djbi.config.param.name
    • -Djbi.config.param.value

list-runtime-configuration

  • List a single configuration parameter
    • -Djbi.config.param.name
  • List all
    • No -Djbi.config.param.name is specified.

Component Configuration

set-component-configuration

  • Specified in a properties file
    • -Djbi.config.params.file
  • Specified as name/value pair
    • -Djbi.config.param.name
    • -Djbi.config.param.value

list-component-configuration

  • List a single configuration parameter
    • -Djbi.config.param.name
  • List all
    • No -Djbi.config.param.name is specified.

Application Configuration

create-application-configuration

  • Create an application configuration with a specified name
    • -Djbi.app.config.params.file
    • -Djbi.app.config.name

update-application-configuration

  • Update an application configuration
    • -Djbi.app.config.params.file
    • -Djbi.app.config.name

list-application-configurations

  • List a single application configuration for a component
    • -Djbi.app.config.name
  • List all application configurations for a component
    • No -Djbi.app.config.name is specified.

delete-application-configuration

  • Delete an application configuration
    • -Djbi.app.config.name

Application Variable

create-application-variable

  • Create a single application variable
    • -Djbi.app.variable.name
    • -Djbi.app.variable.type
    • -Djbi.app.variable.value
  • Create multiple application variables which are specified in properties file
    • -Djbi.app.variables.file

update-application-variable

  • Update a single application variable
    • -Djbi.app.variable.name
    • -Djbi.app.variable.type
    • -Djbi.app.variable.value
  • Update multiple application variables which are specified in properties file
    • -Djbi.app.variables.file

list-application-variables

  • List a single application variable for a component
    • -Djbi.app.variable.name
  • List all application variables for a component
    • No -Djbi.app.variable.key is specified

delete-application-variable

  • Delete a single application variable
    • -Djbi.app.variable.name
    • Multiple application variables can specified in this option, the different variable names are separated by ",". The example is like: -Djbi.app.variable.name="Foo1,Foo2,Foo3".

Runtime Loggers

set-runtime-logger

  • Set level for a specified logger
    • -Djbi.logger.name
    • -Djbi.logger.level

list-runtime-loggers

  • List logger level for a single logger
    • -Djbi.logger.name
  • List logger levels for all runtime loggers
    • No -Djbi.logger.name is specified.

Component Loggers

set-component-logger

  • Set level for a specified logger
    • -Djbi.logger.name
    • -Djbi.logger.level

list-component-loggers

  • List logger level for a single logger for a component
    • -Djbi.logger.name
  • List logger levels for all loggers of a specified component
    • No -Djbi.logger.name is specified.

Others

list-nmr-statistics

list-framework-statistics

list-component-statistics

list-service-assembly-statistics

list-endpoint-statistics

list-all-statistics

verify-application-environment

export-application-environment

JSPWiki v2.4.100
[RSS]
« Home Index Changes Prefs
This page (revision-160) was last changed on 13-Mar-08 08:42 AM, -0700 by Jeff Stein