Task: jbi-install-component

Description

This task installs service engines and binding components. This task takes optional installation configuration parameters as name/value pairs for setting the attributes of the InstallerConfigurationMBean during installation. The task takes the configuration parameters as an optional nested elements param or using optional attribute params if the parameters are in a file. Parameters passed using the file override the parameters passed using nested elements if both file and nested elements set the same parameters.

Parameters

Attribute Description Required
host The machine name where the Domain Administration Server (DAS) is running. The default value is localhost. No
port The HTTP/S port for DAS administration. The default value is 4848. No
secure If set to true, uses SSL/TLS to communicate with the DAS. No
username The authorized DAS administrator user name. Yes
password Specifies a password for user authentication.

If you set a password with both the password attribute and the passwordfile attribute, the password specified in the passwordfile attribute is used for authentication.

If you do not set a password with both the password attribute and the passwordfile attribute, then no password is required.
Yes. Not required if passwordfile is set.
passwordfile Specifies a path to a password property file that is used for user authentication.

The password for user authentication is specified by the "AS_ADMIN_PASSWORD" property in the property file.

If you set a password with both the password attribute and the passwordfile attribute, the password specified in the passwordfile attribute is used for authentication.
No
failOnError Signal task failure to Ant. The default value is "true". No
name Cannot be set along with the file attribute. Component name to install component from the domain to other targets specified using the target attribute. Target attribute value cannot be set to 'domain'. The valid values for the target attribute are 'server', <cluster-name>, and <instance- name>. Yes
to install component from domain
file Cannot be set along with name attribute. Path to an archive file that contains the service engine or binding component implementation. Yes
to install component with new archive file
params Path to the installation configuration parameters file that contains the list of name/value pair installation configuration parameters. No
target Specifies where the JBI administration tasks are performed. The default value is 'server'. No

Nested Elements

param

This nested element is a optional child element. It uses installation configuration parameters passed to the install task. This element takes a name/value pair for setting the property of the InstallerConfigurationMBean implemented by the installer of the component.

Note that the attribute name is case sensitive. For example, if the ConfigurationMBean has a attribute Foo as a setFoo not as a setfoo, then the name attribute for the param element must be Foo. Passing the name attribute as foo results in a property not found error.

Attribute Description Required
name Name of the property on the InstallerConfigurationMbean.
Note that the attribute name is case sensitive.
Yes
value Value of the property to be set. No

Target Attribute Values

Target Attribute Value Behavior
'server' When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.
'domain' 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.
<cluster-name> When a <cluster-name> is specified, the task is executed against all instances in the specified cluster.
<instance-name> When a <instance-name> is specified, the task is executed against the specific instance specified.

Examples

The following code shows how to set the installation configuration mbean attributes during installation of the component.
<!--
Load JBI task definitions.
Note:  If you use the asant command, you do not need to load the JBI task defininitions
as they are already defined in the default task definitions in the asant environment.
-->
<taskdef resource="com/sun/jbi/ui/ant/antlib.xml" />
<!-- install component -->
<jbi-install-component host="localhost" port="7890" file="/mydir/bpel-engine.zip" target="server" />
<jbi-install-component  file="/mydir/component.zip" >
       <param name="Foo1" value="bar1" />
       <param name="Foo2" value="bar2" />
</jbi-install-component>
<!-- install component with the installation configuration parameters passed from the file -->
 <jbi-install-component  file="/mydir/component.zip"
       params="dir/params.properties" /> 
       
<!-- install component from domain to other targets -->
 <jbi-install-component  name="my_blep_engine" target="instance1" /> 
       
Contents of the params.properties file:
Foo1=bar1
Foo2=bar2
The above task sets the following attribute of the installation configurationMbean on the component.
MyConfigMBean {
    setFoo1(String value);
    setFoo2(String value);
}

Copyright 2007, Sun Microsystems, Inc.