Task: jbi-set-component-configuration

Description

This task modifies the component configuration parameters for a JBI component. The task in this case takes configuration parameters as name/value pairs for setting the configuration parameters JBI component on a particular target (instance or cluster).

This task takes the configuration parameters as nested elements param or using 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	Password for user authentication.	Yes. Not required if passwordfile is set.
passwordfile	This application server-specific attribute processes the password from a properties file with the property "AS_ADMIN_PASSWORD". If you set the password and passwordfile attribute, passwordfile takes precedence.	No
failOnError	Signal task failure to Ant. The default value is "true".	No
params	Path to the configuration parameter file that contains the list of name/value pair configuration parameters.	No
componentName	Sets the configuration parameters for this component. Without this parameter, the configuration parameters are set for JBI runtime.	No
target	Specifies where the JBI administration tasks are performed. The default value is 'server'.	No

Nested Elements

param

This nested element is an optional child element. This element takes a name/value pair for setting the configuration parameters.

Attribute	Description	Required
name	Name of the configuration parameter.	Yes
value	Value of the configuration parameter to be set. If the operand contains spaces, the operand must be encased within double quotes. Spaces are taken literally.	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. This is only for JBI runtime configuration.
<cluster-name>	When a <cluster-name> is specified, the task is executed against all instances in the specified cluster.
<instance-name>	When an <instance-name> is specified, the task is executed against the specific instance specified.

Examples

The following code shows how to set the configuration parameters for JBI runtime and JBI components.

<!--
Load JBI task definitions.
Note:  This task is not included in the default task definitions in the asant environment.
You need to load the JBI task definitions in the Ant script in the asant environment.
-->
<taskdef resource="com/sun/jbi/ui/ant/antlib.xml" />


<!-- setting the JBI Component configuration parameters-->
<!-- setting configuration parameters using nested elements -->
<jbi-set-component-configuration username="admin" password="adminadmin" host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" >
       <param name="Foo1" value="bar1" />
       <param name="Foo2" value="bar2" />
</jbi-set-component-configuration>


<!-- setting configuration parameters using properties file -->
<jbi-set-component-configuration username="admin" password="adminadmin" host="localhost" port="7890" componentName="my-service-engine" params="dir/config-params.properties" /> 
       

Copyright 2008, Sun Microsystems, Inc.

---

Back to Glassfish9.1Ant or to GlassfishIntegration9.1

This page (revision-13) was last changed on 13-Mar-08 11:18 AM, -0700 by 192.18.101.18.
This page was created on 16-Nov-07 15:34 PM, -0800 by 192.18.101.18.

More info...