Accessing Javadoc and Source Text of the Example Adapter/Module 

Use

Javadoc provides syntactical descriptions of the Adapter Framework.

You can use the example adapter and the example module as a starting point for developing your own adapters.

Integration

The Javadoc, example adapter and example module are shipped with the Adapter Framework.

Activities

Copy the JAR file (Java archive) of the example adapter locally to your computer. The JAR file contains the Javadoc and the source text of the example adapter.

·        Copy the file sample_ra.jar from <serverDir>\apps\sap.com\com.sap.aii.af.sample.ra\connector\connectors\sample_ra.rar to a separate directory on your computer.

<serverDir> is C:\usr\sap\J2E\JC00\j2ee\cluster\server0, for example.

·        Extract the JAR file to the same directory.

·        Open index.html to display the Javadoc.

·        The source text for the example adapter is located in a subdirectory com\sap\aii\af\sample\adapter\ra.

The following description refers to the example adapter in many places. The source code of the adapter itself is not part of the description, but the description contains a link to the corresponding place in the source code of the example adapter.

SPIManagedConnectionFactory.java:CS_TXMGR shows how an adapter can access the J2EE Transaction Manager.

To find the relevant place in the source code, open the file SPIManagedConnectionFactory.java in your preferred development environment.

Then, search for CS_TXMGR. The code is located between the comment lines // CS_TXMGR START and // CS_TXMGR END.

·        The UML class diagrams referenced here are also located in the JAR file. They start with uml and are saved in Windows Metafile format. You can import the class diagrams in Word.

Uml_ra.wmf contains the class diagram of the example adapter.

 

·        Proceed in the same way for the example module. It is located under <serverDir>\apps\sap.com\com.sap.aii.af.sample.module\EJBContainer\applicationjars\sample_module.jar. It also contains the source text, whereas the Javadoc is saved centrally in the example adapter.