3.1 Understanding the JCA Adapter Wizard Framework and Overview

The JcaAdapterWizard extension allows you to add the initial wizard pages. You can add additional wizard pages at any later time. For example, most adapter wizards add their pages after the operation type (inbound/outbound) is selected. If the user changes his mind and selects a different operation type, the wizard pages are removed and new ones added.

Each wizard page collects user input. In addition, an adapter-specific context can be registered to enable sharing information between wizard pages.

When the user selects the Finish button, the framework invokes the buildDataModel() method on each wizard page in the same order that the pages were displayed. The buildDataModel() on each page is responsible for copying its screen data to the data model.

The Framework creates artifacts from the data model. Adapters can also register an interface to be invoked before or after the framework's finish processing.

Note:

The Adapter framework handles all WSDL generation. The (old) buildWsdl() method is still invoked for each wizard page, but most wizard pages should not override this method and leave the WSDL processing to the super class.

The following table describes, and the diagram shows the different classes that makes up the Custom Adapter. A Class Diagram follows.

Table 3-1 Custom Adapter Classes Class Description SOA Diagram The graphical editor for the composite.xml. SCA Endpoint Provides a proxy between the SOA diagram and the Adapter framework. JcaAdapterWizard Allows you to add initial Wizard pages. CustomAdapterWizard Extends JcaAdapterWizard to enable overriding public methods JcaServiceName Page Provides the Service Name page. CustomConnectionPage Creates a page that will prompt for the connection-factory location and puts this information into the data model. CustomWSDLSelectionPage Provides the user the option to select a existing WSDL, portType, and operation rather than generating a default WSDL CustomOperationPage Add and remove wizard pages depending on the operation chosen. CustomPropertyPage Enables the user to set activation and interaction spec properties.

Figure 3-1 Custom Adapter Class Diagram

Description of "Figure 3-1 Custom Adapter Class Diagram"

Once you understand the basics, you can proceed to understand the implementation details:

• Implementing the SCA Endpoint Interface

• Extending the JCA Adapter Wizard Class and Implementing its Abstract Methods.

• Implementing Custom Adapter Wizard Pages

• Implementing the JcaDataInterface

• Using Framework Pages for Common Functionality

• Extending the ConnectionPage

• Extending the WsdlSelectionPage

• Extending the JcaOperationPage

• Using and/or Extending CustomAdapterConfig Class

• Extending CommonAdapterSchemaPage or CommonAdapterInOutSchemaPage

• Adding a Finish Page

• Performing Post Finish Handling (Optional)

• Adding an AdapterType Element to sca-config.xml

• Using Public Utility Methods