Show TOC

XI-Message-InterfacesLocate this document in the navigation structure

Verwendung

Sie können die XI-Message-Interfaces und -Klassen dazu verwenden, XI-Messages oder Teile von Messages anzulegen, zu verändert oder zu lesen.

Interface-Überblick

Merkmal Wert

Name

Adapter-Framework Message-Interface

Zweck

Verarbeitet und verwaltet XI-Messages

Typ

Interface in der Fassade com.sap.aii.af.ifc.facade

Technischer Name

com.sap.engine.interfaces.messaging.api, com.sap.engine.interfaces.messaging.api.ack, com.sap.engine.interfaces.messaging.api.exception

Zertifizierung

Zwingend erforderlich

Syntax

JavaDoc Package com.sap.engine.interfaces.messaging.api und Sub-Packages
Funktionsumfang

Folgende Klassen und Interfaces stehen zur Verfügung:

  • PublicAPIAccessFactory

    Factory für PublicAPIAccess, zum vereinfachten Zugriff auf PublicAPIAccess (versteckt beispielsweise den JNDI-Lookup)

  • PublicAPIAccess

    Zentrales Einstiegs-Interface und Meta-Factory zum Erzeugen aller Sub-Factories, beispielsweise der MessageFactory.

  • MessageFactory

    Um eigene XI-Messages zu erzeugen, verwenden Sie immer MessageFactory.

  • Message

    Zentrales Interface der Adapter-Framework-Message

  • MessageKey, MessageDirection, MessageClass

    Hilfsklassen, um einen eindeutigen Message-Schlüssel aufzubauen, der aus der Message-ID und der Richtung besteht.

    MessageClass definiert unterschiedliche Message-Klassen wie APPLICATION_MESSAGE oder APPLICATION_RESPONSE

  • Payload, TextPayload, XMLPayload

    Hilfs-Interfaces, um unterschiedliche Payload-Typen zu verwalten

  • DeliverySemantics

    Beschreibt Quality-of-Service, der bei der Message angewendet werden soll. Gültige Werte sind:

    • Best-Effort (BE)
    • Exactly-Once (EO)
    • Exactly-Once-In-Order (EOIO)
  • ErrorInfo

    Hilfs-Interface, um auf Fehlerinformationen in einer XI-Message zuzugreifen oder um sie zu setzen.

    Wird nur bei Error-Message wie beispielsweise SYSTEM_ERROR oder APPLICATION_ERROR verwendet.

  • AckType

    Hilfsklasse, um den Acknowledgment-Typ zu bestimmen, wenn die Message von der Klasse SYSTEM_ACK oder APPLICATION_ACK ist.

  • Exception

    Unterschiedliche Exception-Klassen, um Fehlersituationen beschreiben zu können.

    • RetryControlException

      Kann von einer Adapterimplementierung ausgelöst werden, um den Retry-Modus des Adapter-Framework Messaging-Systems zu kontrollieren.

      Setzen Sie RetryModus.STOP_RETRIES in einer ausgelösten RetryControlException, wird das Adapter-Framework Messaging-System die Versuche, eine Message noch einmal zu versenden beenden, so, als ob die maximale Anzahl der Versuche erreicht wurde.

      Lassen Sie Ihren Adapter die Exception auslösen, wenn der Adapter auf eine Fehlersituation stößt, die einen manuellen Eingriff erfordert. Es wird empfohlen, dann auch einen Alert auszulösen.

      Weitere Informationen: Anschluss an den Kommunikationskanal-Monitor , dort unter Prozessstatus

      Diese Exception kann auch durch Module im Modul-Prozessor ausgelöst werden, um Senderadaptern mitzuteilen, Wiederholungen zu beenden. Nur Adapter, für die dies ausdrücklich dokumentiert ist, reagieren auf RetryControlException.

    • MessagingException

      Ist die Wurzel-Exception des Messaging API.

    • InvalidParamException

      Wird ausgelöst, wenn ein Parameter, der verwendet wird ungültig ist oder nicht unterstützt wird.

    • PayloadFormatException

      Wird ausgelöst, wenn das Format der Message-Payload ungültig ist.

    • DuplicateMessageException

      Wird ausgelöst, wenn dieselbe Message ein zweimal verarbeitet wird. Doppelte Messages werden anhand der Message-ID erkannt. Diese Exception wird entweder ausgelöst, wenn die Anwendung versucht, dieselbe Message zweimal zu senden oder, wenn die Message ein zweites Mal empfangen wird.

    • MessageFormatException

      Wird ausgelöst, wenn das Format der Message ungültig ist.

      Hinweis

      Weitere Informationen finden Sie in der JavaDoc-Dokumentation.