Dr. Maximillian Dornseif home

Nachrichtenaustausch zwischen Unternehmen

Wie kriegt man eine elektronische Bestellung von Firma A zu Firma B? SOAP? DE-Mail? E-Post? AS/2? Mit nichten! In der Praxis werden Daten ganz überwiegend per FTP transportiert. Ein 40 Jahre altes Protokoll, das Probleme mit so ziemlich allen Netztechniken der letzten 15 Jahre hat: Firewalls: problematisch. NAT: nur mit Hacks. Verschlüsselung: verschiedene, inkompatible Ansätze. Transaktionen: Nur mit Upload-Rename Akrobatik.

Aber: Für fast jedes Betriebssystem gibt es FTP-Server und ein FTP-Client ist eigentlich immer shcon mitgeliefert. Jeder MCP kann FTP bedienen und verstehen. Es spricht also viel für FTP.

In der Praxis spricht allerdings auch viel gegen FTP. Einen robusten FTP Client oder Server zu implementieren ist eine Riesenarbeit. Vorhandene Software lässt sich nicht zuletzt wegen der FTP-eigenen Netzwerksanforderungen schlecht in Applikationsserver integrieren. Und wir haben schon sehr oft unsere Partner angerufen, sie sollten bitte mal ihren WS_FTP Server neu starten.

Was also statt FTP? Das Problem treibt mich schon lange um. Vor fast 2 Jahren hab ich bei Stackoverflow um Rat gefragt aber keine befriedigende Antworten bekommen.

Lange habe ich versucht in Messaging Services, wie dem Amazon Simple Queue Service (Amazon SQS) die Lösung zu sehen. Aber letztendlich fehlt es an Möglichkeiten in die Nachrichtenwartenschlangen hineinzuschauen, es gibt keine Standard-Tools um it dem System zu interagieren und dann bleiben PRobleme, wie dass Nachrichten nach 4 Tagen (ein langes Wochenende) nicht-abholen verschwinden. Auch die beschränkte NAchrichtengrösse in den meissten Messaging-Systemen erfordert Klimmzüge.

Also irgendwas einfaches HTTP-basiertes als Altrnative. Aber was? Eine Nachfrage bei Stackoverlow brachte erneut wenig zu Tage. Also selber definieren. Also selber definieren. Es folgt das

Frugal Message Trasfer Protocol (FMTP)

FMTP dient dem zuverlässigen, Austausch von Nachrichten per HTTP nach REST Prinzipien. Nachrichten können im Push (sendend), oder Pull (empfangend) Modus transportiert werden. Für den Tansfer einer Nachrichtenart vone einem Sender an einem Empfänger wird ein Endpunkt definiert, der mit einer Queue in einer MOM vergleichbar ist. In den Folgenden Beispielen wird der Endpunkt https://example.com/q verwendet. Nachrichten sollten einen eindeutigen Bezeichner haben, der pro Endpunkt nur einmal vorkommen darf. Wenn das sendene System keine GUIDs erzeugen kann, können auch andere eindeutige bezeichner, wie Rechungsnummer etc verwendet werden. GUIDs sollten mit dem Regular Expression /[a-zA-Z0-9_-]+/ matchen.

Daten Senden (Push)

Gesetzt eine Nachricht hat den GUID guid, den Inhalt 'content' und den content-type application/json, dann kann die Nachricht folgendermassen in den Endpunkt https://example.com/q eingespeist:

>>> POST https://example.com/q/guid
>>> Host: example.com
>>> Content-Type: application/json
>>>
>>> 'content'

In der Regel antwortet der Server mit folgenden Nachrichten:

201 Created Die Nachricht wurde auf dem Server gespeichert
409 Conflict Es existiert bereits eine Nachricht mit dem gleichen GUID
410 Gone Es existierte bereits eine Nachricht mit dem gleichen GUID, die aber bereits verarbeitet/gelöscht wurde.

Daten Empfangen (Pull)

Das Protokoll unterstützt kein Locking. Das bedeutet, dass entweder nur ein Client lesend zugreifen darf, oder das Locking auf der Client Seite implementiert werden muss. Der Empfang gliedert sich in in drei Schritte, die in einer Schleife ausgeführt werden.

Abruf einer Liste der bereitstehenden Nachrichten
Abruf einer Nachricht
Löschen der abgerufenen Nachricht

Die Liste der bereitstehenden Nachrichten kann in verschiedenen Formaten empfangen werden. Für FMTP müssen die Formate Text, JSON und XML unterstützt werden. Die folgenden Beispiele nutzen das Text Format. Durch GET Abruf des Endpunktes bekommt der Empfänger eine Liste mit URLs von Nachrichten. Die URLs sind durch ‘\n’ (ASCII 10) voneinander getrennt.

>>> GET https://example.com/q
>>> Host: example.com

<<< 200 OK
<<< Content-Type: text/plain
<<<
<<< https://example.com/q/guid
<<< https://example.com/q/otherguid

Aufgrund der Informationen in dieser Liste kann nun eine Nachricht abgerufen werden.

>>> GET https://example.com/q/guid
>>> Host: example.com

<<< 200 OK
<<< Content-Type: application/json
<<<
<<< 'content'

Der Content-Type ist der gleiche, der von dem Sender mitgegeben wurde. Wenn der Empfänger die Nachricht erfolgreich übernommen hat - z.B. indem er Sie in eine Datenbank geschrieben hat, muss er die Nachricht auf dem Server löschen. Das muss mit dem HTTP Befehl DELETE erfolgen.

>>> DELETE https://example.com/q/guid
>>> Host: example.com

<<< 204 No Content

Nun kann erneut durch Aufruf von https://example.com/q geprüft werden, ob neue Nachrichten vorliegen.

Listenformate

Die Liste der bereitstehenden Nachrichten kann in verschiedenen Formaten abgerufen werden. Welches Format der Server zurückliefert kann anhand des Accept Headers, der vom Client geschickt wird, gesteuert werden. Zum einen steht das JSON Format zur Verfügung:

>>> GET https://example.com/q
>>> Host: example.com
>>> Acceppt: application/json

<<< 200 OK
<<< Content-Type: application/json
<<<
>>> {
>>>  'min_retry_interval': 500,
>>>  'max_retry_interval': 60000,
>>>  'messages': [
>>>   {'url': 'https://example.com/q/guid', 'created_at': '2010-10-13T20:30:40.1234'},
>>>   {'url': 'https://example.com/q/otherguid', 'created_at': '2010-10-13T20:30:50.6789'},
>>>  ]
>>> }

Alternativ kann die Nachrichtenliste als Plain old XML abgerufen werden:

>>> GET https://example.com/q
>>> Host: example.com
>>> Acceppt: application/xml

<<< 200 OK
<<< Content-Type: application/xml
<<<
>>> <data>
>>>  <min_retry_interval>500</min_retry_interval>
>>>  <max_retry_interval>60000</max_retry_interval>
>>>  <messages>
>>>   <message>
>>>    <url>https://example.com/q/guid</url>
>>>    <created_at>2010-10-13T20:30:40.1234</created_at>
>>>   </message>
>>>   <message>
>>>    <url>https://example.com/q/otherguid</url>
>>>    <created_at>2010-10-13T20:30:50.6789</created_at>
>>>   </message>
>>>  </messages>
>>> </data>

Retry-Interval

Ein Empfänger muss immer wieder die Liste der bereitstehenden Nachrichten abrufen. Die frage ist, in welchen Intervallen nach neuen Nachrichten gefragt werden soll. Wird zu häufig gefragt, wird die automatisierte Denial-of-Service Detektion den Client zeitweise sperren und alle Anfragen mit 503 Service Unavailable beantworten.

Deswegen empfiehlt es sich im Client Exponential Backoff zu implementieren. D.h. wenn keine neue Nachrichten gefunden wurden, sollte die Wartezeitbis zur nächsten Anfrage verdoppelt werden. Der Server liefert mit min_retry_interval und max_retry_interval Vorschläge, wie viele Millisekunden der Client minimal und maximal bis zur nächsten Anfrage warten soll.