Tooling Client (IAgent)

The Tooling Client is responsible for communicating management information between the Eclipse mToolkit and the OSGi Runtime. This information allows developers to view running applications in the runtime as well as to directly deploy ones from within Eclipse. If the Tooling Client is not running on the OSGi Runtime, you will not be able to connect to the runtime from Eclipse and execute any operations on it.

Activating the Tooling Client

Starting OSGi Runtime with the Tooling Client Active

By default, the Tooling Client is not active in the runtime. To turn it on at OSGi startup, follow the next instructions:

1. Open a command prompt in the bin/vms/<vm_name> folder in accordance with the JVM you will use to run OSGi.
2. If you have a clean OSGi storage, use the following command on Windows or Linux:

   server tooling

   Otherwise, use the following command line to start the OSGi Runtime with clean storage and active Tooling Client:

   server clean tooling

As a result, the OSGi Runtime will be started with the components of the Tooling Client installed.

Activating the Tooling Client at Runtime through an Install Script

Another option to have Tooling Client turned on is to install the relevant bundles yourself at OSGi runtime by using an install script:

• Execute the following command in the runtime console of the OSGi Runtime:

  kitman.i "Tooling Support"

Contacting the OSGi Runtime from within Eclipse

Having the OSGi SDK plug-ins installed in Eclipse, go to the Frameworks view and add the OSGi Runtime by specifying Connection Type > Plain Socket and the address of the runtime. Next, select the runtime and use the Connect Framework option from the context menu or from the view toolbar.

Files and Folders Related to Tooling Client

Regarding the OSGi Runtime file structure, there are certain folders and files worth knowing about as they contain the basic components of the Tooling Client.

• bin/pscripts/tooling.txt – The install script for activating the Tooling Client (see the previous section "Activating the Tooling Client at Runtime through an Install Script" above).
• bin/vms/tooling and bin/vms/tooling.bat – Executable shell scripts (Linux) or batch file (Windows) providing activation of the Tooling Client at OSGi Startup (refer to the "Starting OSGi with Tooling Client Active" section above).
• bin/vms/tooling.ini – Startup bundles list file providing activation of the Tooling Client at OSGi Startup (refer to the "Starting OSGi with Tooling Client Active" section above).
• bundles/com.prosyst.tools.iagent.rpc.jar and bundles/com.prosyst.tools.iagent.ext.rpc.jar – The bundles building the functionality of the Tooling Client.