Sun Microsystems eWay JDBC-ODBC User Manual

SUN SEEBEYOND

eWAY™ JDBC/ODBC ADAPTER USER’S GUIDE

Release 5.1.2

Copyright © 2006 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, U.S.A. All rights reserved. Sun Microsystems, Inc. has intellectual property rights relating to technology embodied in the product that is described in this document. In particular, and without limitation, these intellectual property rights may include one or more of the U.S. patents listed at http://www.sun.com/patents and one or more additional patents or pending patent applications in the U.S. and in other countries. U.S. Government Rights - Commercial software. Government users are subject to the Sun Microsystems, Inc. standard license agreement and applicable provisions of the FAR and its supplements. Use is subject to license terms. This distribution may include materials developed by third parties. Sun, Sun Microsystems, the Sun logo, Java, Sun Java Composite Application Platform Suite, SeeBeyond, eGate, eInsight, eVision, eTL, eXchange, eView, eIndex, eBAM, eWay, and JMS are trademarks or registered trademarks of Sun Microsystems, Inc. in the U.S. and other countries. All SPARC trademarks are used under license and are trademarks or registered trademarks of SPARC International, Inc. in the U.S. and other countries. Products bearing SPARC trademarks are based upon architecture developed by Sun Microsystems, Inc. UNIX is a registered trademark in the U.S. and other countries, exclusively licensed through X/Open Company, Ltd. This product is covered and controlled by U.S. Export Control laws and may be subject to the export or import laws in other countries. Nuclear, missile, chemical biological weapons or nuclear maritime end uses or end users, whether direct or indirect, are strictly prohibited. Export or reexport to countries subject to U.S. embargo or to entities identified on U.S. export exclusion lists, including, but not limited to, the denied persons and specially designated nationals lists is strictly prohibited.

Copyright © 2006 Sun Microsystems, Inc., 4150 Network Circle, Santa Clara, California 95054, Etats-Unis. Tous droits réservés. Sun Microsystems, Inc. détient les droits de propriété intellectuels relatifs à la technologie incorporée dans le produit qui est décrit dans ce document. En particulier, et ce sans limitation, ces droits de propriété intellectuels peuvent inclure un ou plus des brevets américains listés à l'adresse http://www.sun.com/patents et un ou les brevets supplémentaires ou les applications de brevet en attente aux Etats - Unis et dans les autres pays. L'utilisation est soumise aux termes de la Licence. Cette distribution peut comprendre des composants développés par des tierces parties. Sun, Sun Microsystems, le logo Sun, Java, Sun Java Composite Application Platform Suite, Sun, SeeBeyond, eGate, eInsight, eVision, eTL, eXchange, eView, eIndex, eBAM et eWay sont des marques de fabrique ou des marques déposées de Sun Microsystems, Inc. aux Etats-Unis et dans d'autres pays. Toutes les marques SPARC sont utilisées sous licence et sont des marques de fabrique ou des marques déposées de SPARC International, Inc. aux Etats-Unis et dans d'autres pays. Les produits portant les marques SPARC sont basés sur une architecture développée par Sun Microsystems, Inc. UNIX est une marque déposée aux Etats-Unis et dans d'autres pays et licenciée exclusivement par X/Open Company, Ltd. Ce produit est couvert à la législation américaine en matière de contrôle des exportations et peut être soumis à la règlementation en vigueur dans d'autres pays dans le domaine des exportations et importations. Les utilisations, ou utilisateurs finaux, pour des armes nucléaires, des missiles, des armes biologiques et chimiques ou du nucléaire maritime, directement ou indirectement, sont strictement interdites. Les exportations ou réexportations vers les pays sous embargo américain, ou vers des entités figurant sur les listes d'exclusion d'exportation américaines, y compris, mais de manière non exhaustive, la liste de personnes qui font objet d'un ordre de ne pas participer, d'une façon directe ou indirecte, aux exportations des produits ou des services qui sont régis par la législation américaine en matière de contrôle des exportations et la liste de ressortissants spécifiquement désignés, sont rigoureusement interdites.

Part Number: 819-7387-10

Version 20061006184430

JDBC/ODBC eWay Adapter User’s Guide 2 Sun Microsystems, Inc.

Contents

Chapter 1

Introducing the JDBC/ODBC eWay 7

About Java Database Connectivity (JDBC) 7

JDBC Drivers 7

Type I: JDBC-ODBC Bridge 8 Type One Driver 8 Type II: Partial Java driver 9 Type Two Driver 9 Pure Java driver for database middleware 10 Type Three Driver 10 Type Four Driver: Direct-to-database pure Java driver 11

About the JDBC/ODBC eWay 13

What’s New in This Release 13

About This Document 14

JDBC eWay Javadoc 14

Scope 14 Intended Audience 15 Text Conventions 15

Introducing the JDBC/ODBC eWay

Welcome to the Sun SeeBeyond eWay™ JDBC/ODBC Adapter User’s Guide. This document includes information about installing, configuring, and using the Sun Java Composite Application Platform Suite JDBC/ODBC eWay™ Adapter, referred to as the JDBC eWay throughout this guide.

This chapter provides an overview of database connectivity (JDBC) and open database connectivity (ODBC) APIs. This chapter also introduces the JDBC/ODBC eWay.

What’s In This Chapter

 About Java Database Connectivity (JDBC) on page 7

 About the JDBC/ODBC eWay on page 13

 What’s New in This Release on page 13

 About This Document on page 14

 Related Documents on page 15

Chapter 1

 Sun Microsystems, Inc. Web Site on page 15

 Documentation Feedback on page 15

1.1 About Java Database Connectivity (JDBC)

Java Database Connectivity (JDBC) is an implementation of the Java programming language that dictates how databases communicate with each other. Through a standardized application programming interface (API), connectivity from database management systems (DBMS) to a wide range of SQL databases is accomplished. By deploying database drivers laced with JDBC technology, it is possible to connect to any database -- even in a heterogeneous environment -- and access tables, tabular data, flat files and more. When using JDBC, Java programmers have the ability to request connections to a database, send queries to the database using SQL statements, and receive results for advanced processing.

1.1.1 JDBC Drivers

To connect with individual databases, JDBC requires drivers for each database. Those drivers come in four varieties. Driver types 1 and 2 are typically intended for programmers that write applications. Driver types 3 and 4 are typically used by

JDBC/ODBC eWay Adapter User’s Guide 7 Sun Microsystems, Inc.

Chapter 1 Section 1.1

Introducing the JDBC/ODBC eWay About Java Database Connectivity (JDBC)

database and middleware vendors. The various driver types are described in the following sections:

 “Type I: JDBC-ODBC Bridge” on page 8

 “Type II: Partial Java driver” on page 9

 “Pure Java driver for database middleware” on page 10

 “Type Four Driver: Direct-to-database pure Java driver” on page 11

Type I: JDBC-ODBC Bridge

This combination provides JDBC access via ODBC drivers. ODBC binary code--and in many cases, database client code--must be loaded on each client machine that uses a JDBC-ODBC Bridge. A product called SequeLink from Data Direct Technologies provides a driver that supports some ODBC drivers (for example Microsoft Access).

Type one drivers provide JDBC access via one or more Open Database Connectivity (ODBC) drivers. ODBC, which predates JDBC, is widely used by developers to connect to databases in a non-Java environment.

Pros: A good approach for learning JDBC. May be useful for companies that already have ODBC drivers installed on each client machine — typically the case for Windowsbased machines running productivity applications. May be the only way to gain access to some low-end desktop databases.

Cons: Not for large-scale applications. Performance suffers because there's some overhead associated with the translation work to go from JDBC to ODBC. Doesn't support all the features of Java. User is limited by the functionality of the underlying ODBC driver.

Type One Driver

A JDBC/ODBC bridge provides JDBC API access through one or more ODBC drivers. Some ODBC native code and in many cases native database client code must be loaded on each client machine that uses this type of driver.

Figure 1 Typical Type 1 Driver Configuration

JDBC/ODBC eWay Adapter User’s Guide 8 Sun Microsystems, Inc.

Chapter 1 Section 1.1

Introducing the JDBC/ODBC eWay About Java Database Connectivity (JDBC)

The pros and cons for using this type of driver are as follows:

Pros

 Allows access to almost any database since the database ODBC drivers are readily

available

Cons

 Performance is degraded since the JDBC call goes through the bridge to the ODBC

driver then to the native database connectivity interface. The results are then sent back through the reverse process

 Limited Java feature set

 May not be suitable for a large-scale application

Type II: Partial Java driver

This type of driver converts JDBC calls into calls on the client API for Oracle, Sybase, Informix, DB2, or other DBMS. Note that, like the bridge driver, this style of driver requires that some binary code be loaded on each client machine.

This type of driver converts the calls that a developer writes to the JDBC application programming interface into calls that connect to the client machine's application programming interface for a specific database, such as IBM, Informix, Oracle or Sybase.

Pros: Performance is better than that of Type 1, in part because the Type 2 driver contains compiled code that's optimized for the back-end database server's operating system.

Cons: User needs to make sure the JDBC driver of the database vendor is loaded onto each client machine. Must have compiled code for every operating system that the application will run on. Best use is for controlled environments, such as an intranet.

Type Two Driver

A native-API partly Java technology-enabled driver converts JDBC calls into calls on the client API for DBMSs. Like the bridge driver, this style of driver requires that some binary code be loaded on each client machine. An example of this type of driver is the Oracle Thick Driver, which is also called OCI (see JDBC/ODBC Drivers on page 117 regarding JDBC eWay support of Oracle drivers).

JDBC/ODBC eWay Adapter User’s Guide 9 Sun Microsystems, Inc.

Chapter 1 Section 1.1

Introducing the JDBC/ODBC eWay About Java Database Connectivity (JDBC)

Figure 2 Typical Type 2 Driver Configuration

The pros and cons for using this type of driver are as follows:

Pros

 Allows access to almost any database since the databases ODBC drivers are readily

available

 Offers significantly better performance than the JDBC/ODBC Bridge

 Limited Java feature set

Cons

 Applicable Client library must be installed

 Type 2 driver shows lower performance than type 3 or 4

Pure Java driver for database middleware

This style of driver translates JDBC calls into the middleware vendor's protocol, which is then translated to a DBMS protocol by a middleware server. The middleware provides connectivity to many different databases.

This driver translates JDBC calls into the middleware vendor's protocol, which is then converted to a database-specific protocol by the middleware server software.

Pros: Better performance than Types 1 and 2. Can be used when a company has multiple databases and wants to use a single JDBC driver to connect to all of them. Server-based, so no need for JDBC driver code on client machine. For performance reasons, the back-end server component is optimized for the operating system on which the database is running.

Cons: Needs some database-specific code on the middleware server. If the middleware must run on different platforms, a Type 4 driver might be more effective.

Type Three Driver

A net-protocol fully Java-enabled driver translates JDBC API calls into a DBMSindependent net protocol which is then translated to a DBMS protocol by a server. This net server middleware is able to connect all of its Java technology-based clients to many

JDBC/ODBC eWay Adapter User’s Guide 10 Sun Microsystems, Inc.

Chapter 1 Section 1.1

Introducing the JDBC/ODBC eWay About Java Database Connectivity (JDBC)

different databases. Many mainframe legacy non-relational databases use this kind of driver.

Figure 3 Typical Type 3 Middleware Driver Configuration

The pros and cons for using this type of driver are as follows:

Pros

 Allows access to almost any database since the databases ODBC drivers are readily

available

 Offers significantly better performance than the JDBC/ODBC Bridge and Type 2

Drivers

 Advanced Java feature set

 Scalable

 Caching

 Advanced system administration

 Does not require applicable database client libraries

Cons

 Requires a separate JDBC middleware server to translate specific native-

connectivity interface.

Type Four Driver: Direct-to-database pure Java driver

This style of driver converts JDBC calls into a network protocol that sends the converted packets--in a proprietary format--to be used directly by DBMSs, thus allowing a direct call from the client machine to the DBMS server and providing a practical solution for intranet access. This type of driver has become very popular recently and is supported by most database software vendors. All JDBC drivers from Data Direct Technologies (driver vendor) are Type 4 drivers.

Pros: Better performance than Types 1 and 2. No need to install special software on client or server.

JDBC/ODBC eWay Adapter User’s Guide 11 Sun Microsystems, Inc.

Chapter 1 Section 1.1

Introducing the JDBC/ODBC eWay About Java Database Connectivity (JDBC)

Cons: Not optimized for server operating system, so the driver can't take advantage of operating system features. (The driver is optimized for the database and can take advantage of the database vendor's functionality.) User needs a different driver for each different database.

A native-protocol fully Java technology-enabled driver converts JDBC technology calls into the network protocol used by DBMSs directly. This allows a direct call from the client machine to the DBMS server.

Figure 4 Typical Type 4 Driver Configuration

The pros and cons for using this type of driver are as follows:

Pros

 Allows access to almost any database since the databases ODBC drivers are readily

available

 Offers significantly better performance than the JDBC/ODBC Bridge and Type 2

Drivers

 Scalable

 Caching

 Advanced system administration

 Superior performance

 Advance Java feature set

 Does not require applicable database client libraries

Cons

 Each database will require a driver

JDBC/ODBC eWay Adapter User’s Guide 12 Sun Microsystems, Inc.

Chapter 1 Section 1.2

Introducing the JDBC/ODBC eWay About the JDBC/ODBC eWay

1.2 About the JDBC/ODBC eWay

This document describes how to install and configure the JDBC/ODBC eWay. The JDBC/ODBC eWay enables the eGate system to exchange data with external databases. The Sun Java Composite Application Platform Suite (Java CAPS) contains many database eWays. You should use those eWays to interface with the databases they support. The JDBC/ODBC eWay should only be used when you have a driver or a database that is not supported by those eWays.

The JDBC/ODBC eWay uses Java Collaborations to interact with one or more external databases. By using a Java Collaboration Service it is possible for eGate components such as eWay Adapters to connect to external databases and execute business rules.

1.3 What’s New in This Release

The Sun SeeBeyond eWay JDBC Adapter includes the following changes and new features:

New for Version 5.1.2

 WebLogic Support: Supports automatic deployment of EAR files to WebLogic

Application Server version 9.1.

New for Version 5.1.1

 This is a maintenance release. No new features.

New for Version 5.1.0

 Version Control: An enhanced version control system allows you to effectively

manage changes to the eWay components.

 Multiple Drag-and-Drop Component Mapping from the Deployment Editor: The

Deployment Editor now allows you to select multiple components from the Editor’s component pane, and drop them into your Environment component.

 Support to read configuration parameters from LDAP at runtime.

 Connection Retry Support: Allows you to specify the number of attempts to

reconnect, and the interval between retry attempts, in the event of a connection failure.

 Relaunchable OTD Support: An OTD can be rebuilt and saved (under the same

name) then relaunched back to the same Java Collaboration or BPEL. This allows you to change the metadata in an OTD without having to completely recreate the business logic from scratch.

 Editable OTD Support: An existing OTD can be edited and saved using the OTD

Wizard. This allows you to make minor changes to an OTD without having to completely recreate the OTD from scratch. The OTD is then rebuilt, saved, and then relaunched back to the same Java Collaboration or BPEL.

JDBC/ODBC eWay Adapter User’s Guide 13 Sun Microsystems, Inc.

Chapter 1 Section 1.4

Introducing the JDBC/ODBC eWay About This Document

 Connectivity Map Generator: Generates and links your Project’s Connectivity Map

components using a Collaboration or Business Process.

Many of these features are documented further in the Sun SeeBeyond eGate™ Integrator User’s Guide or the Sun SeeBeyond eGate™ Integrator System Administration Guide.

1.4 About This Document

This document includes the following chapters:

 Chapter 1 “Introducing the JDBC/ODBC eWay”: Provides an overview

description of the product as well as high-level information about this document.

 Chapter 2 “Installing the JDBC/ODBC eWay”: Describes the system requirements

and provides instructions for installing the JDBC eWay.

 Chapter 3 “Setting Properties of the JDBC/ODBC eWay”: Provides instructions for

configuring the eWay to communicate with JDBC drivers.

 Chapter 4 “Using the JDBC/ODBC eWay Database Wizard”: Provides instructions

for creating Object Type Definitions to be used with the JDBC eWay.

 Chapter 5 “Using JDBC/ODBC Operations”: Provides instructions on using JDBC

database eWay operations in BPEL and JCD.

 Chapter 6 “Implementing the JDBC/ODBC eWay Sample Projects”: Provides

instructions for installing and running the sample Projects.

 Appendix A “JDBC/ODBC Drivers”: Provides instructions for installing and

running database drivers.

JDBC eWay Javadoc

A JDBC eWay Javadoc is also provided that documents the Java methods available with the JDBC eWay. The Javadoc is uploaded with the eWay’s documentation file (JDBCeWayDocs.sar) and downloaded from the Documentation tab of the Sun Java Composite Application Platform Suite Installer. To access the full Javadoc, extract the Javadoc to an easily accessible folder, and double-click the index.html file.

1.4.1 Scope

This user’s guide provides a description of the JDBC eWay Adapter. It includes directions for installing the eWay, configuring the eWay properties, and implementing the eWay’s sample Projects. This document is also intended as a reference guide, listing available properties, functions, and considerations. For a reference of available JDBC eWay Java methods, see the associated Javadoc.

JDBC/ODBC eWay Adapter User’s Guide 14 Sun Microsystems, Inc.

Chapter 1 Section 1.5

Introducing the JDBC/ODBC eWay Related Documents

1.4.2 Intended Audience

This guide is intended for experienced computer users who have the responsibility of helping to set up and maintain a fully functioning Java Composite Application Platform Suite system. This person must also understand any operating systems on which the Java Composite Application Platform Suite will be installed (Windows and UNIX), and must be thoroughly familiar with Windows-style GUI operations.

1.4.3 Text Conventions

The following conventions are observed throughout this document.

Table 1 Text Conventions

Text Convention Used For Examples

Bold Names of buttons, files, icons,

parameters, variables, methods, menus, and objects

Monospaced Command line arguments, code

samples; variables are shown in

bold italic

Blue bold

Blue underlined

1.5 Related Documents

Hypertext links within document

Hypertext links for Web addresses (URLs) or email addresses

The following Sun documents provide additional information about the Sun Java Composite Application Platform Suite product:

 Sun SeeBeyond eGate™ Integrator User’s Guide

 Sun Java Composite Application Platform Suite Installation Guide

 Click OK.  On the File menu, click Exit.  Select the eGate.sar file.

java -jar filename.jar

See

Text Conventions on page 15

http://www.sun.com

1.6 Sun Microsystems, Inc. Web Site

The Sun Microsystems web site is your best source for up-to-the-minute product news and technical support information. The site’s URL is:

http://www.sun.com

JDBC/ODBC eWay Adapter User’s Guide 15 Sun Microsystems, Inc.

Chapter 1 Section 1.7

Introducing the JDBC/ODBC eWay Documentation Feedback

1.7 Documentation Feedback

We appreciate your feedback. Please send any comments or suggestions regarding this document to:

CAPS_docsfeedback@sun.com

JDBC/ODBC eWay Adapter User’s Guide 16 Sun Microsystems, Inc.

Installing the JDBC/ODBC eWay

This chapter describes how to install the JDBC/ODBC eWay.

What’s in this Chapter

 Installing the JDBC eWay on page 17

 ICAN 5.0 Project Migration Procedures on page 19

 Installing Enterprise Manager eWay Plug-Ins on page 21

2.1 Installing the JDBC eWay

The Java Composite Application Platform Suite Installer, referred to throughout this guide as the Suite Installer, is a web-based application that is used to select and upload core products, composite applications, and add-on files (eWays) during the installation process. The following section describes how to install the components required for this eWay.

Chapter 2

Refer to the readme for the latest information on:

 Supported Operating Systems

 System Requirements

 External System Requirements

The JDBC eWay Readme is uploaded with the eWay’s documentation file (JDBCeWayDocs.sar) and can be accessed from the Documentation tab of the Suite Installer.

Note: When the Repository is running on a UNIX operating system, the eWays are loaded

from the Suite Installer running on a Windows platform connected to the Repository server using Internet Explorer.

JDBC/ODBC eWay Adapter User’s Guide 17 Sun Microsystems, Inc.

Chapter 2 Section 2.1

Installing the JDBC/ODBC eWay Installing the JDBC eWay

2.1.1 Installing the JDBC eWay on an eGate supported system

Follow the directions for installing the Sun Java Composite Application Platform Suite in the Sun Java Composite Application Platform Suite Installation Guide. After you have installed Core Products, do the following:

1 From the Sun Java Composite Application Platform Suite Installer’s Select Sun

Java Composite Application Platform Suite Products Installed table (Administration tab), click the Click to install additional products link.

2 Expand the eWay option.

3 Select the products for your Sun Java Composite Application Platform Suite and

include the following:

 File eWay (the File eWay is used by most sample Projects)

 JDBCeWay

To upload the JDBC eWay User’s Guide, Help file, Javadoc, Readme, and sample Projects, expand the Documentation option and select JDBCeWayDocs.

4 Once you have selected all of your products, click Next in the top-right or bottom-

right corner of the Select Sun Java Composite Application Platform Suite Products to Install box.

5 From the Selecting Files to Install box, locate and select your first product’s SAR

file. Once you have selected the SAR file, click Next. Your next selected product appears. Follow this procedure for each of your selected products. The Installation Status window appears and installation begins after the last SAR file has been selected.

6 Once your product’s installation is finished, continue installing the Sun Java

Composite Application Platform Suite as instructed in the Sun Java Composite Application Platform Suite Installation Guide.

Adding the eWay to an Existing Sun Java Composite Application Platform Suite Installation

If you are adding the eWay to an existing Sun Java Composite Application Platform Suite installation, do the following:

1 Complete steps 1 through 4 above.

2 Once your product’s installation is complete, open the Enterprise Designer and

select Update Center from the Tools menu. The Update Center Wizard appears.

3 For Step 1 of the wizard, simply click Next.

4 For Step 2 of the wizard, click the Add All button to move all installable files to the

Include in Install field, then click Next.

5 For Step 3 of the wizard, wait for the modules to download, then click Next.

6 The wizard’s Step 4 window displays the installed modules. Review the installed

modules and click Finish.

JDBC/ODBC eWay Adapter User’s Guide 18 Sun Microsystems, Inc.

Chapter 2 Section 2.2

Installing the JDBC/ODBC eWay ICAN 5.0 Project Migration Procedures

7 When prompted, restart the IDE (Integrated Development Environment) to

complete the installation.

After Installation

Once you install the eWay, it must then be incorporated into a Project before it can perform its intended functions. See the eGate Integrator User’s Guide for more information on incorporating the eWay into an eGate Project.

2.1.2 Extracting the Sample Projects and Javadocs

The JDBC eWay includes sample Projects and Javadocs. The sample Projects are designed to provide you with a basic understanding of how certain database operations are performed using the eWay, while Javadocs provide a list of classes and methods exposed in the eWay.

Steps to extract the Javadoc include:

1 Click the Documentation tab of the Sun Java Composite Application Platform Suite

Installer, then click the Add-ons tab.

2 Click the JDBC eWay Adapter link. Documentation for the JDBC eWay appears in

the right pane.

3 Click the icon next to Javadoc and extract the ZIP file.

4 Open the index.html file to view the Javadoc.

Steps to extract the Sample Projects include:

1 Click the Documentation tab of the Sun Java Composite Application Platform Suite

Installer, then click the Add-ons tab.

2 Click the JDBC eWay Adapter link. Documentation for the JDBC eWay appears in

the right pane.

3 Click the icon next to Sample Projects and extract the ZIP file. Note that the

JDBC_eWay_Sample.zip file contains two additional ZIP files for each sample

Project.

Refer to “Importing a Sample Project” on page 73 for instructions on importing the sample Project into your repository via the Enterprise Designer.

2.2 ICAN 5.0 Project Migration Procedures

This section describes how to transfer your current ICAN 5.0.x Projects to the Sun Java Composite Application Platform Suite 5.1.2. To migrate your ICAN 5.0.x Projects to the Sun Java Composite Application Platform Suite 5.1.2, do the following:

Export the Project

1 Before you export your Projects, save your current ICAN 5.0.x Projects to your

Repository.

JDBC/ODBC eWay Adapter User’s Guide 19 Sun Microsystems, Inc.

Chapter 2 Section 2.2

Installing the JDBC/ODBC eWay ICAN 5.0 Project Migration Procedures

2 From the Project Explorer, right-click your Project and select Export from the

shortcut menu. The Export Manager appears.

3 Select the Project that you want to export in the left pane of the Export Manager and

move it to the Selected Projects field by clicking the Add to Select Items (arrow) button, or click All to include all of your Projects.

4 In the same manner, select the Environment that you want to export in the left pane

of the Export Manager and move it to the Selected Environments field by clicking the Add to Select Items (arrow) button, or click All to include all of your Environments.

5 Browse to select a destination for your Project ZIP file and enter a name for your

Project in the ZIP file field.

6 Click Export to create the Project ZIP file in the selected destination.

Install Java CAPS 5.1.2

1 Install Java CAPS 5.1.2, including all eWays, libraries, and other components used

by your ICAN 5.0 Projects.

2 Start the Java CAPS 5.1.2 Enterprise Designer.

Import the Project

1 From the Java CAPS 5.1.2 Enterprise Designer’s Project Explorer tree, right-click the

Repository and select Import Project from the shortcut menu. The Import Manager appears.

2 Browse to and select your exported Project file.

3 Click Import. A warning message, “Missing APIs from Target Repository,” may

appear at this time. This occurs because various product APIs were installed on the ICAN 5.0 Repository when the Project was created that are not installed on the Java CAPS 5.1.2 Repository. These APIs may or may not apply to your Projects. You can ignore this message if you have already installed all of the components that correspond to your Projects. Click Continue to resume the Project import.

4 Close the Import Manager after the Project is successfully imported.

Deploy the Project

1 A new Deployment Profile must be created for each of your imported Projects.

When a Project is exported, the Project’s components are automatically “checked in” to Version Control to write-protected each component. These protected components appear in the Explorer tree with a red padlock in the bottom-left corner of each icon. Before you can deploy the imported Project, the Project’s components must first be “checked out” of Version Control from both the Project Explorer and the Environment Explorer. To “check out” all of the Project’s components, do the following:

A From the Project Explorer, right-click the Project and select Version Control >

Check Out from the shortcut menu. The Version Control - Check Out dialog box

appears.

B Select Recurse Project to specify all components, and click OK.

JDBC/ODBC eWay Adapter User’s Guide 20 Sun Microsystems, Inc.

Chapter 2 Section 2.3

Installing the JDBC/ODBC eWay Installing Enterprise Manager eWay Plug-Ins

C Select the Environment Explorer tab, and from the Environment Explorer, right-

click the Project’s Environment and select Version Control > Check Out from the shortcut menu.

D Select Recurse Environment to specify all components, and click OK.

2 If your imported Project includes File eWays, these must be reconfigured in your

Environment prior to deploying the Project.

To reconfigure your File eWays, do the following:

A From the Environment Explorer tree, right-click the File External System, and

select Properties from the shortcut menu. The Properties Editor appears.

B Set the inbound and outbound directory values, and click OK. The File External

System can now accommodate both inbound and outbound eWays.

3 Deploy your Projects.

Note: Only projects developed on ICAN 5.0.2 and later can be imported and migrated

successfully into the Sun Java Composite Application Platform Suite.

2.3 Installing Enterprise Manager eWay Plug-Ins

The Sun SeeBeyond Enterprise Manager is a Web-based interface you use to monitor and manage your Sun Java Composite Application Platform Suite applications. The Enterprise Manager requires an eWay specific “plug-in” for each eWay you install. These plug-ins enable the Enterprise Manager to target specific alert codes for each eWay type, as well as start and stop the inbound eWays.

The Sun Java Composite Application Platform Suite Installation Guide describes how to install Enterprise Manager. The Sun SeeBeyond eGate Integrator System Administration Guide describes how to monitor servers, Services, logs, and alerts using the Enterprise Manager and the command-line client.

The eWay Enterprise Manager Plug-ins are available from the List of Components to

Download under the Sun Java Composite Application Platform Suite Installer’s Downloads tab.

There are two ways to add eWay Enterprise Manager plug-ins:

 From the Sun SeeBeyond Enterprise Manager

 From the Sun Java Composite Application Platform Suite Installer

To add plug-ins from the Enterprise Manager

1 From the Enterprise Manager’s Explorer toolbar, click configuration.

2 Click the Web Applications Manager tab, go to the Auto-Install from Repository

sub-tab, and connect to your Repository.

3 Select the application plug-ins you require, and click Install. The application plug-

ins are installed and deployed.

JDBC/ODBC eWay Adapter User’s Guide 21 Sun Microsystems, Inc.

Chapter 2 Section 2.3

Installing the JDBC/ODBC eWay Installing Enterprise Manager eWay Plug-Ins

To add plug-ins from the Sun Java Composite Application Platform Suite Installer

1 From the Sun Java Composite Application Platform Suite Installer’s Downloads

tab, select the Plug-Ins you require and save them to a temporary directory.

2 From the Enterprise Manager’s Explorer toolbar, click configuration.

3 Click the Web Applications Manager tab and go to the Manage Applications sub-

tab.

4 Browse for and select the WAR file for the application plug-in that you

downloaded, and click Deploy. The plug-ins is installed and deployed.

2.3.1 Viewing Alert Codes

You can view and delete alerts using the Enterprise Manager. An alert is triggered when a specified condition occurs in a Project component. The purpose of the alert is to warn the administrator or user that a condition has occurred.

To View the eWay Alert Codes

1 Add the eWay Enterprise Manager plug-in for this eWay.

2 From the Enterprise Manager’s Explorer toolbar, click configuration.

3 Click the Web Applications Manager tab and go to the Manage Alert Codes sub-

tab. Your installed eWay alert codes display under the Results section. If your eWay alert codes are not displayed under Results, do the following:

A From the Install New Alert Codes section, browse to and select the eWay alert

properties file for the application plug-in that you added. The alert properties files are located in the alertcodes folder of your Sun Java Composite Application Platform Suite installation directory.

B Click Deploy. The available alert codes for your application are displayed under

Results. A listing of the eWay’s available alert codes is displayed in Table 2.

Table 2 Alert Codes for the JDBC/ODBC eWay

Alert Code\Description Description Details User Actions

DBCOMMON-CONNECTFAILED000001=Failed to connect to database {0} on host {1}. Reason: The Pooled connection could not be allocated: [{2}]

DBCOMMON-CONNECTFAILED000002=Operation failed because of a database connection error. Reason: [{0}]

Occurs during the initial database connection establishment.

Occurs while retrieving a connection from the database or the connection pool.

 Database is down; start your

database.

 External configuration information

is invalid. You may need to verify the following:

 Server name  Database name  User  Password  Port

 Verify that the database has not

terminated with unexpected errors.

JDBC/ODBC eWay Adapter User’s Guide 22 Sun Microsystems, Inc.

Chapter 2 Section 2.3

Installing the JDBC/ODBC eWay Installing Enterprise Manager eWay Plug-Ins

Alert Code\Description Description Details User Actions

DBCOMMON-CONNECTFAILED000005=Connection handle not usable. Reason:[{0}]

DBCOMMON-XARESOURCEFAILED000001=Unable to get XAResource for the database. Reason: [{0}]

DBCOMMON-XACONNECTFAILED000001=Failed to connect to database {0} on host {1}. The XA connection could not be allocated: Reason [{2}]

DBCOMMON-XASTARTFAILED000001=Unable to perform XAStart for the connection. Reason: [{0}]

DBCOMMON-XAENDFAILED000001=XAEnd failed. Reason: [{0}]

DBCOMMON-CANNOT-GETISOLATION-LEVEL=Unable to get isolationLevel for the transaction. Reason: [{0}]

The connection in the pool is stale and is not usable.

Could not obtain XAResource for the connection.

Occurs during the initial database connection establishment.

A connection error has occurred which caused XASTART to fail.

Error occurred during commit on XA connection.

Could not read transaction isolation information of the connection.

 Probably a database restart

occurred causing the connection to be stale, retry the operation after the database is up.

 Check if the database supports XA

and has been configured for Distributed Transaction Support.

 Check if the database is

configured for XA and if the database is running.

 External configuration information

is invalid. You may need to verify the following:

 Server name  Database name  User  Password  Port

 Check if the database is running,

and there are no network issues.

 Look for the detailed error

mentioned in the alert for the appropriate action.

 Transaction isolation is one of the

following constants:

 Connection.TRANSACTION_REA

D_UNCOMMITTED

 Connection.TRANSACTION_REA

D_COMMITTED

 Connection.TRANSACTION_REPE

ATABLE_READ

 Connection.TRANSACTION_SERI

ALIZABLE

 Connection.TRANSACTION_NO

Note: Confirm with the

vendor that the getIsolation() method of the connection is implemented correctly.

For information on Managing and Monitoring alert codes and logs, as well as how to view the alert generated by the project component during runtime, see the Sun SeeBeyond eGate™ Integrator System Administration Guide.

JDBC/ODBC eWay Adapter User’s Guide 23 Sun Microsystems, Inc.

Chapter 2 Section 2.3

Installing the JDBC/ODBC eWay Installing Enterprise Manager eWay Plug-Ins

Note: An alert code is a warning that an error has occurred. It is not a diagnostic. The user

actions noted above are just some possible corrective measures you may take. Refer to the log files for more information. For information on Managing and Monitoring alert codes and logs, see the Sun SeeBeyond eGate Integrator System Administration Guide.

JDBC/ODBC eWay Adapter User’s Guide 24 Sun Microsystems, Inc.

Chapter 3

Setting Properties of the JDBC/ODBC eWay

This chapter describes how to set the properties of the JDBC/ODBC eWay.

What’s In This Chapter

 Creating and Configuring a JDBC eWay on page 25

 Configuring the eWay Connectivity Map Properties on page 25

 Configuring the eWay Environment Properties on page 29

 eWay Connectivity Map Properties on page 30

 eWay Environment Properties on page 31

3.1 Creating and Configuring a JDBC eWay

All eWays contain a unique set of default configuration parameters. After the eWays are established and a JDBC External System is created in the Project’s Environment, the eWay parameters are modified for your specific system. The JDBC eWay configuration parameters are modified from two locations:

 Connectivity Map: These parameters most commonly apply to a specific

component eWay, and may vary from other eWays (of the same type) in the Project.

 Environment Explorer : These parameters are commonly global, applying to all

eWays (of the same type) in the Project. The saved properties are shared by all eWays in the JDBC External System window.

 Collaboration or Business Process: JDBC eWay properties may also be set from

your Collaboration or Business Process, in which case the settings will override the corresponding properties in the eWay’s Connectivity Map configuration. Any properties that are not overridden retain their configured default settings.

3.2 Configuring the eWay Connectivity Map Properties

When you connect an External Application to a Collaboration, Enterprise Designer automatically assigns the appropriate eWay to the link. Each eWay is supplied with a list of eWay connections (transaction support levels) from which to choose.

Transaction support levels provided by the JDBC eWay include:

JDBC/ODBC eWay Adapter User’s Guide 25 Sun Microsystems, Inc.

Chapter 3 Section 3.2

Setting Properties of the JDBC/ODBC eWay Configuring the eWay Connectivity Map Properties

 Outbound JDBC eWay

 Outbound JDBC XA eWay

 Outbound JDBC non-Transactional eWay

To configure the eWay properties:

1 On the Enterprise Designer’s Connectivity Map, double-click the JDBC eWay icon.

The eWay Connections window appears.

Figure 5 Connectivity Map with Components

JDBC eWay

2 Select a parameter from the list and click OK.

Figure 6 Template window

The choices to make are as follows:

 Outbound JDBC non-Transactional eWay: Also referred to as NoTransaction,

this support level indicates that the Collaboration does not support transactions. This means that when a transaction aborts, there is no ability to roll back any changes to the previous update.

 Outbound JDBC XA-eWay: Also referred to as XATransaction, this support

level allows two-phase commit. This means that the transaction, when aborted, will roll back all changes when one of the updates fails. The update could occur in the database eWay or other eWays that support XA. Additionally, the Collaboration can contain only the database eWay, or a combination of database eWay and other eWays that support XA.

JDBC/ODBC eWay Adapter User’s Guide 26 Sun Microsystems, Inc.

Chapter 3 Section 3.2

Setting Properties of the JDBC/ODBC eWay Configuring the eWay Connectivity Map Properties

 Outbound JDBC eWay: Also referred to as LocalTransaction, this support level

is opposite to NoTransaction, and this means that the transaction, when The Properties window opens, displaying the default properties for the eWay.

3 The Properties window opens, displaying the default properties for the eWay.

Figure 7 Outbound eWay Properties

3.2.1 Transaction Support Levels Between Different Versions

The types of transaction support levels used in Java CAPS 5.1.0 may be different from the support levels used in Java CAPS 5.1.2. Projects that are imported from a Java CAPS 5.1.0 version can potentially display different results, depending on whether the 5.1.0 Java Collaboration Definition (JCD) included multiple (insert/ update/delete) operations. This only affects non-XA transactions. If you are using an XA transaction, then you can skip this section.

Example:

In 5.1.0, five new records are to be inserted into a table. If the last record fails to insert (such as when a duplicate key exists), all previous records will have been inserted. This is the behavior of NoTransaction support.

JDBC/ODBC eWay Adapter User’s Guide 27 Sun Microsystems, Inc.

Chapter 3 Section 3.2

Setting Properties of the JDBC/ODBC eWay Configuring the eWay Connectivity Map Properties

In 5.1.2, five new records are to be inserted into a table. If one of the records fails to insert (such as when a duplicate key exists), the other four records will not be inserted. This is the behavior of the LocalTransaction.

In order to achieve the same result as in 5.1.0 versions, you can choose the method below:

A In the Connectivity Map, delete the link to the database external application,

then reconnect the link and select NoTransaction.

B Fill in the NoTransaction property for the database external system under the

Environment.

C Rebuild the Project.

The following charts identifies what transaction support levels changed between

5.0.5 and 5.1.2, and 5.1.0 and 5.1.2, respectively. Note that there are no changes

when migrating from ICAN version 5.0.5 and Java CAPS 5.1.2.

Figure 8 Transaction Support Levels

ICAN Version 5.0.5 Java CAPS 5.1.2

Outbound Informix eWay

(LocalTransaction)

Outbound Informix XA

eWay

(XATransaction)

Outbound Informix eWay

(LocalTransaction)

Outbound Informix XA

eWay

(XATransaction)

Java CAPS 5.1.0 Java CAPS 5.1.2

Outbound Informix eWay

(LocalTransaction)

Outbound Informix XA

eWay

(XATransaction)

Outbound Informix non-

Transaction eWay

(NoTransaction)

Outbound Informix XA

eWay

(XATransaction)

Under the scenario noted above, if you want 5.1.2 behavior for a LocalTransaction, then set your eWay connection to be Outbound JDBC/ODBC non-Transactional eWay (NoTransaction).

JDBC/ODBC eWay Adapter User’s Guide 28 Sun Microsystems, Inc.

Chapter 3 Section 3.3

Setting Properties of the JDBC/ODBC eWay Configuring the eWay Environment Properties

3.3 Configuring the eWay Environment Properties

The eWay Environment Configuration properties contain parameters that define how the eWay connects to and interacts with other eGate components within the Environment. When you create a new JDBC External System, you may configure the type of External System required.

Available External System properties include:

 Inbound JDBC eWay

 Outbound JDBC eWay

 Outbound JDBC non-Transactional eWay

 Outbound JDBC XA eWay

To Configure the Environment Properties:

1 In Enterprise Explorer, click the Environment Explorer tab.

2 Expand the Environment created for the JDBC Project and locate the JDBC External

System.

Note: For more information on creating an Environment, see the “Sun SeeBeyond eGate

Integrator Tutorial”.

3 Right-click the External System created for the JDBC Project and select Properties

from the list box. The Environment Configuration Properties window appears.

JDBC/ODBC eWay Adapter User’s Guide 29 Sun Microsystems, Inc.

Chapter 3 Section 3.4

Setting Properties of the JDBC/ODBC eWay eWay Connectivity Map Properties

Figure 9 JDBC eWay Environment Configuration

4 Click on any folder to display the default configuration properties for that section.

5 Click on any property field to make it editable.

After modifying the configuration properties, click OK to save the changes.

3.4 eWay Connectivity Map Properties

The eWay Connectivity Map consists of the following properties categories.

Outbound eWay Configuration Sections Include:

 Connectivity Map Outbound eWay Properties on page 31

Outbound non-Transactional eWay Configuration Settings Include:

 Connectivity Map Outbound non-Transactional eWay Properties on page 31

JDBC/ODBC eWay Adapter User’s Guide 30 Sun Microsystems, Inc.

+ 103 hidden pages

Sun Microsystems eWay JDBC-ODBC User Manual

Specifications and Main Features

Frequently Asked Questions

User Manual

Contents

Introducing the JDBC/ODBC eWay

1.1 About Java Database Connectivity (JDBC)

1.1.1 JDBC Drivers

Type I: JDBC-ODBC Bridge

Type One Driver

Type II: Partial Java driver

Type Two Driver

Pure Java driver for database middleware

Type Three Driver

Type Four Driver: Direct-to-database pure Java driver

1.2 About the JDBC/ODBC eWay

1.3 What’s New in This Release

1.4 About This Document

JDBC eWay Javadoc

1.4.1 Scope

1.4.2 Intended Audience

1.4.3 Text Conventions

1.5 Related Documents

1.6 Sun Microsystems, Inc. Web Site

1.7 Documentation Feedback

Installing the JDBC/ODBC eWay

2.1 Installing the JDBC eWay

2.1.1 Installing the JDBC eWay on an eGate supported system

Adding the eWay to an Existing Sun Java Composite Application Platform Suite Installation

After Installation

2.1.2 Extracting the Sample Projects and Javadocs

2.2 ICAN 5.0 Project Migration Procedures

2.3 Installing Enterprise Manager eWay Plug-Ins

2.3.1 Viewing Alert Codes

Setting Properties of the JDBC/ODBC eWay

3.1 Creating and Configuring a JDBC eWay

3.2 Configuring the eWay Connectivity Map Properties

3.2.1 Transaction Support Levels Between Different Versions

3.3 Configuring the eWay Environment Properties

3.4 eWay Connectivity Map Properties