IBM WebSphere Adapters Manual de usuario

WebSphere®Adapters

WebSphere Adapter Toolkit User Guide

Version 6 Release 2



WebSphere®Adapters

WebSphere Adapter Toolkit User Guide

Version 6 Release 2



Note

Before using this information and the product it supports, read the information in “Notices” on page 211.

December 2008

This edition applies to version 6, release 2, modification 0 of and to all subsequent releases and modifications until

otherwise indicated in new editions.

To send us your comments about this document, email mailto://[email protected]. We look forward to

hearing from you.

When you send information to IBM, you grant IBM a nonexclusive right to use or distribute the information in any

way it believes appropriate without incurring any obligation to you.

Restricted Rights - Use, duplication or disclosure restricted by GSA ADP Schedule Contract with IBM Corp.

US Government Users Restricted Rights – Use, duplication or disclosure restricted by GSA ADP Schedule Contract

with IBM Corp.

Contents

WebSphere Adapter Toolkit ......1

IBM WebSphere Adapter Toolkit technology

overviews ...............2

IBM WebSphere Adapters .........2

Architectural overview ..........4

How metadata is used at build time and run time 7

Using Enterprise Metadata Discovery to build

services ...............7

IBM WebSphere Adapter Toolkit overview ....8

New Connector Project wizard overview ....9

Resource Adapter Deployment Descriptor Editor

overview ..............10

Adapter Foundation Classes overview ....10

IBM WebSphere Adapter Toolkit tasks .....11

IBM WebSphere Adapter Toolkit installation

requirements ..............11

Samples overview ............12

Running the Twine Ball sample using WebSphere

Integration Developer ..........13

Running the Twine Ball sample using Rational

Application Developer..........26

Troubleshooting the samples........28

Using the New Connector Project wizard ....28

Launching the New Connector Project wizard . . 29

Specify project properties .........31

Specify project facets ..........32

Specify connector project module settings . . . 32

Specify resource adapter properties .....33

Specify generation options ........34

Generating an IBM WebSphere Resource Adapter 35

Generating a JCA resource adapter .....49

Generated code and deployment descriptor. . . 55

Using the Resource Adapter Deployment Descriptor

editor ................56

Displaying the deployment descriptor ....56

Modifying deployment descriptor properties . . 66

Editing deployment descriptor source ....67

Implementing code from the IBM WebSphere

Adapter Toolkit .............68

Foundation Classes implementation overview . . 68

Data model .............69

Inbound event notification ........79

Inbound callback event notification .....89

Outbound support ...........97

Data and metadata ..........115

Enterprise Metadata Discovery general

interfaces and implementation for application

adapters ..............123

Enterprise Metadata Discovery interfaces and

implementation for technology adapters . . . 157

Structured record implementation .....162

Data binding implementation .......166

Bidirectional language support ......167

Problem determination .........168

Validating the code ...........193

Testing enterprise metadata discovery (EMD) of

the adapter .............193

Testing the adapter in unmanaged mode . . . 194

Testing the adapter in managed mode ....197

Validating code with Rational Application

Developer and WebSphere Application Server . 203

Creating and exporting a resource adapter . . . 206

Reference...............208

Terminology.............208

Notices ..............211

Programming interface information ......213

Trademarks and service marks .......213

Index ...............215

iv WebSphere Adapters: WebSphere Adapter Toolkit User Guide

WebSphere Adapter Toolkit

The IBM®WebSphere®Adapter Toolkit provides the development tools, libraries

and sample code to assist you in creating JCA resource adapters.

With the toolkit you may create either of the following:

vA resource adapter based on the interfaces defined by the JCA Resource

Adapter 1.5 specification. Choose this path if your goal is developing a resource

adapter that can run either unmanaged or managed within any JCA 1.5

compliant container.

vA resource adapter that extends the WebSphere Adapter Foundation Classes

library. Choose this path if your goal is to create a resource adapter

implementation that can run in a managed server runtime environment like

WebSphere Process Server and that exhibits the common functionality and

extended qualities of service offered specifically by WebSphere Adapters.

WebSphere Adapters are based on the JCA 1.5 specification. These adapters are

supported on multiple runtime environments and brokers.

Implementing a WebSphere adapter allows you to take advantage of the quality of

services offered in the WebSphere Adapter foundation classes (AFC) and the

flexibility of being able to run the adapter on runtime environments other than

WebSphere Process Server.

In either case, the toolkit provides a project creation wizard that generates the code

that you then implement. In addition, the toolkit provides a specialized editor that

facilitates the task of creating and configuring a resource adapter deployment

descriptor.

This document focuses primarily on development of resource adapters and

artifacts that extend the WebSphere Adapter Foundation Class library.

The following figure illustrates the process of developing a JCA resource adapter

using the WebSphere Adapter Toolkit.

Using the WebSphere Adapter Toolkit

The development process using the IBM WebSphere Adapter Toolkit includes the

following as shown in the illustration:

1. Run the New JCA Resource Adapter Project wizard.

The wizard generates a resource adapter deployment descriptor and code. The

code can include sequence of calls, log and trace messages and comments.

2. Use the Resource Adapter Deployment Descriptor Editor to configure your

deployment descriptor.

3. Implement the code to correctly interface with your enterprise information

system (EIS).

4. Export the resource adapter as a resource adapter archive (RAR) or enterprise

application archive (EAR) file.

The purpose of this documentation

Adapter development requires a great deal of software engineering, which varies

from customer to customer. The process of integrating adapter functionality into

your business processes will require you to design, build and test the solution that

utilizes the adapter. The purpose of the WebSphere Adapter Toolkit documentation

is to lay out the requirements of the architecture and provide guidance on how

and when to implement the various facets of it, so that you can apply your

engineering discipline to the adapter-specific requirements, capabilities and

architecture.

IBM WebSphere Adapter Toolkit technology overviews

The IBM WebSphere Adapter Toolkit helps developers implement the Adapter

Foundation Classes, which establish a WebSphere Adapter standard for building

resource adapters that conform to the Java 2 Connector Architecture (JCA) 1.5

specification.

IBM WebSphere Adapters

An IBM WebSphere Adapter implements the Java 2 Enterprise Edition (J2EE)

Connector architecture (JCA), version 1.5. Also known as resource adapters or JCA

adapters, WebSphere Adapters enable managed, bidirectional connectivity between

enterprise information systems (EIS) and J2EE components supported by multiple

server runtime environments, including WebSphere Process Server and WebSphere

Application Server.

IBM WebSphere adapters support outbound request processing and inbound event

processing.

Note: IBM WebSphere adapters support outbound and inbound processing for

WebSphere Process Server and outbound processing only for WebSphere Application

Server.

Outbound processing refers to a process in which request data flows from a client

application to the EIS. In an outbound processing scenario, the adapter acts as the

connector between the application component and the EIS. The adapter provides a

set of standard operations, which process either after-image or delta style business

objects. An outbound request can read data from or write data to the EIS.

Inbound event processing refers to a process that is initiated by an event on the

EIS. In inbound event processing the adapter converts events generated from the

EIS into business objects and sends the business object to the client application.

2WebSphere Adapters: WebSphere Adapter Toolkit User Guide

Inbound event notification complements outbound request processing, enabling

adapters to provide bidirectional communication between business processes and

EIS applications.

The IBM WebSphere Adapter portfolio of adapters is based on the Java 2 Platform,

Enterprise Edition (J2EE) standard. JCA is a standard architecture for integrating

J2EE applications with enterprise information systems. Each of these systems

provides native APIs for identifying a function to call, specifying its input data,

and processing its output data. The goal of the JCA standard is to provide an

independent API for coding these functions, to facilitate data sharing, and to

integrate J2EE applications with existing and other enterprise information systems.

The JCA standard accomplishes this by defining a series of contracts that govern

interactions between an EIS and J2EE components within an application server.

Fully compliant with the JCA standard, WebSphere Adapters have been developed

to run on multiple server runtimes. A WebSphere Adapter does the following:

vIntegrates with multiple server runtimes, including WebSphere Process Server,

WebSphere Enterprise Service Bus, and WebSphere Application Server.

vConnects an application running on WebSphere Process Server with an EIS.

vEnables data exchange between the application and the EIS.

Each WebSphere Adapter is made up of the following:

vAn implementation of the (J2EE) Connector Architecture (JCA), version 1.5,

which supports WebSphere Process Server and WebSphere Application Server.

vAn enterprise metadata discovery component.

You use this component with the external service discovery wizard to introspect

the EIS to discover and generate business objects and other service component

architecture (SCA) artifacts that are compiled in a standard enterprise

application archive (EAR) file. You can also use the external service discovery

wizard to build a service (rather than discover a service). For example, you can

use the enterprise service discovery wizard to build services (based on search

criteria you provide), and generate business objects and interfaces.

The enterprise metadata discovery component implements version 1.1 of the

enterprise metadata discovery specification.

Files

WebSphere Process Server Enterprise information

system

Business

function

WebSphere

Adapter

J2E component

Figure 1. A WebSphere Adapter

WebSphere Adapter development overview 3

WebSphere adapters utilize a format-independent data model for representing data

objects. In a WebSphere Process Server or WebSphere Enterprise Service Bus

runtime environment, WebSphere adapters use an extension of the service data

objects (SDO) for representing data objects.

Architectural overview

In conjunction with the appropriate EIS-specific subclasses, the WebSphere Adapter

Foundation Classes provide a JCA-compliant resource adapter implementation that

can be managed by the application server to enable bidirectional connectivity to an

enterprise information system (EIS).

Outbound requests, those requests intended for the EIS, can be sent to the resource

adapter by any J2EE component via the Common Client Interface (CCI) defined by

the JCA specification. For inbound events, events within the EIS sent to the

adapter, message-driven beans that implement the InboundListener interface are

registered with the adapter by the application-server enabling them to receive any

appropriate inbound events from the EIS via the adapter.

Regardless of the whether data is intended for inbound or outbound delivery, the

resource adapter (i.e. Adapter Foundation Classes plus EIS-specific subclasses) acts

as a conduit for any J2EE application to communicate with the EIS.

Runtime architecture component model

The adapter runtime architecture is a collection of components interacting through

well-defined interfaces and based on the J2EE Connector Architecture (JCA)

specification version 1.5.

At run time, the adapters implement both the Data Exchange Service Provider

Interface (DESPI) contracts to interact with the runtime container and the CCI

contracts to interact with the application component. The JCA architecture has been

extended with the data exchange component that allows efficient data exchange

between the adapter and the server runtime and supports multiple runtime

environments.

The layered approach provides a set of elements that can be assembled to provide

desired functionality and quality of service. The componentized approach allows

the separate, independent development of each element, as well as their reuse. The

following illustration presents the runtime architecture component model. The

Figure 2. Architecture overview

4WebSphere Adapters: WebSphere Adapter Toolkit User Guide

Este manual sirve para los siguientes modelos

Tabla de contenidos

Otros manuales de Software de IBM

IBM

IBM Voluntary Community Assistance Network V-CAN Manual de usuario

IBM

IBM E16RMLL-I - Tivoli Storage Manager Manual de usuario

IBM

IBM PERFORMANCE MANAGEMENT FOR POWER SYSTEMS - GRAPH REFERENCE... Manual de servicio

IBM

IBM Hub/Switch Manual de usuario

IBM

IBM SPSS Data Collection Manual de usuario

IBM

IBM LOTUS NOTES MAIL RELEASE 6 Manual de usuario

IBM

IBM PERFORMANCE MANAGEMENT FOR POWER SYSTEMS - INTERACTIVE GRAPHING SUPPORT FOR ... Manual de usuario

IBM

IBM TransNote Manual de usuario

IBM

IBM RELEASE 7.3 Manual de programación

IBM

IBM TIVOLI SC32-0129-00 Manual de usuario

IBM

IBM System Storage DS3000 Manual de usuario

IBM

IBM High Performance Storage System HPSS Manual de usuario

IBM

IBM Nways 8260 Manual de usuario

IBM

IBM E027SLL-H - Tivoli Monitoring - PC Manual de usuario

IBM

IBM NETCOOL 4.3-W Manual de usuario

IBM

IBM I VIRTUALIZATION - READ ME FIRST 7-9-2010 Manual de usuario

IBM

IBM ZVSE ROADMAP Manual de usuario

IBM

IBM Professional Series Manual de usuario

IBM

IBM Keyboard Optimizer Manual de usuario

IBM

IBM ZVSE PARALLEL ACCESS Manual de usuario

IBM

IBM PERFORMANCE MANAGEMENT FOR POWER SYSTEMS Manual de usuario

IBM

IBM Terminal Emulation TN5250 Manual de usuario

IBM

IBM TIVOLI ADSTAR 5697-VM3 Manual de usuario

IBM

IBM TIVOLI SC23-8765-00 Manual de usuario

Manuales populares de Software de otras marcas

COMPRO

COMPRO COMPROFM Manual de usuario

Muratec

Muratec OFFICEBRIDGE ONLINE Manual de usuario

Oracle

Oracle Contact Center Anywhere 8.1 Manual de usuario

Adobe

Adobe 65007312 - Photoshop Lightroom Manual

Avaya

Avaya NULL One-X for RIM Blackberry Manual de usuario

HP ProLiant BL420c Manual de usuario

PS Audio

PS Audio PowerPlay Manual del propietario

Brady

Brady LOCKOUT PRO 3.0 Manual de servicio

Avaya

Avaya Interaction Center Manual de usuario

Texas Instruments

Texas Instruments TI-83 Plus Silver Edition Manual

Novell

Novell GROUPWISE 8 - INTERNET AGENT Manual de usuario

Oracle

Oracle Application 9i Manual de usuario

Acer

Acer RDM Manual de usuario

Canon

Canon Vixia HF21 Manual de usuario

Canon

Canon ZR950 Manual de usuario

Samsung

Samsung Auto Backup Manual de usuario

Polycom

Polycom Vortex EF2201 Instrucciones de instalación y funcionamiento

Brocade Communications Systems

Brocade Communications Systems Brocade 8/12c Manual de usuario