Important: This user guide is assumed to be used with TPTP 4.3
The following document provides the steps required to be executed before using the WSDM related tech preview plugins in TPTP.
2. Installation Sequence
3. Getting and adding the Apache Muse runtime
4. Testing the installation
5. Optionally adding images to the help
Web Services Distributed Management is an important open standard that enables abstracted, holistic, standardized remote management of IT resources. TPTP 4.3 contains the following tech previews that allow developers to build WSDM based resource endpoints for managing the resources:
- Tooling for Web Services Distributed Management: This set of plugins provides editors that enable the modeling of the manageability characteristics of a resource, generate the manageability endpoint, add the implementation code and deploy the built endpoint.
- WSDM Extension to the Managed Agent Explorer: This set of plugins adds a WSDM managed agent type to the Managed Agent Explorer allowing users to introspect and interact with WSDM resources including WSDM constructs like Service Groups and Relationships. Also its adds a WSDM extension to the Notification Broker enabling the workbench to receive WS-Notifications from WSDM resources including Advertisements, Property change notifications and (WSDM Event Format) events.
The Apache Muse runtime provides an open source implementation of WSDM and related specifications. The above plugins use the runtime to build new endpoints, to add the required runtime JARs to the built endpoints, and to connect with WSDM endpoints both custom built and existing. The WSDM tech preview in TPTP 4.3 has been tested to work with the Apache Muse 2.0 runtime which implements the WSDM 1.1 specifications. More details of Apache Muse can be found here.
- Install TPTP following instructions on the TPTP download page - you can either install the all-in-one TPTP download or install the prerequisites (Eclipse SDK, Equinox, Eclipse Modeling Framework SDK) on the download page first followed by the TPTP Runtime component. Let us assume that the installation location is [tptp-install-folder]. The eclipse subfolder must be in this folder.
- In either case, you must then install the WTP (Web Tools Platform) and its depedencies also found on the same TPTP download page under Requirements. You will need Web Tools Platform, Java EMF Model and Graphics Editor Framework downloads.
- Download and install the WSDM Component from the Build to Manage Toolkit page
- Download the Apache Muse runtime as specified below
- Start Eclipse with the -clean option
You can also do the above install by downloading the Callisto packageing of the Eclipse runtime from the Callisto download page and then using the Update Manager to get the above components. See this page on using the Update Manager to install TPTP 4.3. To get the WSDM tooling plugins you must follow the instructions under "Installing Tech Previews" after completing the other steps.
After installing the TPTP runtime, install the WSDM component by extracting the downloaded ZIP file into the eclipse subfolder of the [tptp-install-folder]. Close Eclipse if you have started it after installation. Download this custom package of the Apache Muse runtime. Note that this is separate open source project deliverable that you are downloading from a non-Eclipse site/project. Please review the Apache Muse project license on the Apache Muse website before proceeding with and downloading Apache Muse. The use of the endpoints generated using TPTP and the use of TPTP to interact with WSDM resources is governed by the terms of the Apache license.
This ZIP file contains the Apache Muse JAR files organized into folder that match the plugins in TPTP that were added when you installed the WSDM tech preview component. Unzip the Apache Muse JARs ZIP file into the [tptp-install-folder]. The Apache Muse JARs and artifacts will be added to the correct plugins.
If you had previously started Eclipse after installing TPTP, restart Eclipse with the -clean option. You can do this by opening a command prompt, changing to the [tptp-install-folder]/eclipse folder and running eclipse -clean. This will refresh the configuration.
Once the above steps have been completed and you have restarted Eclipse with the -clean option, you can test that the WSDM capability has indeed been added as follows.
Switch to the Profiling and Logging perspective.
Create a new Profile Configuration.
Double click on the Managed Resource option on the left to create a new configuration. Choose WSDM Resource and click on the Edit Options button.
In the dialog that comes up, switch to the Runtime tab.
If you see the Apache Muse Runtime as an option in the drop down box, then the installation was successful. To further verify successful installation, switch to the Source tab. Enter (or cut-and-paste) an EPR.
Switch to the Design tab. If the EPR is parsed properly and no error is shown, the installation was succesful.
The WSDM tooling plugins that you installed above add help files that are available in your runtime workbench through Eclipse Help. However the images used in those help pages are missing.
To add them, download this file and extract it into say c:\temp. You will see a new folder images that contains all the images.
First close the Eclipse Workbench if you are running it. Now in the [tptp-install-folder] go to /eclipse/plugins. Find the plugin JAR named: org.eclipse.tptp.wsdm.tooling.doc.user_4.3.0.v200610250100.jar. Make sure you are picking the correct JAR file. We will now add the image files to this JAR file.
You can either extract the JAR file to a folder, add the images folder to that folder and re-JAR it with the new files. Alternatively, you can open the JAR file with an archival program like Winzip or WinRAR and drag-and-drop the images folder into the archive. Just make sure that you do not add/copy in with full path (this is typically a setting allowed by the archival utility when adding new files.
Now restart Eclipse with the -clean option. Then try Help > Help Contents .i.e. choose Help Contents from the Help menu. Pick any of the topics under Modeling and generation of Web services distributed management endpoints. The images should show up properly.