Show TOC

Example Adapter and Example ModuleLocate this document in the navigation structure

Use

You can use the example adapter and example module to develop adapters. You can also use this framework to help you develop your own adapter or module.

Caution

Note the information contained in the disclaimer.

More information: Accessing JavaDoc and Source Text of the Example Adapter/Module

Integration

Overview of the Example Adapter

Characteristic Value

Name

XI AF JCA Sample Adapter

Purpose

Basic structure for developing a new adapter

Type

Source code

Technical name

com.sap.aii.af.sample.adapter.ra

Certification

-

Syntax

JavaDoc package com.sap.aii.af.sample.adapter.ra

Code

.java files in .jar in com.sap.aii.adapter.sample.ra.rar

More information: Accessing JavaDoc and Source Text of the Example Adapter/Module

Deployment

com.sap.aii.adapter.sample.ra.rar in SAPXIAF<PL>_<HF>.sca

Overview of the Example Module

Characteristic Value

Name

XI AF Sample Module

Purpose

Basic structure for developing a new Adapter Framework module

Type

Source code

Technical name

Com.sap.aii.af.sample.module

Certification

-

Syntax

JavaDoc package com.sap.aii.af.sample.module

Code

.java files in .jar in com.sap.aii.adapter.sample.module.app.sda

More information: Accessing JavaDoc and Source Text of the Example Adapter/Module

Deployment

com.sap.aii.adapter.sample.module.app.sda  in SAPXIAF<PL>_<HF>.sca
Activities

To structure the example adapter and the example module, you must include the references to external libraries.

More information: In the deployment descriptor files connector-j2ee-engine.xml in the .rar file and application-j2ee-engine.xml in the .sda file.

  • Only set references to the Adapter Framework API facades.
  • Do not define references to the implementing components.
  • Specify at least the following Adapter Framework API references:

    These apply for adapters and modules.

    • Adapter Framework libraries: com.sap.aii.af.lib.facade
    • Adapter Framework interfaces: com.sap.aii.af.ifc.facade
    • Adapter Framework services: com.sap.aii.af.svc.facade

Specify the following AS Java references:

  • JCA 1.0 Lifecycle Fallback interface:appcontext (only for the adapter)
  • AS Java components, for example, Transaction Manager Service engine.application.facade

The following references are optional: