Characteristic

Value

Name

Adapter Framework message interface

Purpose

Processes and manages XI messages.

Type

J2EE service and Java library

Technical Name

com.sap.aii.af.ra.ms.api

Certification

Mandatory

Syntax

See: JavaDoc (.\index.html) package com.sap.aii.af.ra.ms.api

Name

Use

ConnectionFactory

Factory class for the Adapter Framework MessageFactory and Adapter Framework connection

MessageFactory

Used for the sender/inbound direction to create message objects that implement the message interface.

Message

Interface for changing Adapter Framework messages

MessageKey, MessageDirection

Help classes for constructing a unique message key comprising the message ID and the direction

Payload, TextPayload, XMLPayload

Help classes for managing different payload types of messages

Party, Service, Action

Subclasses for managing the address (from/to) of a message. The Action class contains the interface and the interface namespace. They specify the message interface in the Integration Directory.

DeliverySemantics

Describes the quality of service to be used for the message. Possible values are:

●      Best Effort (BE)

●      Exactly Once (EO)

●      Exactly Once In Order (EOIO)

Connection

The connection class is mainly used to generate acknowledgment messages to be sent to the Integration Server.

Exception

Different exception classes to describe error situations

RetryControlException can, for example, be triggered by an adapter implementation to control the retry mode of the Adapter framework messaging system.

If you set RetryModus.STOP_RETRIES in a triggered RetryControlException, the Adapter Framework messaging system will end the attempts to resend a message as if the maximum number of retry attempts had been reached.

It is important that you trigger this exception when the adapter reaches an error situation that requires human intervention.

It is recommended that this also triggers an alert.

More information: Connecting to the Communication Channel Monitor, then under Process Status.

This exception can also be triggered by modules in the module processor to inform sender adapters to end retries. Only adapters for which it is expressly documented react to RetryControlException.