Jbi Set Component Configuration Task - OpenESB: the Open Source ESB for SOA & Integration

Not logged in | Login

Jbi Set Component Configuration Task

view | edit | clone | find [ f ]

Your trail:

Index Changes

Page Difference

Difference between version and version

Back to Jbi Set Component Configuration Task, or Jbi Set Component Configuration Task Info

At line 5 changed 1 line.

<title>jbi-set-componennt-configurations</title>

<title>jbi-set-componennt-configuration</title>

At line 13 changed 1 line.

<h2><a name="ant">Task: jbi-set-configuration</a></h2>

<h2><a name="ant">Task: jbi-set-component-configuration</a></h2>

At line 15 added 1 line.

<h3>Description</h3>

At line 16 removed 3 lines.

<h3>Component Configuration</h3>

<h4>Description</h4>

At line 20 changed 1 line.

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

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).

At line 23 changed 2 lines.

In this default usage, it takes the configuration parameters as nested elements <em>param</em> or using attribute <em>params</em> 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.

This task takes the configuration parameters as nested elements <em>param</em> or using attribute <em>params</em> 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.

At line 95 changed 3 lines.

This aplication 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.

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.

At line 120 changed 1 line.

Path to the configuration parameters file that contains the list of name/value pair configuration parameters. </td>

Path to the configuration parameter file that contains the list of name/value pair configuration parameters. </td>

At line 130 changed 1 line.

sets the configuration paramters for this component.

Sets the configuration parameters for this component.

At line 155 changed 1 line.

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

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

At line 182 changed 1 line.

Value of the configuration parameter to be set.

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.

At line 213 changed 1 line.

<td>When a <instance-name> is specified, the task is executed against the specific instance specified.</td>

<td>When an <instance-name> is specified, the task is executed against the specific instance specified.</td>

At line 218 changed 1 line.

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

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

At line 223 changed 1 line.

you need to load the JBI task defininitions in the Ant script in the asant environment.

You need to load the JBI task definitions in the Ant script in the asant environment.

At line 225 changed 11 lines.

<taskdef resource="com/sun/jbi/ui/ant/antlib.xml" /&

2000

amp;gt;

<!-

2000

- setting the JBI runtime configuration -->

<jbi-set-configuration host="localhost" port="7890" target="my-cluster" >

</jbi-set-configuration>

At line 237 changed 1 line.

At line 239 changed 1 line.

<jbi-set-configuration host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" >

<jbi-set-component-configuration username="admin" password="adminadmin" host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" >

At line 242 changed 1 line.

</jbi-set-configuration>

</jbi-set-component-configuration>

</br>

At line 244 changed 1 line.

<jbi-set-configuration componentName="my-service-engine" params="dir/config-params.properties" />

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

At line 249 removed 1 line.

<!-- ############### Application Configuration #################### --/>

At line 251 removed 701 lines.

<h3>Application Configuration</h3>

<h4>Description</h4>

<p>

This is one of the use cases for this task and it modifies the application configuration parameters for a JBI component. The task in this case takes application configuration parameters as name/value pairs for setting the application configuration parameters of a JBI component on a particular target (instance or cluster).

</p>

<p>

In this use case,

* this task uses nested elements <em>application-configuration</em> to tell that jbi-set-configuration task will be executed against application configuration

* this task takes the application configuration parameters as name/value pairs.

** An application variable can be referenced by elements <em>application-configuration</em>

* or takes the application configuration parameters using attribute <em>params</em> 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.

</p>

<h3>Parameters</h3>

<td valign="top"><b>Attribute</b></td>

<td valign="top"><b>Description</b></td>

<td align="center" valign="top"><b>Required</b></td>

</tr>

<tr>

host

</td>

The machine name where the Domain Administration Server (DAS) is running. The default value is localhost.

</td>

</td>

</tr>

<tr>

port

</td>

The HTTP/S port for DAS administration. The default value is 4848.

</td>

</td>

</tr>

<tr>

<td valign="top">secure</td>

<td>If set to true, uses SSL/TLS to communicate with the DAS.

</td>

</tr>

<tr>

username

</td>

The authorized DAS administrator user name.

</td>

Yes

</td>

</tr>

<tr>

password

</td>

Password for user authentication.

</td>

Yes. Not required if passwordfile is set.

</td>

</tr>

<tr>

passwordfile

</td>

This aplication 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.

</td>

</td>

</tr>

<tr>

failOnError

</td>

Signal task failure to Ant. The default value is "true".

</td>

</td>

</tr>

<tr>

params

</td>

Path to the configuration parameters file that contains the list of name/value pair configuration parameters. </td>

</td>

</tr>

<tr>

componentName

</td>

sets the configuration parameters for this component.

<br>Without this parameter, the configuration parameters are set for JBI runtime.

</td>

</td>

</tr>

<tr>

target

</td>

Specifies where the JBI administration tasks are performed. The default value is 'server'.

</td>

</td>

</tr>

</table>

<h3>Nested Elements</h3>

<h4>

appconfig

</h4>

<p>

This nested element is an optional child element which indicates that this task is executed against application configuration. It may include <em>param</em> elements which takes a name/value pair for setting the application configuration entries.

<br>

</p>

<td valign="top"><b>Attribute</b></td>

<td valign="top"><b>Description</b></td>

<td align="center" valign="top"><b>Required</b></td>

</tr>

<tr>

name

</td>

Name of the application configuration.

</td>

</td>

</tr>

</table>

<h4>

param

</h4>

<p>

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

<br>

</p>

<td valign="top"><b>Attribute</b></td>

<td valign="top"><b>Description</b></td>

<td align="center" valign="top"><b>Required</b></td>

</tr>

<tr>

name

</td>

Name of the configuration parameter.

</td>

Yes

</td>

</tr>

<tr>

value

</td>

Value of the configuration parameter to be set.

</td>

</td>

</tr>

<tr>

appvariable

</td>

reference to an application variable.

</td>

</td>

</tr>

</table>

<h3>Target Attribute Values</h3>

<td valign="top"><b>Target Attribute Value</b></td>

<td valign="top"><b>Behavior</b></td>

</tr>

<tr>

<td>'server'</td>

<td>When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.</td>

</tr>

<tr>

<td>When a <cluster-name> is specified, the task is executed against all instances in the specified cluster.</td>

</tr>

<tr>

<td>When a <instance-name> is specified, the task is executed against the specific instance specified.</td>

</tr>

</table>

<h3>Examples</h3>

The following code shows how to set the application configuration for JBI Components.

<pre>

<!--

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 defininitions in the Ant script in the asant environment.

-->

<jbi-set-configuration host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" >

</appconfig>

</jbi-set-configuration>

<br/>

<jbi-set-configuration host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" >

</appconfig>

</jbi-set-configuration>

<br/>

<jbi-set-configuration componentName="my-service-engine" params="dir/config-params.properties" >

</jbi-set-configuration>

</pre>

<br/>

<!-- ############### Application Variable #################### --/>

<h3>Application Variable</h3>

<h4>Description</h4>

<p>

This is one of the use cases for this task and it modifies the application variables for a JBI component. The task in this case takes application variable parameters as key/type/value tuples for setting the application variable parameters of a JBI component on a particular target (instance or cluster).

</p>

<p>

In this use case,

* this task uses nested elements <em>application-variable</em> to tell that jbi-set-configuration task will be executed against application variable.

* this task takes the application variable parameters as key/type/value tuple.

** An application variable can be referenced by elements <em>application-configuration</em>

* or takes the application variable parameters using attribute <em>params</em> 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.

</p>

<h3>Parameters</h3>

<td valign="top"><b>Attribute</b></td>

<td valign="top"><b>Description</b></td>

<td align="center" valign="top"><b>Required</b></td>

</tr>

<tr>

host

</td>

The machine name where the Domain Administration Server (DAS) is running. The default value is localhost.

</td>

</td>

</tr>

<tr>

port

</td>

The HTTP/S port for DAS administration. The default value is 4848.

</td>

</td>

</tr>

<tr>

<td valign="top">secure</td>

<td>If set to true, uses SSL/TLS to communicate with the DAS.

</td>

</tr>

<tr>

username

</td>

The authorized DAS administrator user name.

</td>

Yes

</td>

</tr>

<tr>

password

</td>

Password for user authentication.

</td>

Yes. Not required if passwordfile is set.

</td>

</tr>

<tr>

passwordfile

</td>

This aplication 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.

</td>

</td>

</tr>

<tr>

failOnError

</td>

Signal task failure to Ant. The default value is "true".

</td>

</td>

</tr>

<tr>

params

</td>

Path to the configuration parameters file that contains the list of name/value pair configuration parameters. </td>

</td>

</tr>

<tr>

componentName

</td>

sets the configuration paramters for this component.

<br>Without this parameter, the configuration parameters are set for JBI runtime.

</td>

</td>

</tr>

<tr>

target

</td>

Specifies where the JBI administration tasks are performed. The default value is 'server'.

</td>

</td>

</tr>

</table>

<h3>Nested Elements</h3>

<h4>

variable

</h4>

<p>

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

<br>

</p>

<td valign="top"><b>Attribute</b></td>

<td valign="top"><b>Description</b></td>

<td align="center" valign="top"><b>Required</b></td>

</tr>

<tr>

key

</td>

key of the application variable.

</td>

Yes

</td>

</tr>

<tr>

type

</td>

type of the application variable.

</td>

No, the default value is "string". The possible values are "string", "number", boolean" and "password".

</td>

</tr>

<tr>

value

</td>

Value of the application variable to be set.

</td>

</td>

</tr>

</table>

<h3>Target Attribute Values</h3>

<td valign="top"><b>Target Attribute Value</b></td>

<td valign="top"><b>Behavior</b></td>

</tr>

<tr>

<td>'server'</td>

<td>When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.</td>

</tr>

<tr>

<td>When a <cluster-name> is specified, the task is executed against all instances in the specified cluster.</td>

</tr>

<tr>

<td>When a <instance-name> is specified, the task is executed against the specific instance specified.</td>

</tr>

</table>

<h3>Examples</h3>

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

<pre>

<!--

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 defininitions in the Ant script in the asant environment.

-->

<jbi-set-configuration host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" >

</jbi-set-configuration>

<br/>

<br/>

<jbi-set-configuration componentName="my-service-engine" params="dir/config-params.properties" >

</jbi-set-configuration>

</pre>

<br/>

<!-- ############################# Logger configuration ######################################### --/>

<h3>Logger Configuration </h3>

<h4>Description</h4>

<p>

This is the default use case for this task and it modifies the logger configuration parameters on the JBI runtime or a JBI component.

</p>

<p>

* For compoent loggers, the logger names should always start with component name, such as sun-javaee-engine or sun-javaee-engine.logger1.

* Otherwise, the logger name is assumed as one of the system loggers, such as javax.enterprise.system.tools.deployment.

* An error will be returned, if the logger name is neither a component logger, nor a system logger.

* When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.

* For system loggers, the target can be a standalone instance, "domain" (literal), or a cluster, or a clustered instance.

* For component loggers, the target can be a standalone instance, or a cluster, or a clustered instance.

</p>

<h3>Parameters</h3>

<td valign="top"><b>Attribute</b></td>

<td valign="top"><b>Description</b></td>

<td align="

2000

;center" valign="top"><b

2000

>Required</b></td>

</tr>

<tr>

host

</td>

The machine name where the Domain Administration Server (DAS) is running. The default value is localhost.

</td>

</td>

</tr>

<tr>

port

</td>

The HTTP/S port for DAS administration. The default value is 4848.

</td>

</td>

</tr>

<tr>

<td valign="top">secure</td>

<td>If set to true, uses SSL/TLS to communicate with the DAS.

</td>

</tr>

<tr>

username

</td>

The authorized DAS administrator user name.

</td>

Yes

</td>

</tr>

<tr>

password

</td>

Password for user authentication.

</td>

Yes. Not required if passwordfile is set.

</td>

</tr>

<tr>

passwordfile

</td>

This aplication 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.

</td>

</td>

</tr>

<tr>

failOnError

</td>

Signal task failure to Ant. The default value is "true".

</td>

</td>

</tr>

<tr>

params

</td>

Path to the configuration parameters file that contains the list of name/value pair configuration parameters. </td>

</td>

</tr>

<tr>

componentName

</td>

sets the configuration paramters for this component.

<br>Without this parameter, the configuration parameters are set for JBI runtime.

</td>

</td>

</tr>

<tr>

target

</td>

Specifies where the JBI administration tasks are performed. The default value is 'server'.

</td>

</td>

</tr>

</table>

<h3>Target Attribute Values</h3>

<td valign="top"><b>Target Attribute Value</b></td>

<td valign="top"><b>Behavior</b></td>

</tr>

<tr>

<td>'server'</td>

<td>When the target option is not specified, or the literal string 'server' is specified, the task is executed against the embedded DAS server instance.</td>

</tr>

<tr>

<td>'domain'</td>

<td>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. </td>

</tr>

<tr>

<td>When a <cluster-name> is specified, the task is executed against all instances in the specified cluster.</td>

</tr>

<tr>

<td>When a <instance-name> is specified, the task is executed against the specific instance specified.</td>

</tr>

</table>

<h3>Examples</h3>

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

<pre>

<!--

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 defininitions in the Ant script in the asant environment.

-->

<jbi-set-configuration host="localhost" port="7890" target="my-cluster" >

</jbi-set-configuration>

<br/>

<jbi-set-configuration host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" >

</jbi-set-configuration>

</pre>

<br/>

At line 953 changed 1 line.

G'day, Anonymous Guest

JSPWiki v2.4.100

« Home Index Changes Prefs

This page (revision-13) was last changed on 13-Mar-08 11:18 AM, -0700 by 192.18.101.18

JSPWiki v2.4.100

Copyright © 2011, Oracle and/or its affiliates. All rights reserved. Oracle and Java are registered trademarks of Oracle and/or its affiliates. Other names may be trademarks of their respective owners.