Installing Sun ONE Connector Builder

This module describes how to install and uninstall the Sun ONE Connector Builder and contains information about the following topics:

• Overview
• Software and Hardware Requirements
• Additional Software Needed for Deploying the Samples
• Preparing to Install the Connector Builder
• Installing Connector Builder on Windows NT/2000/XP
• Uninstalling Connector Builder on Windows NT/2000/XP
• Installing Connector Builder on Solaris or Linux
• Uninstalling Connector Builder on Solaris or Linux
• Sample Adapters and Application

Overview

---

The Sun^TM ONE Connector Builder is a set of tools, components and libraries that allows developers to build resource adapters - compliant with the J2EE Connector Architecture 1.0 - for Enterprise Information Systems (EIS) and legacy applications. The resource adapters built using Connector Builder provide J2EE applications an easy-to-use and standards-based way to access these external systems.

The generated resource adapters are accessed using the Common Client Interface (CCI) API as described in the J2EE Connector Architecture specification. Optionally, Connector Builder generated resource adapters can also be accessed using Simple Object Access Protocol (SOAP) services thus providing a web services solution to application integration.

Software and Hardware Requirements

---

The following table lists the hardware and software requirements for installing and running the Connector Builder. The left column lists the components and the right column lists the requirement.

   Software and Hardware Requirements

Component	Requirement
Computer and Operating System	One of the following systems: Intel Pentium/Microsoft Windows NT 4.0 SP6 or Windows 2000 SP2, Windows XP Sun SPARC running Solaris 8 or 9. Red Hat Linux 7.2
Memory	256 MB minimum, 512 MB recommended.
Disk space	17 MB for all platforms: Windows NT, Windows 2000, Windows XP, Solaris or Red Hat Linux 7.2
Software applications	Sun ONE Studio 4, Enterprise Edition for Java JDK 1.3.1, 1.4
Browser software	Netscape Browser, Version 6.2 or later.
Other software	Additional software is required to create and deploy the sample resource adapters. See "Additional Software Needed for Deploying the Samples".

Additional Software Needed for Deploying the Samples

---

The following table details the additional software that is needed to deploy and run the samples.

   Software Applications Needed For Deploying the Samples

Hardware/Operating Systems	Software Applications
Solaris 2.6 or 8 or 9
	Connector Builder
	Sun ONE Application Server 7.0 or iPlanet Webserver 6.0 SP4 (configured with JDK1.3.1) or iPlanet Application Server 6.5 or J2EE 1.3.1 reference implementation.
	Netscape Browser, Version 6.2 or later.
	Database Server Software, Oracle Client and the JDBC driver are required for the DBMS sample only.
Windows NT 4.0 SP6, Windows 2000 SP2, Windows XP	.
	Connector Builder
	Sun ONE Application Server 7.0 or iPlanet Webserver 6.0 SP4 (configured with JDK1.3.1) or iPlanet Application Server 6.5 or J2EE 1.3.1 reference implementation.
	Netscape Browser, Version 6.2 or later.
	Database Server Software and the Oracle Client is required for the DBMS sample only
Red Hat Linux 7.2
	Connector Builder
	Sun ONE Application Server 7.0 or iPlanet Webserver 6.0 SP4 (configured with JDK1.3.1) or J2EE 1.3.1 reference implementation
	Netscape Browser, Version 6.2 or later.
	Database Server Software and the Oracle Client is required for the DBMS sample only

Preparing to Install the Connector Builder

---

Before installing the Connector Builder complete the following steps:

• Read the Sun ONE Connector Builder Release Notes for any last minute updates.
• Make sure that JDK (1.4) is installed.
• Make sure that IDE is installed and configured for JDK 1.4.




---

Note	You must stop IDE before installing the Connector Builder.

---



• Make sure that the JAVA_HOME environment variable is set.

For Solaris:

export JAVA_HOME=<JDK_location>

export PATH=$JAVA_HOME/bin:$PATH

For Windows:

set JAVA_HOME=<JDK_location>

set PATH=%JAVA_HOME%\bin;%PATH%

User Privilege Requirement

The following table lists the hardware and software user privilege requirements. The left column lists the operating system. The right column lists the requirements.

   User Privilege Requirements

Operating Systems	Requirement
Windows NT 4.0 SP6 or Windows 2000 SP2, Windows XP	The user should have administrator privilege to install/uninstall the product. The user should also have write permissions to the Sun ONE Studio 4, Enterprise Edition for Java location as Connector Builder setup tries to copy some of the files to Sun ONE Studio 4, Enterprise Edition for Java location.
Solaris 8 and 9/Red Hat Linux 7.2	Installation should be done by the root user. Also, make sure the root user has write permissions for the following three Sun ONE Studio directories. <Sun ONE Developer Studio 4 Location Root>, <Sun ONE Developer Studio 4 Location Root>/modules, <Sun ONE Developer Studio 4 Location Root>/modules/docs

Installing Connector Builder on Windows NT/2000/XP

---

The following procedures describe how to install and uninstall the Sun ONE Connector Builder on Windows NT/2000/XP.

To Install the Connector Builder on Windows NT/2000/XP

1. Unzip the Connector Builder product bundle .zip file into a temporary local directory.
2. Run setup.exe.
3. Follow the instructions on the screen to progress through the installation.

The following screen displays the Welcome message.

   Welcome Message

4. Click Next to continue.

The following screen displays the Licensing Agreement.

   Software License Agreement

5. Read the License Agreement and click Yes (Accept License) to continue. The following screen displays the prompt for creating a directory for the location of installation for the product.

   Location of Installation

6. Click Next to accept the default Installation directory, C:\Program Files\Sun\Connector Builder, or browse to select an alternative directory and then click Next.
   

   ---

   Caution

   You must NOT install the Connector Builder in the same directory as you used to install Sun ONE Studio 4.

   ---

   
   

The following screen displays the Components to Install.

   Components to Install

The Components to Install screen lists the various components that you can select when you install the Connector Builder. The following lists the contents of each component in the order which they appear:

• Connector Builder Core Components installs the common components for Connector Builder.
• Connector Builder Development Component installs the Sun ONE Studio 4 (IDE) module.
• Connector Builder Tools installs the Command Line Tools used for deployment and running the TestClient.
• Connector Builder Samples installs the COTS and DBMS Samples that are included with the Connector Builder software package.
• Select the components to install, see "Components to Install", and then click Next.

The Sun ONE Developer Studio 4 Location Root screen is displayed.

   Sun ONE Developer Studio 4 Location

8. Type in or browse to the location of Sun ONE Studio 4 and Click Next.

The following screen displays the Ready to Install message.

   Ready to

Install

Verify the items to be installed and then click Install Now. The System Update Screen is displayed.

   System Update Screen

9. Click Next to continue. The Installation Summary screen is displayed.

   Installation Summary

10. Click Details to display the details of the logs generated.

The Details log is displayed.

   Detail's Log of Installation

The Detail's log lists the files that were copied or installed during the installation.The first and last line describes the process and location of installation so you have a permanent record and can backtrack to a specific installation.

11. Click Dismiss to return to the Installation Summary screen.
12. Click Close to exit the installation.

You have now finished installing the Connector Builder.

Uninstalling Connector Builder on Windows NT/2000/XP

---

The following describes the procedure for uninstalling Connector Builder from Windows NT, Windows 2000 or Windows XP.

To Uninstall Connector Builder from Windows NT/2000/XP

1. Select Start > Settings > Control Panel > Add/Remove Programs > Sun ONE Connector Builder 2.0 and then click Add/Remove.

The Uninstalling Sun ONE Connector Builder Window is displayed. See the Sun ONE Connector Builder Uninstall Window.




---

Note	You can run the uninstall Java class (uninstall_Sun_One_Connector_Builder.class) from the command prompt as "java uninstall_Sun_One_Connector_Builder". This class resides in the installation directory, for example d:\Connector Builder.

---

   Sun ONE Connector Builder Uninstall Window

2. Click Next. The Select Type of Uninstall window is displayed.

   Select Type of Uninstall

3. Select the Full radio button and click Next.




---

Note	Uninstallation does not remove the svrreg.properties file (used if you deploy a resource adapter). Back up the svrreg.properties file located in the config subdirectory, if you want to reuse a registered server's information.

---

The Components to Uninstall screen is displayed.

Components to Uninstall

4. Click Uninstall Now.

The Uninstallation Summary is displayed when the uninstallation is complete.

   Uninstallation Summary

5. Click Details to show the Uninstall Log of the components that have been removed, or click Exit.

   Uninstall Log

6. Click Dismiss to return to the Uninstallation summary.

Installing Connector Builder on Solaris or Linux

---

The following procedure describes how to install the Sun ONE Connector Builder on Solaris and Linux operating systems. The procedures are very similar with only minor differences.

Preparing for Installing the Connector Builder on Solaris or Linux

You should check to ensure that JDK1.4.0 is installed on your machine. On Linux, JDK1.4.0 is automatically installed in directory /usr/java.

The files for installing the Connector Builder are shipped on the disk in compressed format.

To Uncompress the Files and Start the Installation on Solaris

1. Untar the Connector Builder product bundle .tar file into a temporary local directory using the command /usr/bin/tar -xvf <product_bundle_name>.tar.

Use the tar utility that is provided with the Solaris installation (located under /usr/bin). Using any other tar utility may result in an incorrect installation.

2. Run the command: java setup

To Uncompress the Files and Start the Installation on Linux

1. Unzip the Connector Builder product bundle .zip file into a temporary local directory.
2. Run the command: java setup

Installing the Connector Builder on Solaris or Linux

1. Read the Welcome Message, and then click Next.

   Welcome Message

2. Read the license agreement and if you accept it, click Yes (Accept License), see Software License Agreement.

   Software License Agreement

3. Browse to locate your installation directory and click OK.

   Selecting Installation Directory

4. Click Next when you locate your installation directory.
   

   ---

   Caution

   You must NOT install the Connector Builder in the same directory as you used to install Sun ONE Studio 4.

   ---

   
   

   Components to Install

The Components to Install lists the various components that you can select when you install the Connector Builder. The following lists the contents of each component:

• Connector Builder Core Components installs the common components for Connector Builder.
• Connector Builder Development Wizard Component installs the Sun ONE Studio 4 (IDE) module.
• Connector Builder Tools installs the Command Line Tools used for deployment and running the TestClient.
• Connector Builder Sample Adapters and Application installs the COTS and DBMS Samples that are included with the Connector Builder software package.
• Select the components to install and click Next.

   Locate Directory Where Sun ONE Developer Studio 4 EE is Installed

6. Browse to the location where Sun ONE Studio 4 is located and click Next.

   Ready to Install

7. Verify the items to be installed, see Ready to Install, and click Install Now. The following screen is displayed.

   Installation Summary

8. Click Details to show the log.

   Details

9. Click Exit, see Installation Summary, when the installation is completed.

You have now finished installing the Connector Builder.

Uninstalling Connector Builder on Solaris or Linux

---

The following section describes the procedure on how to uninstall the Connector Builder from your Solaris system.

To Uninstall Connector Builder from Solaris or Linux

1. Go to the Connector Builder installation directory.
2. Run the command: java uninstall_Sun_ONE_Connector_Builder

   Sun ONE Connector Builder Uninstall Window

3. Click Next to proceed with the uninstallation.

   Select Type of Uninstallation

4. Select Full radio button to completely uninstall Connector Builder or select Partial to uninstall components of the Connector Builder Software.




---

Note	Uninstallation does not remove the svrreg.properties file (used if you deploy a resource adapter). Back up the svrreg.properties file located in the config subdirectory, if you want to reuse a registered server's information.

---

The Uninstalling Sun ONE Connector Builder screen shows the components that will be uninstalled.

5. Click Uninstall Now to uninstall Connector Builder.
6. Click Details to see the log of the uninstallation.

   Details

7. Click OK to exit the log screen and then click Close to end uninstallation.

Sample Adapters and Application

---

The Connector Builder includes two comprehensive samples to illustrate the key features of Connector Builder product. The Customer Order Tracking System (COTS) sample includes a stubbed EIS, the resource adapter, and a web application. The DBMS sample includes a resource adapter based on the J2EE Reference Implementation sample cciblackbox adapter and sample programs.

These samples are copied during the installation process by selecting the `Connector Builder Sample Adapters and Application' option as displayed in "Components to Install" for Windows and "Components to Install" for Solaris. After you install the Connector Builder, you can either directly deploy the sample adapters (refer to "Deploying the COTS Sample Adapter" and "Deploying the DBMS Sample Adapter" for details) or walk through "Lessons for Creating a COTS Sample Resource Adapter" and "Lessons for Creating a DBMS Sample Resource Adapter" to understand how to create and deploy the sample adapters using Connector Builder. These two samples can be used as a reference to build other resource adapters.