Preface

The Sun^TM ONE Connector Builder 2.0 Developer's Guide explains how to build, deploy, configure, and manage a resource adapter for an Enterprise Information System.

This preface contains information about the following topics:

• What you Should Already Know
• User Roles
• What's in This Guide
• Documentation Conventions
• Online Guide
• Related Information

What you Should Already Know

---

The Sun ONE Connector Builder 2.0 Developer's Guide is written for system administrators and developers.

The guide assumes you are familiar with the following topics:

• Java programming language
• Sun^TM Open Network Environment (ONE) Studio 4, Enterprise Edition for Java formerly Forte For Java Enterprise Edition and FFJ, hence forth referred as the IDE.
• J2EE Connector Architecture v1.0
• J2EE specification

User Roles

---

At a high level, there are three distinct user roles involving the resource adapter. The left column in the table below lists the type of user and the right column describes the user's role.

   User Roles

User	Role
resource adapter developer	uses Sun ONE Connector Builder to develop a resource adapter.
application developer	uses the generated resource adapter in his/her application development. The application code directly uses the classes generated by Connector Builder to communicate with EIS.
system administrator	deploys and configures the resource adapter

What's in This Guide

---

The Sun ONE Connector Builder Developer's Guide provides the information you need to install the Sun ONE Connector Builder, build, deploy, and administer aspects of the resource adapter.

The following table displays the documentation roadmap and lists the tasks and concepts described in the Sun ONE Connector Builder Developer's Guide. The left column lists the module and the right column describes the basic idea of the module contents:

Documentation Roadmap

See this module:	If you want to do this:
"Overview of the Sun ONE Connector Builder"	Learn about the Sun ONE Connector Builder
"General Approach for Building Resource Adapters"	Learn about different types of EIS APIs
"Creating the Resource Adapter"	Create a resource adapter
"Modifying the Resource Adapter Definition"	Modify the resource adapter
"Customizing the Generated Resource Adapter"	Customize the generated code
"Adding SOAP Services to the Resource Adapter"	Add SOAP services
"Building/Packaging the Generated Resource Adapter"	Build and package the generated resource adapter
"Deploying the Resource Adapter"	Deploy and configure the resource adapter
"Testing the Generated Resource Adapter"	Test the generated resource adapter
"Administration and Monitoring of the Generated Resource Adapter"	Administer and monitor the generated resource adapter on iPlanet Application Server 6.5, iPlanet Web Server
"J2EE Connector Architecture"	Familiarize yourself with J2EE Connector Architecture
"Command Line Interface Reference"	Learn about Connector Builder Command Line Tools
"Installing Apache SOAP 2.2"	Install Apache SOAP 2.2 on iPlanet Application Server 6.5, iPlanet Web Server, Reference Implementation
"Working with Sun ONE Integration Server"	Work with the Sun ONE Integration Server.
"Trouble Shooting"	Get information about troubleshooting the Connector Builder
"Working with C/C++ API"	Get information about working with c?C++ APIs..
"Internationalization"	Get information on multi-byte character limitations.

Documentation Conventions

---

File and directory paths are given in Unix format (with forward slashes separating directory names). For Windows versions, the directory paths are the same, except that backslashes are used to separate directories.

This guide uses URLs of the form:

http://server.domain/path/file.html

In these URLs, server is the server name where applications are run; domain is your Internet domain name; path is the server's directory structure; and file is an individual filename. Italic items in URLs are placeholders.

This guide uses the following font conventions:

• The monospace font is used for sample code and code listings, API and language elements (such as function names and class names), file names, pathnames, directory names, and HTML tags.
• Italic type is used for code variables.
• Italic type is also used for book titles, emphasis, variables and placeholders, and words used in the literal sense.
• Bold type is used as either a paragraph lead-in or to emphasis words used in the literal sense.




---

Note	Throughout this manual, all Unix-specific descriptions apply to the Linux operating system as well, except where Linux is specifically mentioned.

---

Online Guide

---

You can find the Sun ONE Connector Builder documentation online in PDF and HTML formats. To locate these files, use the following URL:

http://docs.sun.com.

Related Information

---

In addition to this guide, there is additional information available for administrators, resource adapter developers and application programmers.

The following lists these documents:

• Release Notes for iPlanet Web Server Version 6.0 SP4
• iPlanet Web Server Version 6.0 Installation Guide
• iPlanet Web Server Version 6.0 Administrator's Guide
• Release Notes for iPlanet Application Server Version 6.5
• iPlanet Application Server Version 6.5 Installation Guide
• iPlanet Application Server Version 6.5 Administrator's Guide
• Sun ONE Studio 4, Enterprise Edition for Java
• J2EE Connector Architecture
• Sun ONE Application Server Developer's Guide