Watch, Follow, &
Connect with Us

For forums, blogs and more please visit our
Developer Tools Community.


ID: 24285, CaliberRM SDK Utilities 2006

by Joe Schulz Email: joe.schulz@borland.com


This set of libraries includes common utility functionality that many CaliberRM SDK applications require.
Download Details
FTP  download also available
CDN Login Required to Download. (You will be redirected to the login page if you click on the Download Link)
To download this, you must have registered:
A free membership

For CaliberRM, Version 7.0  to 7.0 215 downloads
Copyright: No significant restrictions


Size: 21,410,446 bytes
Updated on Mon, 02 Apr 2007 12:34:12 GMT
Originally uploaded on Tue, 19 Dec 2006 09:05:30 GMT
SHA1 Hash: 4A237D62D1787F1FED9BEDB7C6D8FC093C001697
MD5 Hash: 46472C5BFCE6008F90E6940CD804E2E8

    Explore the files in this upload

Description
Borland SDK Utilities 2006
==========================
This set of libraries includes common utility functionality that many CaliberRM and StarTeam SDK applications require. It is intended as a shared resource for any Borland SDK application, used either for common methods (e.g., connecting to a server) or as an ancestor class when defining project-specific functionality (e.g., managing a utility configuration file).

The main classes are the “BorlandUtilities”, “CaliberUtilities”, and “StarTeamUtilities” classes. These classes provide common functionality through convenience methods that can be called from any Java application simply by instantiating an instance of the class. This functionality includes logic like connecting to a server, retrieving sets of objects, and determining object names and icons. There are also a few specialty methods for very specific uses, like populating a Swing JTree control.

Sample applications are also included that illustrate how to use these libraries for both StarTeam and CaliberRM. There are four examples for each product, including 1) a “headless” utility, 2) a window-based graphical user interface, 3) a wizard-style graphical user interface, and 4) an MPX event agent. Each example includes complete source code, a sample configuration file and a sample command file.

A complete set of Javadoc documentation is also provided. The Javadoc details every class and method contained in the Borland SDK Utilities library, and extensive comments have been added to the class and method descriptions to help identify the purpose of each. The Javadoc documentation is provided in the “doc” subdirectory.

Installation
============
This utility package contains a complete JBuilder 2006 project, including all relevant source code. The “src” directory stores the Java source code for the utility classes and can be used to modify/recompile the utility. The “doc” directory stores the Javadoc documentation for all classes and methods.

To install these libraries, simply UNZIP the contents of the ZIP file to any local hard drive directory (e.g., “C:\BorlandUtilities”). In order to use or extend the functionality in these libraries, you must then add them to the Java class path for your application.

There are twelve executable java archives (.jar files) that are part of this library. The first three provide common functionality through convenience methods that can be called from any Java application simply by instantiating an instance of the class. This functionality includes logic like connecting to a server, retrieving sets of objects, and determining object names and icons. There are also a few specialty methods for very specific uses, like populating a Swing JTree control.

1.) BorlandUtilities.jar

This archive contains the reusable classes applicable to both CaliberRM and StarTeam SDK applications. The classes in these libraries are intended as either ancestor classes or to provide convenience methods for SDK-based applications.

2.) CaliberUtilities.jar

This archive contains reusable classes applicable to CaliberRM SDK applications. The classes in these libraries are intended as either ancestor classes or to provide convenience methods for CaliberRM SDK-based applications.

3.) StarTeamUtilities.jar

This archive contains reusable classes applicable to StarTeam SDK applications. The classes in these libraries are intended as either ancestor classes or to provide convenience methods for StarTeam SDK-based applications.

4.) CaliberExample.jar

This archive contains a sample application that uses the Borland SDK utilities to display a simple CaliberRM project list. If desired, the classes in this archive can be used as a skeleton for creating a new CaliberRM SDK application.

5.) CaliberUIExample.jar

This archive contains a user interface example that logs into a specified CaliberRM server and lists the Caliber projects and baselines contained in the server. It is intended as an example of how to use a Java Swing-based user interface for CaliberRM SDK applications. In addition, it uses several of the predefined UI classes in this framework. If desired, the classes in this archive can be used as a skeleton for creating a new CaliberRM SDK user interface application.

6.) CaliberWizardExample.jar

This archive contains a sample wizard-style user interface example that logs into a specified CaliberRM server and displays the properties for a set of selected requirements. It is intended as an example of how to use the CaliberRM SDK Utilities classes to define an SDK wizard application. If desired, the classes in this archive can be used as a skeleton for creating a new CaliberRM SDK wizard application.

7.) CaliberAgentExample.jar

This archive contains a sample MPX event agent that uses the Borland SDK utilities to display a message whenever a CaliberRM requirement is updated. If desired, the classes in this archive can be used as a skeleton for creating a new CaliberRM MPX agent.

8.) StarTeamExample.jar

This archive contains a sample application that uses the Borland SDK utilities to display a simple StarTeam project list. If desired, the classes in this archive can be used as a skeleton for creating a new StarTeam SDK application.

9.) StarTeamUIExample.jar

This archive contains a user interface example that logs into a specified StarTeam server and lists the StarTeam projects and views contained in the server. It is intended as an example of how to use a Java Swing-based user interface for StarTeam SDK applications. In addition, it uses several of the predefined UI classes in this framework. If desired, the classes in this archive can be used as a skeleton for creating a new StarTeam SDK user interface application.

10.) StarTeamWizardExample.jar

This archive contains a wizard-style user interface example that logs into a specified StarTeam server and displays the properties for a set of selected folders. It is intended as an example of how to use the StarTeam SDK Utilities classes to define an SDK wizard application. If desired, the classes in this archive can be used as a skeleton for creating a new StarTeam SDK user interface application.

11.) StarTeamAgentExample.jar

This archive contains a sample MPX event agent that uses the Borland SDK utilities to display a message whenever a StarTeam change request is updated. If desired, the classes in this archive can be used as a skeleton for creating a new StarTeam MPX agent.

12.) EncryptPassword.jar

This archive contains a standalone utility for creating encrypted password files. These password files can then be used to store user and password information for connecting to CaliberRM and StarTeam servers through SDK-based applications.

---CaliberRM SDK
Please note that several of the libraries included use the CaliberRM SDK to access the CaliberRM server. These include the “CaliberUtilities.jar”, “CaliberExample.jar”, “CaliberUIExample.jar”, “CaliberWizardExample.jar”, and “CaliberAgentExample.jar” libraries. In order to use these libraries the CaliberRM SDK must be installed on the client machine before the example applications can be run. The CaliberRM client and server components do not need to be installed, though it is often useful to install a CaliberRM client on the machine in order to test connectivity outside of the SDK.

Also note that the CaliberRM SDK is automatically installed when any CaliberRM component is installed. Once it is installed by any component, you do not need to install it separately to run this application. Beginning with CaliberRM 2005, the CaliberRM SDK is included as part of the “CaliberRM Client/Server” installation package. You can download and install this package from the public Borland web site at “http://www.borland.com/products/downloads/download_caliber.html#”.

---CaliberRM MPX
Please note that the “CaliberAgentExample” MPX agent uses CaliberRM MPX events to determine which requirement objects have been modified. So, the StarTeam MPX extension must be enabled on the CaliberRM server before running this application.

---StarTeam SDK
Please note that several of the libraries included use the StarTeam SDK to access the StarTeam server. These include the “StarTeamUtilities.jar”, “StarTeamExample.jar”, “StarTeamUIExample.jar”, “StarTeamWizardExample.jar”, and “StarTeamAgentExample.jar” libraries. In order to use these libraries the StarTeam SDK run-time must be installed on the client machine before the example applications can be run. The StarTeam client and server components do not need to be installed, though it is often useful to install a StarTeam client on the machine in order to test connectivity outside of the SDK.

Also note that the StarTeam SDK run-time is automatically installed when any StarTeam component is installed. Once it is installed by any component, you do not need to install it separately to use these libraries. However, you do need to install the full StarTeam SDK (not just the run-time) for SDK development and compilation. You can download either the full SDK package or the SDK run-time package from the public Borland web site at “http://www.borland.com/products/downloads/download_starteam.html”.

---StarTeam MPX
Please note that the “StarTeamAgentExample” MPX agent uses StarTeam MPX events to determine which change request objects have been modified. So, the StarTeam MPX extension must be installed and enabled on the StarTeam server before running this application.

Running the Borland SDK Utility Examples
========================================
To run any of the example applications, simply edit the corresponding command file command file as directed in the command file comments and then execute it from a command prompt. For the headless utilities, one run-time parameter is required to specify the fully qualified file name of the XML configuration file (see below). For the UI-based example applications the XML configuration file is optional.

All run-time parameters are controlled via input XML files, by default named the same as the related application (e.g., “StarTeamExample.xml”). For the headless utilities, this file must exist before running the example applications, but for the user interface applications a default configuration file will be created if necessary. A sample has been provided for each application and comments in the file indicate the use for each parameter. If specified, the name of this configuration file should be the only run-time argument passed to the Java class when it is executed.

Creating a new Borland SDK Application
======================================
To create a new StarTeam or CaliberRM SDK application based on the Borland SDK Utilities, you only need to follow a few simple steps. The specific steps will depend on which type of application you are creating, and those can be broken down into four basic categories. The application categories correspond to the example applications and include 1) a “headless” command line application, 2) a “headless” MPX-based event agent, 3) a window-based graphical user interface, and 4) a wizard-style graphical user interface.

Notes
=====
THIS UTILITY LIBRARY IS PROVIDED ON AN AS-IS BASIS, WITHOUT ANY DIRECT OR IMPLIED WARRANTY. Neither the author nor Borland Software Corporation provide any guarantee of it's functionality or the integrity of the application data when this utility library is used. You are free to use and/or customize this utility library at your own risk. All support for the use of this utility library is the sole responsibility of the user.

BE SURE YOU HAVE A VERIFIED BACKUP OF YOUR DATA BEFORE USING THIS UTILITY LIBRARY. In the event of data corruption, you should immediately restore your database from the backup and discontinue the use of the utility library.

This utility library and all examples have been developed and tested for CaliberRM 2006 and StarTeam 2006. Before using it with any other version of the product, you should recompile and retest in your environment. Changes may be necessary to support different product versions.

This utility library has been provided at no charge. No one has received any direct or indirect compensation for it's development or usage. If you have been asked for payment in any form, please contact the author immediately and discontinue the use of this utility library.

As with any unsupported application, you should recompile and retest this utility library in your environment before using with production data. All applicable source code has been made available for this purpose. If you received this utility library without source code, please contact the author immediately and discontinue the use of this utility library.

   Latest Comments  View All Add New

Move mouse over comment to see the full text

Could not retrieve comments. Please try again later.

Server Response from: ETNACDC03