XI Message Interfaces 

Use

You can use XI message interfaces and classes to create, change, or read XI messages or parts of messages.

Interface Overview

Characteristic	Value
Name	Adapter Framework message interface
Purpose	Processes and manages XI messages.
Type	Interface in the facade com.sap.aii.af.ifc.facade
Technical name	com.sap.engine.interfaces.messaging.api, com.sap.engine.interfaces.messaging.api.ack, com.sap.engine.interfaces.messaging.api.exception
Certification	Mandatory
Syntax	JavaDoc Package com.sap.engine.interfaces.messaging.api and Sub-Packages

Features

The following classes and interfaces are available:

●      PublicAPIAccessFactory

Factory for PublicAPIAccess, for simplified access to PublicAPIAccess (hides the JNDI lookup, for example)

●      PublicAPIAccess

Central entry interface and metafactory for generating all sub factories, for example MessageFactory.

●      MessageFactory

To generate your own XI messages, always use MessageFactory.

●      Message

Central interface of the Adapter Framework message

●      MessageKey, MessageDirection, MessageClass

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

MessageClass defines different message classes such as APPLICATION_MESSAGE or APPLICATION_RESPONSE

●      Payload, TextPayload, XMLPayload

Help interfaces for managing different payload types

●      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)

●      ErrorInfo

Help interface for accessing or setting error information in an XI message.

Only used in error messages such as SYSTEM_ERROR or APPLICATION_ERROR.

●      AckType

Help class for determining the acknowledgment type if the message is from the SYSTEM_ACK or APPLICATION_ACK class.

●      Exception

Different exception classes to describe error situations

○       RetryControlException

Can 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.

Let you adapter trigger the 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.

○       MessagingException

The root of the messaging API.

○       InvalidParamException

Triggered when a parameter used is invalid or not supported.

○       PayloadFormatException

Triggered when the message payload format is invalid.

○       DuplicateMessageException

Triggered when the same message is processed twice. Doubled messages are recognized by their message ID. This exception is triggered either when the application attempts to send the same message twice or when the message is received for a second time.

○       MessageFormatException

Triggered when the message format is invalid.

For more information, see the JavaDoc documentation.