Message Flow to the Receiver

The graphic below shows the message flow to the receiver, that is, from the Integration Server to the business system.

• If a message is sent from the Integration Server (IS Outbound) to the Adapter Framework, it is received by the Adapter Framework messaging service (AF MS).

  This service is responsible for HTTP/SOAP communication based on the XI message protocol. Firstly the service saves the message received if there is an Exactly Once or Exactly Once in OrderQuality of Service selected.

• Then, using the data in the message header, the service determines the communication channel and calls the module processor (AF MP) with the message and the communication channel ID.

  The message is converted to a Java object that implements the XIMessage interface.

• Depending on the adapter implementation, either the Adapter Framework standard JCA exit bean (ModuleProcessorExitBean) or your Adapter Framework modules (MyModule1, …, MyModuleN) are called. An Adapter Framework module is defined as a stateless session Enterprise JavaBean that implements the Adapter Framework Module interface.
  • In the first case, the ModuleProcessorExitBean determines the JCA resource adapter (JCA RA) using the ModuleProcessorExitBean module configuration of the communication channel used. It calls the JCA resource adapter using CCI and transfers the XI message record (a combination of a CCI record and a Java object that implements the XI message interface).

    More information: Adapter Framework JCA CCI Library

  • In the second case, the first Adapter Framework module (MyModule1) receives the XIMessage object with context and configuration information.
  • The message is processed by the modules. You can convert the XI message object to your own object representation with interfaces or methods you have defined yourself.
  • You must decide in the adapter implementation whether the Adapter Framework CCI interface is to be used to communicate with the JCA resource adapter. Alternatively, you can use your own CCI variant or a non-CCI interface.

    It is advisable to use the first alternative since the JCA resource adapter can then be combined with other modules.

• The last step is controlled by the JCA resource adapter (JCA RA). It extracts the message data from the XIMessage object (or from its own structure if it chooses a different path), maps it to the external protocol, and sends it to the corresponding application. The transactional procedure and the security mechanisms are important here.
• In the case of asynchronous messages, you can request additional acknowledgment messages from the Integration Server. These indicate whether a message has been delivered successfully or not. You can also show whether a message has been processed successfully by the application. If an adapter does not support acknowledgment messages, it must announce this explicitly using a method call.

The following interfaces are important for the exchange of messages in adapter development:

• The XIMessage Java interface for message access and message creation.
• The Adapter Framework module Java interfaces, comprising Module, ModuleContext, ModuleData, and ModuleException.
• The Adapter Framework CCI interface

  More information: Adapter Framework JCA CCI Library

  Note

  To edit the received JCA resource adapter response before it is returned to the Adapter Framework messaging service, you can call the Adapter Framework modules after processing in the JCA resource adapter.