About This Document

 

BEA WebLogic Application Integration Adapter Development Guide is organized as follows:

• Introduction to the ADK provides a brief background on the BEA WebLogic Application Integration Adapter Development Kit. It discusses service and event adapters, the design-time GUI, and what to do before you start building an adapter.

• Concepts discusses of some of the ADK concepts relevant to adapter development, including events and services, designtime vs. runtime, logging, and the adapter logical name.

• Tools describes the ADK tools provided that you can use to build adapters. These tools include the sample adapter, the GenerateAdapterTemplate utility, the Ant-based build process, XML tools, and Javadoc.

• Creating a Custom Development Environment shows how to use the GenerateAdapterTemplate utility to clone the sample adapter and customize a development environment for your new adapter.

• The ADK Logging Toolkit describes how to use the ADK logging toolkit to implement logging. It also includes a discussion of the Apache log4j specification, which is the core of the ADK logging framework.

• Developing a Service Adapter shows you how to build an adapter that supports services. It delineates all of the steps required to successfully create the adapter and shows relevant code samples where necessary.

• Developing an Event Adapter shows you how to build an adapter that supports events. It delineates all of the steps required to successfully create the adapter and shows relevant code samples where necessary.

• Developing a Design-Time GUI shows you how to build a graphical user interface that adapter users need to define, deploy, and test their application views. It delineates all of the steps required to successfully create the GUI and shows relevant code samples where necessary.

• Adapter Setup Worksheet is a worksheet that will help you conceptualize the adapter you are building before you actually began to code. It will help you define such components as the adapter logical name and the Java package base name and help you determine the locales for which you need to localize message bundles.

• The DBMS Sample Adapter describes how the ADK was used to build a DBMS adapter. It also contains a simple task-driven example of how to use the DBMS adapter.

• The eMail Sample Adapter describes how the ADK was used to build an eMail adapter. It also contains a simple task-driven example of how to use the eMail adapter.

What You Need to Know

 

The BEA WebLogic Application Integration Adapter Development Guide is designed primarily for use by adapter developers who will use the ADK to develop service adapters, event adapters, and the design-time GUI that adapter users employ to create application views.

e-docs Web Site

BEA product documentation is available on the BEA corporate Web site. From the BEA Home page, click on Product Documentation or go directly to the "e-docs" Product Documentation page at http://e-docs.beasys.com.

How to Print the Document

You can print a copy of this document from a Web browser, one file at a time, by using the File—>Print option on your Web browser.

A PDF version of this document is available on the BEA WebLogic Application Integration documentation Home page on the e-docs Web site (and also on the documentation CD). You can open the PDF in Adobe Acrobat Reader and print the entire document (or a portion of it) in book format. To access the PDFs, open the BEA WebLogic Application Integration documentation Home page, click the PDF files button and select the document you want to print.

If you do not have the Adobe Acrobat Reader, you can get it for free from the Adobe Web site at http://www.adobe.com/.

Related Information

 

The following resources are also available:

• BEA WebLogic Server documentation (http://www.edocs.com)

• BEA WebLogic Process Integrator documentation (http://www.edocs.com)

• XML Schema Specification (http://www.w3.org/TR/xmlschema-l/)

• The Sun Microsystems, Inc. J2EE Connector Architecture Specification (http://java.sun.com/j2ee/connector/)

  Contact Us!

Your feedback on the BEA WebLogic Application Integration documentation is important to us. Send us e-mail at [e-mail] if you have questions or comments. Your comments will be reviewed directly by the BEA professionals who create and update the BEA WebLogic Application Integration documentation.

In your e-mail message, please indicate that you are using the documentation for the BEA WebLogic Application Integration 2.0 release.

If you have any questions about this version of BEA WebLogic Application Integration, or if you have problems installing and running BEA WebLogic Application Integration, contact BEA Customer Support through BEA WebSupport at www.beasys.com. You can also contact Customer Support by using the contact information provided on the Customer Support Card, which is included in the product package.

When contacting Customer Support, be prepared to provide the following information:

• Your name, e-mail address, phone number, and fax number

• Your company name and company address

• Your machine type and authorization codes

• The name and version of the product you are using

• A description of the problem and the content of pertinent error messages

  Documentation Conventions

The following documentation conventions are used throughout this document.

Convention	Item
boldface text	Indicates terms defined in the glossary.
Ctrl+Tab	Indicates that you must press two or more keys simultaneously.
italics	Indicates emphasis or book titles.
monospace text	Indicates code samples, commands and their options, data structures and their members, data types, directories, and file names and their extensions. Monospace text also indicates text that you must enter from the keyboard. Examples: #include <iostream.h> void main ( ) the pointer psz chmod u+w * \tux\data\ap .doc tux.doc BITMAP float
monospace boldface text	Identifies significant words in code. Example: void commit ( )
monospace italic text	Identifies variables in code. Example: String expr
UPPERCASE TEXT	Indicates device names, environment variables, and logical operators. Examples: LPT1 SIGNON OR
{ }	Indicates a set of choices in a syntax line. The braces themselves should never be typed.
[ ]	Indicates optional items in a syntax line. The brackets themselves should never be typed. Example: buildobjclient [-v] [-o name ] [-f file-list]... [-l file-list]...
|	Separates mutually exclusive choices in a syntax line. The symbol itself should never be typed.
...	Indicates one of the following in a command line: That an argument can be repeated several times in a command line That the statement omits additional optional arguments That you can enter additional parameters, values, or other information The ellipsis itself should never be typed. Example: buildobjclient [-v] [-o name ] [-f file-list]... [-l file-list]...
. . .	Indicates the omission of items from a code example or from a syntax line. The vertical ellipsis itself should never be typed.