Fuse ESB Enterprise - Using Java Business Integration

Usage

This is the basic usage statement for the Fuse ESB Enterprise Ant tasks when used from the command line:

ant -f InstallDir/ant/servicemix-ant-tasks.xml [-Doption=value...] task

The task argument is the name of the Ant task you are calling. Each task supports a number of options that are specified using the -Doption=value flag.

Installing a component

The Ant task used to install a component to the Fuse ESB Enterprise container is install-component. Its options are described in Table 1.

Table 1. Options for installing a JBI component with an Ant command

Option	Required	Description
`sm.username`	no	Specifies the username used to access the management features of the Fuse ESB Enterprise container
`sm.password`	no	Specifies the password used to access the management features of the Fuse ESB Enterprise container
`sm.host`	no	Specifies the host name where the container is running; the default value is `localhost`
`sm.port`	no	Specifies the port where the container's RMI registry is listening; the default value is `1099`
`sm.install.file`	yes	Specifies the name of the installer file for the component

Example 6 shows an example of using install-component to install the Camel component to a container listening on port 1000.

Example 6. Installing a component using an Ant command

>ant -f ant/servicemix-ant-task.xml -Dsm.port=1000 -Dsm.install.file=servicemix-camel-3.3.0.6-fuse-installer.zip install-component
Buildfile: ant\servicemix-ant-task.xml

install-component:
[echo]  install-component
[echo]  Installing a service engine or binding component.
[echo]     host=localhost
[echo]     port=1000
[echo]     file=hotdeploy\servicemix-camel-3.3.0.6-fuse-installer.zip

BUILD SUCCESSFUL
Total time: 7 seconds

Removing a component

The Ant task used to remove a component from the Fuse ESB Enterprise container is uninstall-component. Its options are described in Table 2.

Table 2. Options for removing a JBI component with an Ant command

Option	Required	Description
`sm.username`	no	Specifies the username used to access the management features of the Fuse ESB Enterprise container
`sm.password`	no	Specifies the password used to access the management features of the Fuse ESB Enterprise container
`sm.host`	no	Specifies the host name where the container is running; the default value is `localhost`
`sm.port`	no	Specifies the port where the container's RMI registry is listening; the default value is `1099`
`sm.component.name`	yes	Specifies the name of the JBI component

Example 7 shows an example of using uninstall-component to remove the drools component from a container listening on port 1000.

Example 7. Removing a component using an Ant command

>ant -f ant\servicemix-ant-task.xml -Dsm.port=1000 -Dsm.component.name=servicemix-drools uninstall-component
Buildfile: ant\servicemix-ant-task.xml

uninstall-component:
[echo]  uninstall-component
[echo]  Uninstalling a Service Engine or Binding Component.
[echo]     host=localhost
[echo]     port=1000
[echo]     name=servicemix-drools

BUILD SUCCESSFUL
Total time: 1 second

Starting a component

The Ant task used to start a component is start-component. Its options are described in Table 3.

Table 3. Options for starting a JBI component with an Ant command

Option	Required	Description
`sm.username`		Specifies the username used to access the management features of the Fuse ESB Enterprise container
`sm.password`	no	Specifies the password used to access the management features of the Fuse ESB Enterprise container.
`sm.host`	no	Specifies the host name where the container is running; the default value is `localhost`
`sm.port`	no	Specifies the port where the container's RMI registry is listening; the default value is `1099`
`sm.component.name`	yes	Specifies the name of the JBI component

Example 8 shows an example of using start-component to start the cxf-se component in a container listening on port 1000.

Example 8. Starting a component using an Ant command

>ant -f ant\servicemix-ant-task.xml -Dsm.port=1000 -Dsm.component.name=servicemix-cxf-se start-component
Buildfile: ant\servicemix-ant-task.xml

start-component:
[echo]  start-component
[echo]  starts a particular component (service engine or binding component) in Servicemix
[echo]     host=localhost
[echo]     port=1000
[echo]     name=servicemix-cxf-se

BUILD SUCCESSFUL
Total time: 1 second

Stopping a component

The Ant task used to stop a component is stop-component. Its options are described in Table 4.

Table 4. Options for stopping a JBI component with an Ant command

Option	Required	Description
`sm.username`	no	Specifies the username used to access the management features of the Fuse ESB Enterprise container
`sm.password`	no	Specifies the password used to access the management features of the Fuse ESB Enterprise container
`sm.host`	no	Specifies the host name where the container is running; the default value is `localhost`
`sm.port`	no	Specifies the port where the container's RMI registry is listening; the default value is `1099`
`sm.component.name`	yes	Specifies the name of the JBI component

Example 9 shows an example of using stop-component to stop the cxf-se component in a container listening on port 1000.

Example 9. Stopping a component using an Ant command

>ant -f ant\servicemix-ant-task.xml -Dsm.port=1000 -Dsm.component.name=servicemix-cxf-se stop-component
                Buildfile: ant\servicemix-ant-task.xml

stop-component:
[echo]  stop-component
[echo]  stops a particular component (service engine or binding component) in Servicemix
[echo]     host=localhost
[echo]     port=1000
[echo]     name=servicemix-cxf-se

BUILD SUCCESSFUL
Total time: 1 second

Shutting down a component

The Ant task used to shutdown a component is shutdown-component. Its options are described in Table 5.

Table 5. Options for shutting down a JBI component with an Ant command

Option	Required	Description
`sm.username`	no	Specifies the username used to access the management features of the Fuse ESB Enterprise container
`sm.password`	no	Specifies the password used to access the management features of the Fuse ESB Enterprise container
`sm.host`	no	Specifies the host name where the container is running; the default value is `localhost`
`sm.port`	no	Specifies the port where the container's RMI registry is listening; the default value is `1099`
`sm.component.name`	yes	Specifies the name of the JBI component

Installing a shared library

The Ant task used to install a shared library to the Fuse ESB Enterprise container is install-shared-library. Its options are described in Table 6.

Table 6. Options for installing a shared library with an Ant command

Option	Required	Description
`sm.username`	no	Specifies the username used to access the management features of the Fuse ESB Enterprise container
`sm.password`	no	Specifies the password used to access the management features of the Fuse ESB Enterprise container
`sm.host`	no	Specifies the host name where the container is running; the default value is `localhost`
`sm.port`	no	Specifies the port where the container's RMI registry is listening; the default value is `1099`
`sm.install.file`	yes	Specifies the name of the library's installer file

Removing a shared library

The Ant task used to remove a shared library from the Fuse ESB Enterprise container is uninstall-shared-library. Its options are described in Table 7.

Table 7. Options for removing a shared library with an Ant command

Option	Required	Description
`sm.username`	no	Specifies the username used to access the management features of the Fuse ESB Enterprise container
`sm.password`	no	Specifies the password used to access the management features of the Fuse ESB Enterprise container
`sm.host`	no	Specifies the host name where the container is running; the default value is `localhost`
`sm.port`	no	Specifies the port where the container's RMI registry is listening; the default value is `1099`
`sm.shared.library.name`	yes	Specifies the name of the shared library

Using the tasks as commands