Example Adapter and Example Module 

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 your own module.

Note the information contained in the disclaimer. See also: 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 text
Technical name	com.sap.aii.af.sample.adapter.ra
Certification	-
Syntax	See: JavaDoc (.\index.html) package com.sap.aii.af.sample.adapter.ra
Code	See directory: File (.\com\sap\aii\af\sample\adapter\ra) For information about access, see Accessing JavaDoc and Source Text of the Example Adapter/Module.
Deployment	See: sample_ra.sda 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 text
Technical name	Com.sap.aii.af.sample.module
Certification	-
Syntax	See: JavaDoc (.\index.html) package com.sap.aii.af.sample.adapter.ra
Code	See directory: \com\sap\aii\af\sample\module. For information about access, see Accessing JavaDoc and Source Text of the Example Adapter/Module.
Deployment	See: sample_module.sda in SAPXIAF<PL>_<HF>.sca

uml_ra.wmf contains the class diagram in UML format. Open Word and import uml_ra.wmf as a graphic.

Activities

To structure the example adapter and the example module, you must include the references to external libraries. See also the deployment descriptor files connector-j2ee-engine.xml in the .rar file and application-j2ee-engine.xml in the .sda file.

●     The external libraries for the example adapter are:

○     J2EE library com.sap.aii.af.lib (*)

○     J2EE library com.sap.aii.messaging.runtime

○     J2EE library com.sap.guid [GUID Generator]

○     J2EE library sapxmltoolkit

○     J2EE library com.sap.xi.util.misc (*)

○     J2EE service com.sap.aii.adapter.xi.svc (*) [SAP XI Adapter: XI]

○     J2EE service com.sap.aii.af.svc (*) [SAP XI AF Core]

○     J2EE service com.sap.aii.af.cpa.svc (*) [SAP XI AF CPA Cache]

○     J2EE interface appcontext (*) [Application Context API]

○     J2EE client libraries in …\usr\sap\J2E\JC00\j2ee\j2eeclient: connector.jar, ejb20.jar, exception.jar, jaas.jar, jta.jar

○     J2EE application com.sap.aii.af.app (*)

The following references are used to access the J2EE keystore:

○     J2EE library security.class

○     J2EE library com.sap.aii.security.lib [SAP XI Security Lib]

Libraries that are required for an Adapter Framework adapter are indicated with a star (*). Libraries that have a different display name, which is shown in the J2EE administration tool overview, are in parentheses [ ].

●     The following are used for the example module:

○     J2EE library com.sap.aii.af.lib (*)

○     J2EE library com.sap.xi.util.misc (*)

○     J2EE service com.sap.aii.adapter.xi.svc (*) [SAP XI Adapter: XI]

○     J2EE service com.sap.aii.af.svc (*)[SAP XI AF Core]

○     J2EE service com.sap.aii.af.cpa.svc (*)[SAP XI AF CPA Cache]

○     J2EE client libraries in …\usr\sap\J2E\JC00\j2ee\j2eeclient: ejb20.jar, exception.jar

The following references are used to access the J2EE keystore:

○     J2EE library security.class

○     J2EE library com.sap.aii.security.lib [SAP XI Security Lib]

Use the SAP J2EE administration tool to determine the libraries that correspond to the J2EE libraries and interfaces named.

com.sap.aii.af.lib uses the following libraries (see the Jars contained box in the J2EE administration tool):

<serverDir>\bin\ext\com.sap.aii.af.lib\aii_af_ms_spi.jar

<serverDir>\bin\ext\com.sap.aii.af.lib\aii_af_cci.jar

<serverDir>\bin\ext\com.sap.aii.af.lib\aii_af_ms_api.jar

<serverDir>\bin\ext\com.sap.aii.af.lib\aii_af_trace.jar

<serverDir>\bin\ext\com.sap.aii.af.lib\aii_af_mp.jar

You must include these libraries as external references in your project in your development environment.

The JAR files of the J2EE services to be referenced are stored directly in <serverDir>\bin\services\<service name>.

 

If you are developing a module for the sender file/FTP adapter and want to access the file name, see SAP Note 819761.