| Beide Seiten der vorigen RevisionVorhergehende ÜberarbeitungNächste Überarbeitung | Vorhergehende Überarbeitung |
| develop:xmlrpc [d.m.Y H:i] – willuhn | develop:xmlrpc [d.m.Y H:i] (aktuell) – [XML-RPC-Aufrufe im Detail] Link zu neuem Java-Projekt ergänzt, welches Hibiscus-XMLRPC nutzt mathisdt |
|---|
| ==== Java ==== | ==== Java ==== |
| |
| Du benötigst [[http://www.java.com/de/|SUN Java]] in Version 6 (oft auch "1.6" bezeichnet) oder höher. Die Verwendung von Java-Versionen anderer Hersteller (z.Bsp. IBM Java, GNU GCJ/Classpath, OpenJDK, usw.) wird nicht empfohlen, da auf diesen Plattformen keine Tests durchgeführt wurden. | Du benötigst Java 8 oder höher. Lade die aktuelle Version von https://adoptopenjdk.net/ herunter und installiere sie. |
| |
| |
| Folgende Komponenten werden benötigt: | Folgende Komponenten werden benötigt: |
| |
| ^ Name ^ Version ^ Download ^ | ^ Name ^ Download ^ |
| | jameica | 1.10 oder höher | [[http://www.willuhn.de/products/jameica/download.php]] | | | jameica | [[http://www.willuhn.de/products/jameica/download.php]] | |
| | jameica.webadmin | 1.2 oder höher | [[http://www.willuhn.de/products/jameica/download_ext.php]] | | | jameica.webadmin | [[http://www.willuhn.de/products/jameica/download_ext.php]] | |
| | jameica.xmprpc | 1.1 oder höher | [[http://www.willuhn.de/products/jameica/download_ext.php]] | | | jameica.xmlrpc | [[http://www.willuhn.de/products/jameica/download_ext.php]] | |
| | hibiscus | 1.12 oder höher | [[http://www.willuhn.de/products/hibiscus/download.php]] | | | hibiscus | [[http://www.willuhn.de/products/hibiscus/download.php]] | |
| | hibiscus.xmlrpc | 1.2 oder höher | [[http://www.willuhn.de/products/hibiscus/download_ext.php]] | | | hibiscus.xmlrpc | [[http://www.willuhn.de/products/hibiscus/download_ext.php]] | |
| |
| Das Plugin "jameica.webadmin" erweitert Jameica um Webfunktionalität mithilfe eines embedded Webservers ([[http://jetty.mortbay.org/jetty/index.html|Jetty]]). "jameica.xmlrpc" setzt auf diesen Webserver auf und erweitert ihn um XML-RPC-Fähigkeiten. Neben Hibiscus selbst wird nun noch "hibiscus.xmlrpc" benötigt, welches die Hibiscus-Daten via XML-RPC bereitstellt. | Das Plugin "jameica.webadmin" erweitert Jameica um Webfunktionalität mithilfe eines embedded Webservers ([[http://jetty.mortbay.org/jetty/index.html|Jetty]]). "jameica.xmlrpc" setzt auf diesen Webserver auf und erweitert ihn um XML-RPC-Fähigkeiten. Neben Hibiscus selbst wird nun noch "hibiscus.xmlrpc" benötigt, welches die Hibiscus-Daten via XML-RPC bereitstellt. |
| Öffnen den Reiter "XML-RPC". Lediglich die folgenden Services müssen aktiviert werden, um Zugriff via XML-RPC zu erhalten. | Öffnen den Reiter "XML-RPC". Lediglich die folgenden Services müssen aktiviert werden, um Zugriff via XML-RPC zu erhalten. |
| |
| ^ Plugin ^ Service ^ Beschreibung ^ | ^ Plugin ^ Service ^ Beschreibung ^ |
| | hibiscus.xmlrpc | address | Abfragen, Anlegen und Löschen von Adressen im Adressbuch | | | hibiscus.xmlrpc | address | Abfragen, Anlegen und Löschen von Adressen im Adressbuch | |
| | hibiscus.xmlrpc | konto | Zugriff auf die Liste der Konten und Salden | | | hibiscus.xmlrpc | konto | Zugriff auf die Liste der Konten und Salden | |
| | hibiscus.xmlrpc | umsatz | Abfragen der Kontoauszüge | | | hibiscus.xmlrpc | umsatz | Abfragen der Kontoauszüge | |
| | hibiscus.xmlrpc | ueberweisung | Abrufen, Erstellen und Löschen von Überweisungen | | | hibiscus.xmlrpc | sepaueberweisung | Abrufen, Erstellen und Löschen von SEPA-Überweisungen | |
| | hibiscus.xmlrpc | lastschrift | Abrufen, Erstellen und Löschen von Lastschriften | | | hibiscus.xmlrpc | sepalastschrift | Abrufen, Erstellen und Löschen von SEPA-Lastschriften | |
| | hibiscus.xmlrpc | sammelueberweisung | Abrufen, Erstellen und Löschen von Sammel-Überweisungen | | | hibiscus.xmlrpc | sepasammelueberweisung | Abrufen, Erstellen und Löschen von SEPA-Sammel-Überweisungen | |
| | hibiscus.xmlrpc | sammellastschrift | Abrufen, Erstellen und Löschen von Sammel-Lastschriften | | | hibiscus.xmlrpc | sepasammellastschrift | Abrufen, Erstellen und Löschen von SEPA-Sammel-Lastschriften | |
| | hibiscus.xmlrpc | sepaueberweisung | Abrufen, Erstellen und Löschen von SEPA-Überweisungen | | |
| |
| Alternativ können die XML-RPC-Services auch manuell in der Konfigurations-Datei cfg/de.willuhn.jameica.xmlrpc.Plugin.properties (im [[support:backup#benutzerverzeichnis|Benutzerverzeichnis]]) durch Hinzufügen folgender Zeilen aktiviert werden: | Alternativ können die XML-RPC-Services auch manuell in der Konfigurations-Datei cfg/de.willuhn.jameica.xmlrpc.Plugin.properties (im [[support:backup#benutzerverzeichnis|Benutzerverzeichnis]]) durch Hinzufügen folgender Zeilen aktiviert werden: |
| hibiscus.xmlrpc.konto.shared=true | hibiscus.xmlrpc.konto.shared=true |
| hibiscus.xmlrpc.umsatz.shared=true | hibiscus.xmlrpc.umsatz.shared=true |
| hibiscus.xmlrpc.ueberweisung.shared=true | |
| hibiscus.xmlrpc.lastschrift.shared=true | |
| hibiscus.xmlrpc.sammellastschrift.shared=true | |
| hibiscus.xmlrpc.sammelueberweisung.shared=true | |
| hibiscus.xmlrpc.sepaueberweisung.shared=true | hibiscus.xmlrpc.sepaueberweisung.shared=true |
| | hibiscus.xmlrpc.sepalastschrift.shared=true |
| | hibiscus.xmlrpc.sepasammelueberweisung.shared=true |
| | hibiscus.xmlrpc.sepasammellastschrift.shared=true |
| |
| ===== Konfiguration prüfen ===== | ===== Konfiguration prüfen ===== |
| [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.konto | [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.konto |
| [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.umsatz | [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.umsatz |
| [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.ueberweisung | |
| [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.lastschrift | |
| [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sammellastschrift | |
| [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sammelueberweisung | |
| [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sepaueberweisung | [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sepaueberweisung |
| | [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sepalastschrift |
| | [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sepasammelueberweisung |
| | [...Datum/Zeit...][INFO][de.....ServiceNotify.handleMessage] * https://<hostname>:8080/xmlrpc/hibiscus.xmlrpc.sepasammellastschrift |
| |
| |
| * [[develop:xmlrpc:sammelauftrag|Sammel-Überweisungen und -Lastschriften]] | * [[develop:xmlrpc:sammelauftrag|Sammel-Überweisungen und -Lastschriften]] |
| |
| | **Tipp**: Für PHP gibt es unter https://github.com/willuhn/hibiscus.php bereits "gebrauchsfertigen" Code.\\ |
| | **Tipp**: Verschiedene Java-Beispiele finden sich unter https://github.com/mathisdt/optigem-spoonfeeder und http://www.zephyrsoft.org/hibiscus-watcher. |
| ===== Verhalten der Services anpassen ===== | ===== Verhalten der Services anpassen ===== |
| |
| Der XML-RPC-Standard unterstützt eigentlich keinen [[http://de.wikipedia.org/wiki/XML-RPC#Null-Datentyp|NULL-Datentyp]]. Es existiert jedoch eine [[http://ontosys.com/xml-rpc/extensions.php|Protokoll-Erweiterung]], die NULL-Werte in Form des Elementes "<nil/>" bzw. "<ex:nil/>" zulässt. Die [[http://ws.apache.org/xmlrpc/types.html|Apache-Implementierung]] unterstützt dies beispielsweise. Da NULL-/NUL- bzw. NIL-Werte in verschiedenen Programmiersprachen jedoch Probleme verursachen können, kann das Verhalten des Plugins "hibiscus.xmlrpc" mit diesem Parameter beeinflusst werden. | Der XML-RPC-Standard unterstützt eigentlich keinen [[http://de.wikipedia.org/wiki/XML-RPC#Null-Datentyp|NULL-Datentyp]]. Es existiert jedoch eine [[http://ontosys.com/xml-rpc/extensions.php|Protokoll-Erweiterung]], die NULL-Werte in Form des Elementes "<nil/>" bzw. "<ex:nil/>" zulässt. Die [[http://ws.apache.org/xmlrpc/types.html|Apache-Implementierung]] unterstützt dies beispielsweise. Da NULL-/NUL- bzw. NIL-Werte in verschiedenen Programmiersprachen jedoch Probleme verursachen können, kann das Verhalten des Plugins "hibiscus.xmlrpc" mit diesem Parameter beeinflusst werden. |
| |
| Einige Funktionen des Plugins (insb. Funktionen zum Erstellen neuer Adressen oder Aufträge) liefern per Default im Erfolgsfall NULL zurück und im Fehlerfall einen String mit dem Fehlertext. Falls jedoch die ID des erstellten Datensatzes benötigt wird oder die verwendete Programmiersprache auf Client-Seite keine NULL-Werte unterstützt, kann in die o.g. Datei eine Zeile "xmlrpc.supports.null=false" eingetragen werden. Die betreffenden Funktionen ändern dabei ihr Verhalten. Im Erfolgsfall liefern Sie die ID des erstellten/geänderten/gelöschten Datensatzes zurück. Im Fehlerfall werden sie eine Exception (Fault). | Einige Funktionen des Plugins (insb. Funktionen zum Erstellen neuer Adressen oder Aufträge) liefern per Default im Erfolgsfall NULL zurück und im Fehlerfall einen String mit dem Fehlertext. Falls jedoch die ID des erstellten Datensatzes benötigt wird oder die verwendete Programmiersprache auf Client-Seite keine NULL-Werte unterstützt, kann in die o.g. Datei eine Zeile "xmlrpc.supports.null=false" eingetragen werden. Die betreffenden Funktionen ändern dabei ihr Verhalten. Im Erfolgsfall liefern Sie die ID des erstellten/geänderten/gelöschten Datensatzes zurück. Im Fehlerfall werfen sie eine Exception (Fault). |
| |
| ^ Parameter-Wert ^ Verhalten im Erfolgsfall ^ Verhalten im Fehlerfall ^ | ^ Parameter-Wert ^ Verhalten im Erfolgsfall ^ Verhalten im Fehlerfall ^ |
