HTTP-Aktivität 'Anforderung empfangen'

Verwenden Sie die HTTP-Aktivität Anforderung empfangen, um die Integrationseinheit (Integration Appliance) so zu konfigurieren, dass sie als HTTP-Listener fungiert.

In der folgenden Abbildung sehen Sie, wie die Integrationseinheit (Integration Appliance) als HTTP-Listener fungiert.
Abbildung 1.
Die HTTP-Aktivität Anforderung empfangen ist eine Startaktivität. Wenn eine Orchestrierung, die mit einer HTTP-Aktivität Anforderung empfangen beginnt, in die Integrationseinheit (Integration Appliance) implementiert wird, fungiert die Integrationseinheit als HTTP-Listener, der auf HTTP-Anforderungen wartet. Wird eine HTTP-Anforderung empfangen, kommt es zu den folgenden Aktionen:
  1. Ein Orchestrierungsjob wird gestartet.
  2. Die HTTP-Aktivität Anforderung empfangen verarbeitet die eingehende HTTP-Anforderung und ordnet die HTTP-Anforderung den Ausgabeparametern der Aktivität zu.
  3. Die Ausgabeparameter werden den angegebenen Orchestrierungsvariablen zugeordnet. Die Zuordnung zwischen den Ausgabeparametern und den Orchestrierungsvariablen wird bei der Entwicklung in der Task Ausgaben zuordnen der Prüfliste definiert.
  4. Die in der Orchestrierung verbliebenen Aktivitäten werden verarbeitet. (In der grafischen Darstellung der Orchestrierung handelt es sich bei den verbliebenen Aktivitäten um die Aktivitäten auf der rechten Seite der HTTP-Aktivität Anforderung empfangen).
Die Dekomprimierung ist für die HTTP-Aktivität Anforderung empfangen standardmäßig aktiviert. Weitere Informationen finden Sie in Dekomprimierung mit der HTTP-Aktivität 'Anforderung empfangen'.

Sie können nicht zwei HTTP-Aktivitäten 'Anforderung empfangen' mit denselben Endpunktdetails, derselben URL und derselben Methode auf der Einheit implementieren.

Für eine einzelne HTTP-Aktivität 'Anforderung empfangen'

Wenn Sie nur eine HTTP-Aktivität 'Anforderung empfangen' für eine URL implementieren, akzeptiert die Orchestrierung alle Anforderungen von URLs, die mit dieser Basis-URL beginnen. Wenn Sie zum Beispiel /customer implementieren, akzeptiert sie Anforderungen für /customer, /customer/21, /customer/21/dept usw.

Wenn Sie eine HTTP-Aktivität 'Anforderung empfangen' für eine URL mit Pfadparametern implementieren, akzeptiert die Orchestrierung nur die Anforderungen, deren URLs der konfigurierten URL mit Werten für Pfadparameter entsprechen. Wenn Sie zum Beispiel /customer/{custid} implementierten, akzeptiert sie Anforderungen für /customer/10, /customer/21, /customer/dept usw. Die folgenden URLs werden nicht akzeptiert: /customer, /customer/21/dept usw.

Für mehrere HTTP-Aktivitäten 'Anforderung empfangen'

Wenn Sie zwei HTTP-Aktivitäten 'Anforderung empfangen' implementieren, die mit derselben Basis-URL konfiguriert sind, wobei eine mit Pfadparametern konfiguriert ist, akzeptieren die Aktivitäten Anforderungen, deren URLs exakt mit der konfigurierten URL übereinstimmen. Wenn Sie zum Beispiel /customer und /customer/{path parameter} implementieren, und wenn /customer aufgerufen wird, wird die Anforderung an die Aktivität, die mit /customer konfiguriert ist, geleitet. Wenn /customer/007 aufgerufen wird, wird die Anforderung an die Aktivität geleitet, die mit /customer/{path parameter} konfiguriert ist. Wenn Sie hingegen die URLs /customer/dept/1 oder /customer/12/21 aufrufen, werden diese Anforderungen von keiner der Aktivitäten akzeptiert.

Anmerkung: Wenn Sie zwei Aktivitäten implementieren, wobei die erste mit /customer/department und die zweite mit /customer/{path parameter} konfiguriert wird, und dann /customer/department aufgerufen wird, wird die Anforderung an die Aktivität geleitet, die zuerst implementiert wurde (/customer/department). Wenn /customer/{path parameter} zuerst implementiert wird, wird die Anforderung an /customer/{path parameter} geleitet.
Anmerkung: Es wird außerdem empfohlen, nicht dieselbe URL für Web-Services und HTTP zu implementieren.
Basis-URL - Teil der URL vor den Pfadparametern. Beispiel: Wenn die konfigurierte URL /employee/manager/{id} ist, ist /employee/manager die Basis-URL.

HTTP-Aktivität 'Anforderung empfangen' zur Orchestrierung hinzufügen

  1. Erstellen oder öffnen Sie eine Orchestrierung. Eine grafische Darstellung der Orchestrierung wird angezeigt.
  2. Wählen Sie die Registerkarte Aktivitäten aus und erweitern Sie den HTTP-Ordner.
  3. Ziehen Sie die Aktivität Anforderung empfangen auf die Orchestrierung.
  4. Wählen Sie die Aktivität aus. Daraufhin wird die Prüfliste mit der aktiven Task Zusammenfassung im Teilfenster 'Eigenschaften' angezeigt. Das Teilfenster 'Eigenschaften' befindet sich unterhalb der grafischen Darstellung der Orchestrierung im Arbeitsbereich.

HTTP-Endpunkt erstellen, auswählen oder bearbeiten

  1. Klicken Sie auf die Task Endpunkt auswählen in der Prüfliste und wählen Sie eine der folgenden Aktionen aus:
    • Wählen Sie einen vorhandenen Endpunkt aus:
      1. Wählen Sie Durchsuchen aus. Der Projektexplorer wird angezeigt.
      2. Wählen Sie einen vorhandenen Endpunkt aus und klicken Sie auf OK. Fahren Sie mit der Prozedur "Aktivität konfigurieren" fort.
    • Wählen Sie einen vorhandenen Endpunkt aus und bearbeiten Sie den Endpunkt:
      1. Wählen Sie Durchsuchen aus. Der Projektexplorer wird angezeigt.
      2. Wählen Sie einen vorhandenen Endpunkt aus und klicken Sie auf OK.
      3. Klicken Sie auf Bearbeiten. Das Teilfenster 'Endpunkt bearbeiten' wird angezeigt.
    • Erstellen Sie einen neuen Endpunkt: Wählen Sie Neu aus. Das Fenster Endpunkt erstellen wird angezeigt.
  2. Erstellen oder bearbeiten Sie einen HTTP-Endpunkt (siehe HTTP-Endpunkt erstellen oder bearbeiten).

Aktivität konfigurieren

  1. Wählen Sie die Task Konfigurieren in der Prüfliste aus. Das Fenster 'Konfigurieren' wird angezeigt.
  2. Konfigurieren Sie alle Felder und Kontrollkästchen in diesem Fenster, wie in der folgenden Tabelle beschrieben:
    Tabelle 1.
    Feld Beschreibung
    URL (Pfad nach Hostname) Gibt den Ressourcenpfad an, an dem die Integrationseinheit (Integration Appliance) für eingehende HTTP-Anforderungen empfangsbereit ist, z. B. /mypath. Die hier angegebene Zeichenfolge darf die Zeichenfolge http://, den Hostnamen und die Portnummer der Integrationseinheit (Integration Appliance) nicht enthalten. Die vollständige URL, die die Integrationseinheit (Integration Appliance) zum Empfangen von eingehenden HTTP-Anforderungen verwendet, wird automatisch aus dem Hostnamen für die Integrationseinheit (Integration Appliance), der im HTTP-Endpunkt angegebenen Portnummer sowie dem in diesem Feld angegebenen Pfad erstellt. Beispiel: Wenn die vollständige URL, an der die Integrationseinheit (Integration Appliance) für HTTP-Anforderungen empfangsbereit ist, http://myAR:myPort/myPath lautet, müssen Sie in diesem Feld nur die Zeichenfolge /myPath angeben. Der angegebene Pfad muss für die HTTP-Aktivitäten Anforderung empfangen, die zum selben Zeitpunkt auf derselben Integrationseinheit mit demselben Port implementiert werden, eindeutig sein.

    Zur Verwendung der Pfad- und Abfrageparameter geben Sie eine URL im folgenden Format ein: url/{path}?name1=wert1&name2=wert2. Dadurch können Sie dem Parameter "{path}" einen Zeichenfolgewert zuordnen und Abfrageparameternamen angeben. Dies sind in diesem Beispiel name1 und name2. Wenn Sie mehrere Parameter "{path}" deklarieren, wird empfohlen, jeden Parameter mit einem eindeutigen Namen zu versehen. Parameter mit demselben Namen werden in der Zuordnung nur durch einen einzigen Knoten dargestellt. Die Pfadparameter werden in 'Ausgaben zuordnen' unter /httpheaders/pathParameters angezeigt. Abfrageparameter werden unter /httpheaders/queryParameters in 'Ausgaben zuordnen' angezeigt.

    Anmerkung: In der URL wird jeder Wert, der einem Abfrageparameter zugeordnet wird, nicht an den Mapper (Zuordnungsfunktion) übergeben. Der Wert kommt abhängig von der tatsächlich eingehenden Anforderung vom Server.
    Anmerkung: Bei dem Pfad, an dem die Integrationseinheit (Integration Appliance) für eingehende HTTP-Anforderungen empfangsbereit ist, handelt es sich um eine Ressourcenpfadzeichenfolge, die Sie angeben; sie entspricht nicht dem eigentlichen Verzeichnispfad auf der Integrationseinheit (Integration Appliance).
    Methode Gibt an, welche HTTP-Methode vom empfangsbereiten Server akzeptiert wird.
    Mit Typ Gibt den erwarteten Nachrichtentyp der HTTP-Anforderung an - entweder Text oder Binär.
    Antwort erforderlich Gibt an, ob eine Antwort an den Absender der Anforderung gesendet werden soll.
    Anmerkung: Wenn dieses Kontrollkästchen ausgewählt ist, müssen Sie eine HTTP-Aktivität Antwort senden in Ihrer Orchestrierung hinzufügen und konfigurieren.
    Komprimierung/Dekomprimierung verwenden Gibt an, ob die Komprimierung/Dekomprimierung auf der Aktivitätsebene aktiviert oder inaktiviert ist. Standardmäßig ist das Kontrollkästchen Komprimierung/Dekomprimierung verwenden abgewählt und damit die Komprimierung/Dekomprimierung für diese Aktivität inaktiviert. Wählen Sie das Kontrollkästchen Komprimierung/Dekomprimierung verwenden aus, um die Komprimierung/Dekomprimierung für diese Aktivität zu aktivieren. Weitere Informationen finden Sie in Komprimierung/Dekomprimierung mit den HTTP-Aktivitäten 'Anforderung aufrufen', 'Anforderung abrufen', 'Anforderung senden', 'Head-Anforderung', 'Put-Anforderung', 'Anforderung löschen'.

Anforderungsheader angeben

  1. Wählen Sie die Task Anforderungsheader in der Prüfliste aus. Das Teilfenster Anforderungsheader wird angezeigt. Eine Tabelle Angepasste Header wird oben, ein Kontrollkästchen Vordefinierte Standardheader einbeziehen in der Mitte und eine Tabelle Standardheader unten angezeigt.
  2. Klicken Sie auf die Schaltfläche Hinzufügen, um der Tabelle Angepasste Header einen Header hinzuzufügen. Klicken Sie auf den neuen Eintrag, um einen Headernamen einzugeben, oder wählen Sie einen Headernamen in der Dropdown-Liste aus. Wenn der Headername ein vordefinierter Headername ist, wird eine Beschreibung in der Spalte Beschreibung angezeigt. Andernfalls geben Sie eine eigene Beschreibung für Ihre Header ein.
  3. Wählen Sie zur Verwendung der vordefinierten Standardheader das Kontrollkästchen Vordefinierte Standardheader einbeziehen aus. Beachten Sie, dass doppelte Headernamen nicht zulässig sind (Groß-/Kleinschreibung wird nicht unterschieden). Sie werden möglicherweise aufgefordert, alle doppelten Header in der Tabelle Angepasste Header zu entfernen. Die ausgewählten HTTP-Header werden unter /httpheaders im Fenster 'Ausgaben zuordnen' angezeigt.

Swagger-Informationen angeben

  1. Wählen Sie die Task Swagger in der Prüfliste aus, um eine Beispielnachricht festzulegen.
  2. Geben Sie die Informationen für Anforderungsbeispiel (JSON) und Antwortbeispiel (JSON) an. Wenn Sie kein Anforderungsbeispiel angeben, wird die Swagger-Ausgabe mit leeren Beispielobjekten angezeigt.
  3. Klicken Sie auf die Schaltfläche Swagger generieren. Dadurch wird der Code im Textfeld Swagger-Ausgabe angezeigt. Sie können auch auf Swagger herunterladen klicken, um die Datei bei Bedarf herunterzuladen und zur gemeinsamen Nutzung bereitzustellen.

Ausgabe der Aktivität zuordnen

  1. Wählen Sie die Task Ausgaben zuordnen in der Prüfliste aus. Die Ausgabeparameter der Aktivität werden im Teilfenster 'Von Aktivität' der Task Ausgaben zuordnen angezeigt; dies wird in der folgenden Tabelle beschrieben:
    Tabelle 2.
    Ausgabeparameter Beschreibung
    httpheaders Gibt den Header der HTTP-Anforderung an.
    body Gibt den Hauptteil der HTTP-Anforderungsnachricht an.
    In der folgenden Tabelle werden die Knoten des optionalen Ausgabeparameters httpheaders definiert.
    Tabelle 3.
    Knoten des Ausgabeparameters httpheaders Beschreibung
    httpheaders/uri Gibt den Ressourcenpfad der eingehenden Anforderung an, z. B. /myPath.
    httpheaders/method Gibt den Typ der HTTP-Anforderung an.
    httpheaders/host Gibt die IP-Adresse oder den Hostnamen des Clients an.
    httpheaders/otherHeaders/headerItem Gibt ein Element an, das eine Gruppe von HTTP-Headerparametern als Name/Wert-Paare enthält. Es können mehrere HTTP-Headerparameter in der HTTP-Anforderung angegeben werden, sodass dies ein wiederholt auftretender Knoten ist.
    httpheaders/<konfigurierter_headername> Wenn Sie mindestens einen Anforderungsheader im Schritt für Anforderungsheader konfiguriert haben, werden die Anforderungsheader hier angezeigt. Der Wert <konfigurierter_headername> steht für die tatsächlichen Headernamen, die Sie ausgewählt oder eingegeben haben.
    httpheaders/pathParameters Wenn Sie Pfadparameter in der URL im Konfigurationsschritt konfiguriert haben, werden diese hier angezeigt. Wenn kein Pfadparameter angegeben ist, wird dieser Knoten nicht angezeigt.
    httpheaders/queryParameters Wenn Sie Abfrageparameter in der URL im Konfigurationsschritt konfiguriert haben, werden diese hier angezeigt. Wenn kein Abfrageparameter angegeben ist, wird dieser Knoten nicht angezeigt.
    httpheaders/otherHeaders/headerItem/name Gibt den Namen des HTTP-Headerparameters an.
    httpheaders/otherHeaders/headerItem/value Gibt den Wert des HTTP-Headerparameters an.
  2. Erstellen Sie eine Zuordnung zwischen dem bzw. den Ausgabeparameter/n der Aktivität und der bzw. den Orchestrierungsvariablen. Allgemeine Anweisungen zur Zuordnung finden Sie unter Zuordnung erstellen.
    Anmerkung: Wenn Sie Ihre Orchestrierung, die mit der HTTP-Aktivität Anforderung empfangen beginnt, testen möchten, können Sie das HTTP-Dienstprogramm für 'Post' verwenden, das in die Installation von Studio integriert ist; damit können Sie während der Laufzeit HTTP-Anforderungen an die empfangsbereite Integrationseinheit (Integration Appliance) senden. Sie können vom Startmenü auf das HTTP-Dienstprogramm für 'Post' zugreifen, indem Sie die Optionen Programme > IBM > Cast Iron Studio > HTTP-Dienstprogramm für 'Post' auswählen. Bei der von Ihnen im Feld 'URL der eingehenden Connectors' eingegebenen URL muss es sich um die vollständige URL handeln, z. B. http://myAR:myPort/myPath.