Index Changes

Difference between version and version     

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


At line 249 removed 1 line.
<!-- ############### Application Configuration #################### --/>
At line 251 removed 705 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>
<table border="1" cellpadding="2" cellspacing="0">
<tr bgcolor="#5382A1" style="color: white;">
<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>
<td valign="top">
host
</td>
<td valign="top">
The machine name where the Domain Administration Server (DAS) is running. The default value is localhost.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
port
</td>
<td valign="top">
The HTTP/S port for DAS administration. The default value is 4848.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">secure</td>
<td>If set to true, uses SSL/TLS to communicate with the DAS.
</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">
username
</td>
<td valign="top">
The authorized DAS administrator user name.
</td>
<td valign="top" align="center">
Yes
</td>
</tr>
<tr>
<td valign="top">
password
</td>
<td valign="top">
Password for user authentication.
</td>
<td align="center" valign="top">
Yes. Not required if passwordfile is set.
</td>
</tr>
<tr>
<td valign="top">
passwordfile
</td>
<td valign="top">
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 align="center" valign="top">
No
</td>
</tr>
<tr>
<td valign="top">
failOnError
</td>
<td valign="top">
Signal task failure to Ant. The default value is &quot;true&quot;.
</td>
<td align="center" valign="top">
No
</td>
</tr>
<tr>
<td valign="top">
params
</td>
<td valign="top">
Path to the configuration parameters file that contains the list of name/value pair configuration parameters. </td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
componentName
</td>
<td valign="top">
sets the configuration parameters for this component.
<br>Without this parameter, the configuration parameters are set for JBI runtime.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
target
</td>
<td valign="top">
Specifies where the JBI administration tasks are performed. The default value is 'server'.
</td>
<td align="center" valign="top">
No
</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>
<table border="1" cellpadding="2" cellspacing="0">
<tr bgcolor="#5382A1" style="color: white;">
<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>
<td valign="top">
name
</td>
<td valign="top">
Name of the application configuration.
</td>
<td valign="top" align="center">
No
</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>
<table border="1" cellpadding="2" cellspacing="0">
<tr bgcolor="#5382A1" style="color: white;">
<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>
<td valign="top">
name
</td>
<td valign="top">
Name of the configuration parameter.
</td>
<td valign="top" align="center">
Yes
</td>
</tr>
<tr>
<td valign="top">
value
</td>
<td valign="top">
Value of the configuration parameter to be set.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
appvariable
</td>
<td valign="top">
reference to an application variable.
</td>
<td valign="top" align="center">
No
</td>
</tr>
</table>
<h3>Target Attribute Values</h3>
<table border="1" cellpadding="6" cellspacing="0">
<tr bgcolor="#AAD5D5" style="color: white;">
<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>&lt;cluster-name&gt;</td>
<td>When a &lt;cluster-name&gt; is specified, the task is executed against all instances in the specified cluster.</td>
</tr>
<tr>
<td>&lt;instance-name&gt;</td>
<td>When a &lt;instance-name&gt; 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>
&lt;!--
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.
--&gt;
&lt;taskdef resource="com/sun/jbi/ui/ant/antlib.xml" /&gt;
&lt;!-- setting named configuration using nested elements --&gt;
&lt;jbi-set-configuration host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" &gt;
&lt;appconfig name="name1"&gt;
&lt;param name="Foo1" value="bar1" /&gt;
&lt;param name="Foo2" value="bar2" /&gt;
&lt;/appconfig&gt;
&lt;/jbi-set-configuration&gt;
<br/>
&lt;!-- setting application configuration using nested elements --&gt;
&lt;jbi-set-configuration host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" &gt;
&lt;appconfig name="name1"&gt;
&lt;param name="Foo1" value="bar1" /&gt;
&lt;param name="Foo2" appvariable="varkey1" /&gt;
&lt;/appconfig&gt;
&lt;/jbi-set-configuration&gt;
&lt;!-- setting configuration parameters using properties file --&gt;
<br/>
&lt;jbi-set-configuration componentName="my-service-engine" params="dir/config-params.properties" &gt;
&lt;!--The empty nested element of configname tells that this is for named configuration--&gt;
&lt;appconfig/&gt;
&lt;/jbi-set-configuration&gt;
</pre>
<br/>
<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>
<table border="1" cellpadding="2" cellspacing="0">
<tr bgcolor="#5382A1" style="color: white;">
<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>
<td valign="top">
host
</td>
<td valign="top">
The machine name where the Domain Administration Server (DAS) is running. The default value is localhost.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
port
</td>
<td valign="top">
The HTTP/S port for DAS administration. The default value is 4848.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">secure</td>
<td>If set to true, uses SSL/TLS to communicate with the DAS.
</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">
username
</td>
<td valign="top">
The authorized DAS administrator user name.
</td>
<td valign="top" align="center">
Yes
</td>
</tr>
<tr>
<td valign="top">
password
</td>
<td valign="top">
Password for user authentication.
</td>
<td align="center" valign="top">
Yes. Not required if passwordfile is set.
</td>
</tr>
<tr>
<td valign="top">
passwordfile
</td>
<td valign="top">
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 align="center" valign="top">
No
</td>
</tr>
<tr>
<td valign="top">
failOnError
</td>
<td valign="top">
Signal task failure to Ant. The default value is &quot;true&quot;.
</td>
<td align="center" valign="top">
No
</td>
</tr>
<tr>
<td valign="top">
params
</td>
<td valign="top">
Path to the configuration parameters file that contains the list of name/value pair configuration parameters. </td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
componentName
</td>
<td valign="top">
sets the configuration paramters for this component.
<br>Without this parameter, the configuration parameters are set for JBI runtime.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
target
</td>
<td valign="top">
Specifies where the JBI administration tasks are performed. The default value is 'server'.
</td>
<td align="center" valign="top">
No
</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>
<table border="1" cellpadding="2" cellspacing="0">
<tr bgcolor="#5382A1" style="color: white;">
<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>
<td valign="top">
key
</td>
<td valign="top">
key of the application variable.
</td>
<td valign="top" align="center">
Yes
</td>
</tr>
<tr>
<td valign="top">
type
</td>
<td valign="top">
type of the application variable.
</td>
<td valign="top" align="center">
No, the default value is "string". The possible values are "string", "number", boolean" and "password".
</td>
</tr>
<tr>
<td valign="top">
value
</td>
<td valign="top">
Value of the application variable to be set.
</td>
<td valign="top" align="center">
No
</td>
</tr>
</table>
<h3>Target Attribute Values</h3>
<table border="1" cellpadding="6" cellspacing="0">
<tr bgcolor="#AAD5D5" style="color: white;">
<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>&lt;cluster-name&gt;</td>
<td>When a &lt;cluster-name&gt; is specified, the task is executed against all instances in the specified cluster.</td>
</tr>
<tr>
<td>&lt;instance-name&gt;</td>
<td>When a &lt;instance-name&gt; 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>
&lt;!--
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.
--&gt;
&lt;taskdef resource="com/sun/jbi/ui/ant/antlib.xml" /&gt;
&lt;!-- setting the JBI runtime configuration --&gt;
&lt;!-- setting configuration parameters using nested elements --&gt;
&lt;jbi-set-configuration host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" &gt;
&lt;appvariable key="Foo1" value="bar1" /&gt;
&lt;appvariable key="Foo2" type="Number" value="10" /&gt;
&lt;/jbi-set-configuration&gt;
<br/>
&lt;!-- setting configuration parameters using properties file --&gt;
<br/>
&lt;jbi-set-configuration componentName="my-service-engine" params="dir/config-params.properties" &gt;
&lt;!--The empty nested element of <em>variable</em> tells that this is for environment variable--&gt;
&lt;appvariable/&gt;
&lt;/jbi-set-configuration&gt;
</pre>
<br/>
<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>
<table border="1" cellpadding="2" cellspacing="0">
<tr bgcolor="#5382A1" style="color: white;">
<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>
<td valign="top">
host
</td>
<td valign="top">
The machine name where the Domain Administration Server (DAS) is running. The default value is localhost.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
port
</td>
<td valign="top">
The HTTP/S port for DAS administration. The default value is 4848.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">secure</td>
<td>If set to true, uses SSL/TLS to communicate with the DAS.
</td>
<td valign="top" align="center">No</td>
</tr>
<tr>
<td valign="top">
username
</td>
<td valign="top">
The authorized DAS administrator user name.
</td>
<td valign="top" align="center">
Yes
</td>
</tr>
<tr>
<td valign="top">
password
</td>
<td valign="top">
Password for user authentication.
</td>
<td align="center" valign="top">
Yes. Not required if passwordfile is set.
</td>
</tr>
<tr>
<td valign="top">
passwordfile
</td>
<td valign="top">
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 align="center" valign="top">
No
</td>
</tr>
<tr>
<td valign="top">
failOnError
</td>
<td valign="top">
Signal task failure to Ant. The default value is &quot;true&quot;.
</td>
<td align="center" valign="top">
No
</td>
</tr>
<tr>
<td valign="top">
params
</td>
<td valign="top">
Path to the configuration parameters file that contains the list of name/value pair configuration parameters. </td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
componentName
</td>
<td valign="top">
sets the configuration paramters for this component.
<br>Without this parameter, the configuration parameters are set for JBI runtime.
</td>
<td valign="top" align="center">
No
</td>
</tr>
<tr>
<td valign="top">
target
</td>
<td valign="top">
Specifies where the JBI administration tasks are performed. The default value is 'server'.
</td>
<td align="center" valign="top">
No
</td>
</tr>
</table>
<h3>Target Attribute Values</h3>
<table border="1" cellpadding="6" cellspacing="0">
<tr bgcolor="#AAD5D5" style="color: white;">
<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>&lt;cluster-name&gt;</td>
<td>When a &lt;cluster-name&gt; is specified, the task is executed against all instances in the specified cluster.</td>
</tr>
<tr>
<td>&lt;instance-name&gt;</td>
<td>When a &lt;instance-name&gt; 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>
&lt;!--
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.
--&gt;
&lt;taskdef resource="com/sun/jbi/ui/ant/antlib.xml" /&gt;
&lt;!-- setting the JBI runtime configuration --&gt;
&lt;!-- setting configuration parameters using nested elements --&gt;
&lt;jbi-set-configuration host="localhost" port="7890" target="my-cluster" &gt;
&lt;logger name="javax.enterprise.system.tools.deployment" value="FINER" /&gt;
&lt;/jbi-set-configuration&gt;
<br/>
&lt;!-- setting the JBI Component configuration --&gt;
&lt;!-- setting configuration parameters using nested elements --&gt;
&lt;jbi-set-configuration host="localhost" port="7890" componentName="my-service-engine" target="my-cluster" &gt;
&lt;logger name="sun-javaee-engine.logger1" value="FINER" /&gt;
&lt;/jbi-set-configuration&gt;
</pre>
<br/>
<br/>
<p style="font-size: 7pt; margin-top: 20pt; text-align: center;">
Copyright 2007, Sun Microsystems, Inc.
</p>

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