Tubewarder ist ein zentrales Gateway/Hub für ausgehende Mitteilungen. Es lagert unnötige technische Details von Applikationen, die automatisiert Nachrichten versenden, in ein zentrales System aus. Es beinhaltet Kanäle zum Versenden von E-Mails, SMS und zum Aufruf von Webservices.

1. Tubewarder
ÜBERSICHT| DE | 2016-04-30
WEWEAVE.NET

2. Auf einen Blick
 Ein zentraler Verteiler für ausgehende Mitteilungen
 Designed für Anwendungen, die Nachrichten automatisiert versenden
 Abstrahiert von konkreten Kanälen (E-Mail, SMS, etc.)
 Beinhaltet eine mächtige Template Engine (Apache FreeMarker)
 Kümmert sich um Archivierung, erneute Zustellversuche,
Zugangsmanagement und Fehlerhandling
 Einfach erweiterbar über Java API
 Entrümpelt Ihre Applikationen!

3. Senden Ihre Applikationen über
verschiedene Kanäle?

4. Symptome?
 Kanal-Spezifika in den einzelnen Anwendungen
 Jeder-zu-jeder-Verbindungen (sendende Applikationen zu Kanälen)
 Daher: Doppelter Code
 Höhere Komplexität
 Teurere Wartung
 Anwendungen beschäftigen sich mit Dingen, die nicht zur Hauptaufgabe
gehören

5. Tubewarder räumt auf

6. Architektur
Core
Output Handlers (API
für Erweiterbarkeit)
Scheduler (queue
polling, retrying, etc.)
Send API
(SOAP/REST)
Web Interface
(AngularJS)

7. Systemanforderungen
 Java 1.8 oder neuer
 Empfohlen: Statische IP-Adresse
 Optional: MySQL Datenbank
 Optional: PostgreSQL Datenbank
 Optional: Maven 3 (zum Bauen aus den Quellen)
 Optional: Git (zum Bauen aus den Quellen)

8. Start der Anwendung
Java 8 benötigt. Starten mit:
java -jar tubewarder-swarm.jar

9. Aufruf des Web-Interfaces
Standard-Login:
admin/admin
Standard-Port:
8080

10. App Tokens
 Notwendig für jede Applikation, die die Send API erreichen soll
 Verwendet für eindeutige Identifikation und Zugriffsmanagement

11. Channels
 Channels sind Routen, über die ausgehende Nachrichten mit Hilfe einer
spezifische Output Handler Konfiguration versendet werden
 Beispiele:
 HTML E-Mails via SMTP server des Unternehmens
 SMS via externem Webservice
 Basieren auf Output Handlern, die die eigentliche Arbeit erledigen (z.B. E-
Mail, Webservice, Konsolen-Ausgabe)
 Erweiterbar via Java API

12. Channels

13. Templates
 Templates sind konkrete Mitteilungen, die Sie versenden möchten
 Können Variablen (Platzhalter) und Kontrollstrukturen beinhalten
 Können an einen oder mehrere Channels gebunden werden
 Beispiele:
 Willkommens-Mail per HTML-E-Mail
 Willkommens-Mail per SMS
 Template Engine: Apache FreeMarker

14. Templates

15. Send API
 Das Herz von Tubewarder: Senden Sie Mitteilungen von Applikationen
mittels der generischen API an Tubewarder – sorgen Sie sich nicht um
Kanalspezifika!
 Endpunkte:
 SOAP: /ws/send (WSDL verfügbar unter /ws/send?wsdl)
 REST: /rs/send
 Detaillierte Informationen:
http://tubewarder.readthedocs.io/en/latest/Send-API/

16. Beispiel-Anfrage (REST API)
{
"token": "00000000-0000-0000-0000-000000000000",
"keyword": "DOI",
"details": "",
"echo": true,
"template": "DOI",
"channel": "sms",
"recipient": {
"name": "Unknown",
"address": "+49000000000000"
},
"model": [
{"key": "firstname", "value": "John"},
{"key": "lastname", "value": "Doe"},
{"key": "code", "value": "1234567890"},
{"key": "includeDisclaimer", "value": false}
],
"attachments": [
{
"filename": "Terms.pdf",
"contentType": "application/pdf",
"payload": "..."
}
]
}

17. Beispiel-Antwort (REST API)
{
"error": 0,
"subject": "Hi John, thanks for signing up!",
"content": "Dear John Doe, here's your activation code: 1234567890",
"queueId": "00000000-0000-0000-0000-000000000000"
}

18. Send API Tester
 Das Web-Interface beinhaltet einen Send API Tester, mit dem API-Aufrufe
per Klick zusammengestellt und getestet werden können

19. Was passiert, wenn eine Nachricht
gesendet wird

20. Logs
 Jede Nachricht, die an die Send API übermittelt wird, wird archiviert
 Wichtige Details: Zeitpunkt, Betreff und Inhalt, sendende Applikation,
Empfänger, statistische Informationen (frei definierbarer Schlüsselbegriff
und Details) und weitere
 Oft aus rechtlichen Gründen erforderlich
 Die Logs können per Web-Interface eingesehen und durchsucht werden

21. Hochverfügbarkeit
 Betreiben Sie mehrere Instanzen von Tubewarder hinter einem HTTP-
Loadbalancer, um hohe Verfügbarkeit herzustellen
 Benutzen Sie dabei dieselbe Datenbank in allen Instanzen
 Die Instanzen finden sich automatisch
 Wenn eine Instanz einen Fehler hat, übernehmen die verbleibenden
Instanzen automatisch die zu sendenden Queue-Einträge der fehlerhaften
Instanz

22. Docker Container
 Docker container ist verfügbar unter weweave/tubewarder
 MySQL Datenbank vorinstalliert
 HTTP Interface wird unter Port 8080 veröffentlicht

23. Output Handlers
 API verfügbar zur Entwicklung eigener Output Handler
 Output Handler werden in Java als POJOs entwickelt
 Maven Dependency:
<dependency>
<groupId>net.weweave.tubewarder</groupId>
<artifactId>outputhandler-api</artifactId>
<version>1.0-Beta1</version>
</dependency>
 Siehe das maven repository für die neuste Version
 Deployment: Kompilierte JAR in libs/ Ordner ablegen – wird automatisch
gefunden und geladen

24. Weitere Informationen:
Heiner Peuser | heiner.peuser@weweave.net
weweave.net/products/tubewarder/