Overview

An adapter definition is the framework of an adapter. The adapter definition is recognized as an adapter by Integration Server, but lacks functionality. This chapter describes how to create an adapter definition.

Create an adapter definition implementation class by extending the com.wm.adk.WmAdapter base class. The adapter definition implementation class represents the main class of the adapter. In this class, create services and methods that:

Describe the adapter's resources to Integration Server, including its connection factories, notification templates, and its default resource bundle implementation class.

Initialize resources and properties referenced by the adapter definition when the adapter is enabled, and clean up the resources when the adapter is disabled (optional).

Load the adapter onto Integration Server when the adapter is enabled, and unload the adapter when the adapter is disabled.

For more information, see Creating a WmAdapter Implementation Class.

The resource bundle class must extend the java.util.ListResourceBundle base class, and contain all the display strings and messages used by the adapter at run time and at design time. A resource bundle is specific to a particular locale. If you plan to run your adapter in multiple locales, you can include a resource bundle for each locale. Creating a resource bundle for each locale enables you to internationalize an adapter quickly, without having to change any code in the adapter. Each adapter must have one or more resource bundles. For more information, see Creating Resource Bundles.

Compile your implementation class and construct the Java service nodes for your startup and shutdown services. The ADK provides a sample ANT script that you can run from the packages folder.

For more information, see Deploying the adapter.

Finally, the users of the adapter use Integration Server Administrator to load the adapter by enabling the adapter package. For more information, see Package Management.