Adapter-Framework Modul-Interfaces

Verwendung

Der Modul-Prozessor kontrolliert den Message-Fluss zwischen dem Messaging-Service und dem JCA-Adapter.

Der Prozessor ruft alle im Kanal definierten Module in der vorgegebenen Reihenfolge auf. Das Adapter-Framework enthält einige Module, die in jeder Modul-Kette enthalten sein müssen, beispielsweise das Modul CallSapAdapter für Senderkanäle.

Informationen zu den von SAP ausgelieferten Modulen finden Sie unter: Module

Ein Modul ist eine session ejb, die auch das Adapter-Framework Modul-Interface implementiert. Ein Adapter-Framework Modul sollte stateless sein, also keine Daten persistieren. Bei einem Dateisystem oder einer Datenbank ist keine gemeinsame Transaktion mit der Adapter-Framework Message-Verarbeitung möglich. Es können Inkonsistenzen bei Fehlersituationen auftreten.

Das Adater-Framework enthält das Beispielmodul ConvertCRLFfromToLF .

Weitere Informationen: Beispielmodul aus der Adapterentwicklung

Interface-Überblick

Merkmal	Wert
Name	AF Module Interface
Zweck	Schreiben von adapterspezifischen oder allgemeinen Adapter-Framework Modulen
Typ	Bibliothek in der Fassade com.sap.aii.af.lib.facade
Technischer Name	com.sap.aii.af.lib.mp.module und com.sap.aii.af.lib.mp.processor
Zertifizierung	Optional
Syntax	Javadoc package `com.sap.aii.af.mp.module`

Integration

Der Modul-Prozessor wird für den Message-Fluss in Empfängerrichtung vom Messaging-Service aufgerufen.

Aus Senderrichtung wird er vom Adapter (oder einer Adapter-Enterprise JavaBean) aufgerufen.

Funktionsumfang

Die Hauptaufgabe des Modul-Prozessors ist , Module in der Modulkette in der Reihenfolge aufzurufen, wie sie im Integration Directory/PCK definiert sind. Dabei ist die Ausgabe des Moduls n die Eingabe für Modul n+1.
Weitere Informationen: Module im Modul-Prozessor einfügen
Der Modul-Prozessor versorgt alle Module mit Kontextinformationen, beispielsweise mit der aktuellen ID für den Kommunikationskanal oder dem Zugriff auf Konfigurationsdaten des Moduls.
Die Adapter-Framework-Module sollten zustandslose Message-Operationen implementieren, beispielsweise technische Konvertierungen.
Das Adapter-Framework Modul Application Programming Interface besteht aus folgenden Klassen und Interfaces:

Klassen und Interfaces

Klasse oder Interface	Verwendung
`ModuleProcessorFactory`	Factory, um ein Modul-Prozessor-Objekt zu erzeugen
`ModuleProcessor`	Modul-Prozessor-Instanz zur Übergabe einer Message vom Adapter zum Adapter-Framework im Senderkanal
`ModuleProcessorException`	Ausnahme des Adapter-Framework Module-Prozessors
`Module`	Das Modul-Interface, das vom Modul-Prozessor implementiert wird.
`ModuleData`	Der Daten-Container der die Message (Hauptdaten) und die zusätzlichen Objekte (zusätzliche Daten) zwischen den Modulen transportiert ist nicht typisiert.
`ModuleContext`	Der Modul-Prozessor gibt die Modulkonfiguration an das Modul. Das Modul muss daher nicht das Adapter-Framework Configuration-API verwenden.
`ModuleException`	Ein Module muss eine Modul-Exception ausgeben und sollte Die auslösende Ausnahme unter `cause` speichern.

Hinweis

Eine detaillierte Beschreibung der Klassen und Interfaces finden Sie in der JavaDoc-Dokumentation.

Aktivitäten

Folgende Standardmodule für das Adapter-Framework werden ausgeliefert:

ModuleProcessorExitBean Wenn Sie in Empfängerrichtung das empfohlene Adapter-Framework CCI-Interface verwenden, muss dieses Modul das letzte in der Modulkette sein. Es kennt folgende Parameter: JNDIName , beispielsweise ist deployedAdapters/sample_ra/sharable/sample_ra der JNDI-Name des deployten JCA-Adapters. username , beispielsweise Administrator, technischer Account, der die CCI-Verbindung anfordert. pwd , beispielsweise sap, Kennwort des Account
CallSapAdapter In Senderrichtung muss dieses Modul in der Modulkette aufgerufen werden. Es verwendet keine Konfigurationsparameter.

Beispiel

Mit dem Adapter-Framework wird das Beispielmodul ConvertCRLFfromToLF ausgeliefert. Es zeigt die Bearbeitung von Text-Payloads bei dem Carriage Return Line Feed (CRLF)-Zeilenumbrüche in Line Feed (LF) oder umgekehrt umgewandelt werden.

Dieses Modul wird mit dem Adapter-Framework installiert und kann wie folgt angesprochen werden:

Wählen Sie einen Kommunikationskanal mit der Richtung Empfänger vom Adaptertyp JCA-Beispieladapter.
Wechseln Sie zum Registerblatt Modul und wählen Sie (Zwischen Anzeigen/Bearbeiten umschalten) und fügen Sie eine Zeile in der Verarbeitungssequenz ein.
Machen Sie folgende Angaben:
1. Modulname: SAP XI Sample/ConvertCRLFfromToLF
2. Typ: L
3. Übernehmen Sie den Modulschlüssel oder geben Sie einen selbst gewählten Schlüssel an.
4. Bestätigen Sie die Eingabe mit RETURN.
Fügen Sie in der Modulkonfiguration eine neue Zeile ein und machen Sie dort folgende Angaben:
1. Wählen Sie den Modulschlüssel aus.
2. Parametername: mode
3. Parameterwert: CRLFtoLF
4. Bestätigen Sie die Eingabe mit RETURN.

Das Modul ConvertCRLFfromToLF sollte das erste in der Modulkette im Empfängerkanal sein oder das vorletzte vor CallSAPAdapter im Senderkanal. Der Parameter convert kann folgende Werte haben:

CRLFtoLF: Alle CRLF werden gegen LF ausgetauscht.
LFtoCRLF: Alle LF werden gegen CRLF ausgetauscht.
none: Keine Konvertierung (zu Testzwecken)

Weitere Informationen: Beispieladapter und Beispielmodul