IBM BPM, V8.0.1, All platforms > Authoring services in Integration Designer > Services and service-related functions > Access external services with adapters > Configure and using adapters > IBM WebSphere Adapters
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 can create either of the following adapter types:
- A resource adapter based on the interfaces defined by the JCA Resource Adapter 1.5 specification. Choose this path if your goal is to develop a resource adapter that can run either in the unmanaged or managed mode, within any JCA 1.5 compliant container.
- A resource adapter that extends the WebSphere Adapter Foundation Classes library. Select this path if your goal is to create a resource adapter implementation that can run in a managed server run time environment like IBM BPM and when you want a 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 run time 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 to deploy the adapter on run time environments other than IBM BPM.
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 WebSphere Adapter Toolkit.
Using the WebSphere Adapter Toolkit
The development process using IBM WebSphere Adapter Toolkit includes the following as shown in the illustration:
- Run the New JCA Resource Adapter Project wizard.
The wizard generates a resource adapter deployment descriptor and code. The code includes sequence of calls, log and trace messages, and comments.
- Use the Resource Adapter Deployment Descriptor Editor to configure your deployment descriptor.
- Implement the code to correctly interface with your Enterprise Information system (EIS).
- Export the resource adapter as a Resource Adapter Archive (RAR), or Enterprise Application Archive (EAR) file.
The purpose of this documentation
To integrate an adapter development requires some amount of customization, depending on customer requirements. The process of integrating adapter functionality into your business processes requires you to design, build, and test the solution that uses the adapter. WebSphere Adapter Toolkit documentation helps you to understand the architecture requirements, and provide guidance to implement the various facets of the toolkit, for specific requirements.
- IBM WebSphere Adapter Toolkit technology overview
IBM WebSphere Adapter Toolkit helps developers implement the Adapter Foundation Classes, which establish a WebSphere Adapters standard for building resource adapters that conform to the Java™ Platform, Enterprise Edition (JEE) Connector Architecture (JCA) 1.5 specification.- IBM WebSphere Adapter Toolkit overview
WebSphere Adapter Toolkit contains everything you need to create a resource adapter. The adapters are metadata-driven components designed for bidirectional communication with external services on enterprise information systems, such as transaction or ERP systems, as well as bidirectional communication with an email or Flat File.- IBM WebSphere Adapter Toolkit tasks
The tasks range from installing the toolkit, samples, and Adapter Foundation Classes (using the Eclipse Update Manager in Integration Designer) to implementing and validating your code.- IBM WebSphere Adapter Toolkit installation requirements
You can install Adapter Toolkit on Windows or Linux operating systems and work with Integration Designer.
- Samples overview
When install WebSphere Adapter Toolkit, an EIS Simulator sample adapter is placed on your system. This sample serves as a reference to create WebSphere adapters.- Use the New Connector Project wizard
You use the wizard to create a Connector Project which contains a deployment descriptor and classes. The classes either extend the WebSphere Adapter Foundation Classes or implement the JCA 1.5 Interface specification.
- Use the Resource Adapter Deployment Descriptor editor
The Resource Adapter Deployment Descriptor editor provides an easy and convenient way to configure your resource adapter.- Implementing code from the IBM WebSphere Adapter Toolkit
- Validating the code
Validate your adapter implementation by unit testing it outside of a JCA container (unmanaged testing mode). You can then deploy to the target runtime server and test instances of the adapter (managed testing mode).- Packaging and exporting a resource adapter
You can create a Resource Adapter Archive (RAR) file, with the help of JAR files. You must first add the required JAR files to your project workspace.
- Importing a resource adapter
The External Service wizard also gives you an option to import a RAR.- Troubleshooting and support
Common troubleshooting techniques and self-help information help you identify and solve problems quickly.- Reference
- Adapter documentation in PDF format
Documentation in PDF format for WebSphere Adapter Toolkit is available at the following location.