Adapter-Framework Modul-Interfaces 

Verwendung

Der Modul-Prozessor kontrolliert den Message-Fluss zwischen dem Messaging-Service und den JCA-Adaptern auf J2EE Enterprise JavaBean-Anwendungsebene.

Interface-Überblick

Merkmal	Wert
Name	AF Module Interface
Zweck	Schreiben von adapterspezifischen oder allgemeinen Adapter-Framework Modulen
Typ	J2EE-Bibliothek und ejb
Technischer Name	com.sap.aii.af.mp.module
Zertifizierung	Optional
Syntax	Siehe JavaDoc (.\index.html) 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 es, die Module in der Modulkette in der Reihenfolge aufzurufen, wie sie im Integration Directory definiert sind. Dabei ist die Ausgabe des Moduls n die Eingabe für Modul n+1. Siehe auch: Modul-Prozessor

Der Modul-Prozessor versorgt alle Module mit Kontextinformationen wie z.B. der aktuellen ID für den Kommunikationskanal oder dem Zugriff auf Konfigurationsdaten des Moduls.

Die Adapter-Framework-Module sollten zustandslose Message-Operationen implementieren, wie z.B. technische Konvertierungen.

Das Adapter-Framework Modul Application Programming Interface besteht aus folgenden Klassen und Interfaces:

Klassen und Interfaces

Klasse oder Interface	Verwendung
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, so dass dieses das Adapter-Framework Configuration-Application Programming Interface nicht verwenden muss.
ModuleException	Ein Modul muss im Fehlerfall eine Modul-Exception ausgeben. ModuleException kann eine Exception enthalten, die die Fehlerursache beschreibt. Um Hinweise bei der Fehlerbeseitigung zu liefern, wird die Fehlerursache in den Trace geschrieben. Um die Message wiederholt zu verarbeiten, müssen Sie keine spezielle Exception setzten. Für Empfänger-Adapter führt der Messaging-Service des Adapter-Framework das wiederholte Verarbeiten durch. Die Bedingungen hierfür werden im Kommunikationskanal-Monitor gesetzt. Für Sender-Adapter muss in der Adapterimplementierung entschieden werden, ob ein wiederholtes Verarbeiten sinnvoll ist.
ModuleLocalHome, ModuleHome, ModuleRemote, ModuleLocal	Standard Enterprise JavaBeans 2.0 Interfaces, die verwendet werden müssen, wenn das Modul als lokales oder remote EJB implementiert wird.
ModuleCategories	Hilfsklasse, um modulspezifische Trace- und Audit-Protokolleinträge zu erzeugen.

Uml_module.wmf enthält das Klassendiagram in UML-Darstellung. Öffnen Sie hierzu Word und importieren Sie uml_module.wmf als Grafik.

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

Aktivitäten

Folgende Standardmodule für das Adapter-Framework werden ausgeliefert. Sie müssen sie alle in der Modul-Kette verwendet:

●      ModuleProcessorExitBean

Wenn Sie in Empfängerrichtung das empfohlene Adapter-Framework CCI-Interface verwenden, dann muss dieses Modul das letzte in der Modulkette sein. Es kennt folgende Parameter:

○       JNDIName, z.B. deployedAdapters/sample_ra/sharable/sample_ra ist der JNDI-Name des deployten JCA-Adapters.

○       username, z.B. Administrator, technischer Account, der die CCI-Verbindung anfordert.

○       pw, z.B. sap, Kennwort des Account

●      CallSapAdapter

In Senderrichtung muss dieses Modul als letztes 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:

...

       1.      Wählen Sie einen Kommunikationskanal mit der Ausprägung Empfänger vom Typ JCA-Beispieladapter auf.

       2.      Wechseln Sie zum Registerblatt Modul und wählen Sie  (Zwischen Anzeigen/Bearbeiten umschalten) und fügen Sie eine Zeile in der Verarbeitungssequenz ein.

       3.      Machen Sie folgende Angaben:

                            a.      Modulname: SAP XI Sample/ConvertCRLFfromToLF

                            b.      Typ: L

                            c.      Übernehmen Sie den Modulschlüssel oder geben Sie einen selbst gewählten Schlüssel an.

                            d.      Bestätigen Sie die Eingabe mit RETURN.

       4.      Fügen Sie in der Modulkonfiguration eine neue Zeile ein und machen Sie dort folgende Angaben:

                            a.      Wählen Sie den Modulschlüssel aus.

                            b.      Parametername: mode

                            c.      Parameterwert: CRLFtoLF

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