Task: jbi-list-binding-components

Description

This task prints the information about binding components.

Example Output
========================================
    List of Binding Components
========================================
Name       : ant_test_binding1
Status     : Started
Description: Ant test binding with shared library.
----------------------------------------

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 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.
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
xmlOutput Property name to save the list output in xml format. If set, the task will not output the formatted text output, but sets the property value with the list output in xml format. No
bindingComponentName If supplied, only the named binding component is reported. If the binding does not exist, an empty list is reported. No
state Lists the bindings that are in the specified state.
Without this parameter, binding components with any state will be listed.
Valid states are : "started", "stopped" and "shutdown".
No
sharedLibraryName Lists the engines that are dependent on the specified shared library.
Without this parameter, shared library dependencies are not verified.
No
serviceAssemblyName Lists the bindings that have service units deployed to them as part of the service assembly deployed in the JBI environment.
Without this parameter, service assembly dependencies are not verified.
No
target Specifies where the JBI administration tasks are performed. The default value is 'server'. 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

<!--
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" />
<!-- list all bindings in the jbi environment -->
<jbi-list-binding-components host="localhost" port="7890"  />
<!-- list bindings  that are started in the target "domain"-->
<jbi-list-binding-components  state="started" target="domain"/>
<!-- list bindings that depends on  with name=my_slib -->
<jbi-list-binding-components  sharedLibraryName="my_slib" />
<!-- list bindings that participate in the deployment of service assembly with name=my_sa -->
<jbi-list-binding-components  serviceAssemblyName="my_sa" />
<!-- list bindings that are stopped and depends on sharedLibraryName="my_sa" and participated in the deployment of service assembly with name="my_sa2"
<jbi-list-binding-components  state="stopped" sharedLibraryName="my_slib2" serviceAssemblyName="my_sa2" />

Copyright 2007, Sun Microsystems, Inc.