RSS

Archiv für den Monat Dezember 2011

JSON Provider erstellen. Part 3: Axis2 spricht JSON


In diesem letzten Teil geht es darum, Axis2 Services, Antworten in JSON schicken zu lassen.

In Teil 1 ging es darum „Apache Tomcat zu installieren„, in Teil 2 ging es darum „Axis2 auf Tomcat zu installieren„. In diesem dritten Teil geht es nur noch darum die Antworten von Axis2 Services nicht mehr in XML, sondern auch in JSON zu liefern.

Alles was ich im Folgenden beschreibe geht letztendlich auf den Artikel „Building a JSON web service with Java and Axis2“ von Markus Schiesser zurück. Im Wesentlichen geht es um einen Bug in Axis2, bei der Nutzung der Jettison API, um JSON Nachrichten zu parsen. In einem weiteren Artikel „JSON web service with Java and Axis2„, von DJaka PM, wird die Beschreibung von Markus Schiesser nochmals vereinfacht und soll im Folgenden veranschaulicht werden.

  1. Laden Sie sich die modifizierte WAR Datei hier oder hier herunter.
  2. Sichern Sie Ihre Inhalte in Axis2, diese werden überschrieben !
  3. Installieren Sie die neue WAR Datei in Axis2:
    sudo cp <Download Verzeichnis>/axis2.war ./webapps/

    Warten Sie einen Augenblick

  4. Stellen Sie sicher, daß Tomcat gestartet ist und rufen Sie folgenden Link auf:
    http://localhost:8080/axis2/services/Version/getVersion?response=application/json

    Es müsste folgende Antwort in Ihrem Web-Browser erscheinen:

  5. Wollen Sie die herkömmliche XML-formatierte Antwort, dann rufen Sie einfach folgenden Link auf:
    http://localhost:8080/axis2/services/Version/getVersion

    Es müsste folgende Antwort in Ihrem Web-Browser erscheinen:

Je nach URL, erhalten Sie also eine JSON- oder XML-formatierte Antwort des WebServices.

 
Hinterlasse einen Kommentar

Verfasst von - Dezember 31, 2011 in WebServices

 

Schlagwörter: , , ,

JSON Provider erstellen. Part 2: Axis2 auf Tomcat installieren

JSON Provider erstellen. Part 2: Axis2 auf Tomcat installieren

Nachdem im ersten Teil der Tomcat Server zum Laufen gebracht wurde, geht es hier darum, Axis2 auf dem Tomcat Server zu installieren.

Apache Axis2™ ist eine Web Services/SOAP/WSDL Engine, die es auf relative einfache Weise erlaubt Webservices bereitzustellen. Eine Möglichkeit besteht darin sog. POJOs (Plain Old Java Objects), also mehr oder weniger einfache Java-Klassen zu definieren und diese mit Axis2 in einen Web-Service zu „transformieren“. Eine genauere Beschreibung ist hier zu finden.

Man kann Axis2 als Standalone Server, oder auf einem Servlet Container (z.B. Tomcat) bzw. einem vollständigen JEE Server (Applikationsserver wie JBoss etc.) betreiben.

Installation (Tomcat)

1) Download und Entpacken von http://axis.apache.org/axis2/java/core/download.cgi

2) Im entpackten Verzeichnis nach „webapp“ wechseln

3) Zusammenbauen der WAR Datei:

/opt/axis2-1.6.1/webapp$ ant
Buildfile: /opt/axis2-1.6.1/webapp/build.xml

init:
...
prepare.repo:
...
create.war:
      [war] Building war: /opt/axis2-1.6.1/dist/axis2.war
   [delete] Deleting directory /opt/axis2-1.6.1/dist/temp

BUILD SUCCESSFUL
Total time: 3 seconds

4) Kopieren der WAR Datei in das Verzeichnis „webapps“ des Servlet-Containers:

/opt/apache-tomcat-6.0.35$ sudo cp /opt/axis2-1.6.1/dist/axis2.war ./webapps/

5) Durch das Kopieren in den „webapps“  Folder, wird die Datei (bei laufendem Tomcat) automatisch deployed. Man kann das, nach kurzer Zeit, im Log File (/opt/apache-tomcat-6.0.35/logs$ sudo tail -50 catalina.out), in der Manager Applikation (http://localhost:8080/manager/html) und durch Aufrufen der URL (localhost:8080/axis2) sehen.

Bei Problemen kann im Log File bzw. im Manager überprüft werden, ob die Web-Applikation auch gestartet wurde!

Axis2 Admin Konsole

Für Axis2 gibt es eine Admin-Konsole mit dem Default-Account „admin“/“axis2“ unter http://localhost:8080/axis2/axis2-admin/login.

Sie können den Benutzernamen und das Kennwort in der Datei „axis2.xml“ nach Bedarf ändern.

WebServices erstellen:

Axis2 bietet mehrere Möglichkeiten WebServices zu erstellen:

– über JAX-WS, siehe auch Apache Axis2 – JAX-WS Guide

– über sog. POJOs, siehe auch POJO Web Services using Apache Axis2

– aus einem vorhandenen WSDL Dokument

– etc.

Im Folgenden beziehe ich  mich auf die Nutzung sog. POJOs.

Axis2 WebService mit POJOs

Mit Axis2 kann man durch eine sog. Service-Klasse einen WebService in Java programmieren. Zudem ist es möglich über diesen WebService JavaBeans anzusprechen (nicht mit EJBs – Enterprise Java Beans zu verwechseln). Die Verwendung von JavaBeans ermöglicht eine Modularisierung des Web-Applikation.

Service Klasse und services.xml

Die Erstellung eines Axis2 WebServices mit POJOs (ohne JavaBeans) lässt sich relativ schnell erledigen. Sie erstellen eine Service-Klasse, in einem beliebigen Projekt-Verzeichnis und anschließend eine services.xml Datei.

Service-Klasse:

package sample;

public class SampleService {

    public String echo(String value) {
        return value;
    }

    public int add(int a, int b) {
        return a + b;
    }

    public void update(int c) {

    }
}

 

services.xml Datei:

<service name="SampleService">
 <description>This is my Sample Service</description>
    <messageReceivers>
        <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-only"
                         class="org.apache.axis2.rpc.receivers.RPCInOnlyMessageReceiver"/>
        <messageReceiver mep="http://www.w3.org/2004/08/wsdl/in-out"
                         class="org.apache.axis2.rpc.receivers.RPCMessageReceiver"/>
    </messageReceivers>
    <parameter name="ServiceClass">sample.SampleService</parameter>
</service>

 

Verwendung von Eclipse als IDE

Ich  habe in Eclipse ein Projekt „SampleService“ angelegt und die Klasse „SampleService“ im Paket „sample“ unter „src“ angelegt. Außerdem habe in „src“ ein Verzeichnis „META-INF“ erstellt und darin die Datei „services.xml“ abgelegt:

Anschließend habe ich die Datei „build.xml“ aus „Axis2_HOME/samples/pojoguide“ in das Projektverzeichnis kopiert und angepasst: build.xml

Führt man nun build.xml mit ant aus, wird eine aar Datei (Tomcat Webservice Paket) erstellt, die man nun auf Axis2 im Tomcat deployen kann.

Deployment

Wie bringt man nun den Service auf den Tomcat Server?

  1. Rufen Sie die URL für den Tomcat Server auf, z.B.: http://localhost:8080/
  2. Selektieren Sie Administration > Tomcat Manager
  3. Selektieren Sie unter „Application“ den Pfad „/axis2“
  4. Selektieren Sie den Link „Administration“
  5. Geben Sie Username und Passwort ein (Default: admin/axis2) und drücken Sie den „Login“ Knopf
  6. Wählen Sie den Link: Tools > Upload Service
  7. Wählen Sie „Durchsuchen“ und selektieren Sie das aar File
  8. Drücken Sie den „Upload“ Knopf
  9. Wenn alles glatt gelaufen ist, sehen Sie unter „System Components“ > „Available Services“ den Service „“. (Hinweis: Es kann sein, dass Sie einen Augenblick warten müssen und die Anzeige refreshen müssen, bis der Service sichtbar ist).

Die WSDL des WebServices lautet: „http://localhost:8080/axis2/services/SampleService?wsdl&#8220;.

Testen des WebServices mit SOAP UI

SoapUI ist ein hervorragendes, freies Tool zum Testen von WebServices, sofern man die WSDL zur Verfügung hat. Die Installation geht einfach und schnell von statten. Man legt nach der Installation ein neues Projekt an und wählt die URL der WSDL (http://localhost:8080/axis2/services/SampleService?wsdl). Anschließend kann man die verschiedenen Operationen des WebServices testen. Alternativ kann man sich auch einen sog, RPCClient programmieren und damit den WebService testen (s.u.).

Testen des WebServices mit einem RPC Client

Alternativ zu SoapUI kann man einen sog. RPC Client programmieren und die Funktionalität des WebServices testen (siehe hierzu: Testing the POJO Web Service Using RPCServiceClient).

Erstellen Sie hierzu in Eclipse eine Java-Klasse „SampleServiceRPCClient“ im Paket „sample.rpcclient“:

package sample.rpcclient;
import javax.xml.namespace.QName;

import org.apache.axis2.AxisFault;
import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.rpc.client.RPCServiceClient;

public class SampleServiceRPCClient {
    public static void main(String[] args1) throws AxisFault {

        RPCServiceClient serviceClient = new RPCServiceClient();

        Options options = serviceClient.getOptions();

        EndpointReference targetEPR = new EndpointReference(
                "http://localhost:8080/axis2/services/SampleService");
        options.setTo(targetEPR);

        // Setting the add Operation
        QName opEcho =
            new QName("http://sample", "echo");

        // Setting the parameters for the Operation:
        Object[] opSetSampleServiceArgs = new Object[] { "jkhofmann" };

        Class[] returnTypes = new Class[] { String.class };

        Object[] response = serviceClient.invokeBlocking(opEcho,
        		opSetSampleServiceArgs, returnTypes);

        String result = (String) response[0];

        if (result == null) {
            System.out.println("SampleService didn't initialize!");
            return;
        }        

        // Displaying the result
        System.out.println("Echo : " + result);

    }
}

 

Beachten Sie, dass in diesem Beispiel keine JavaBean als Business-Klasse verwendet wird, vielmehr wird der Service direkt angesprochen. Um eine JavaBean als Business-Klasse dazwischenzuschalten, verfolgen Sie bitte den Artikel „POJO Web Services using Apache Axis2“.

Hinweis: Die Fehlermeldungen in der Eclipse IDE können Sie ignorieren, es handelt sich dabei um fehlende Einträge im Build-Path. Diese werden über das Target „rpc.client.run“ in build.xml automatisch geladen. Wenn Sie also den Client testen wollen, verwenden Sie die Eclipse IDE oder ant mit dem Target „rpc.client.run“, oder ziehen Sie die fehlenden Libraries aus Axis2 in den Build-Path des Eclipse-Projektes.

Das Ergebnis über Eclipse/build.xml mit dem Target „rpc.client.run“ sollte wie folgt aussehen:

rpc.client.run:
     [java] log4j:WARN No appenders could be found for logger (org.apache.axis2.context.AbstractContext).
     [java] log4j:WARN Please initialize the log4j system properly.
     [java] Echo : jkhofmann
BUILD SUCCESSFUL
Total time: 4 seconds

 

Testen des WebServices mit WSDL2Java.sh

Axis2 liefert ein Skript mit, welches die komfortable Erstellung von Services und Clients erlaubt. Es nennt sich „wsdl2java.sh“ und ist im „bin“ Verzeichnis der Axis2-Installation zu findet. Hierzu muss lediglich die WSDL vorhanden sein, über die WSDL-URI kann man sich mit diesem Skript die Client-Anteile generieren lassen.

Die Clients können auf verschiedene Arten generiert werden. Mit der Option „-d“ kann man festlegen, wie die XML-Struktur des Services in Java-Objekte umgesetzt wird – Databinding. Läßt man die Option weg, werden XML-in-out Stubs generiert, ohne Databinding.

Verwendet man Databinding, kann man zwischen folgenden Optionen wählen:

  • Axis2 Databinding Framework (ADB): einfach, aber gewisse Einschränkungen bei XML Schemas
  • XMLBeans: voller Schema-Kompiler, aber etwas komplizierter als ADB
  • JiBX: JiBXist ein komplettes Databinding-Framework

siehe hierzu auch: „Choosing a Client Generation Method„.

Neben der Option für das Databindung (-d) kann man mit „-s“ synchrone bzw. blockierende Clients erzeugen lassen, also Clients die beinem Request auf den Response warten. Eine weitere nützliche Option ist „-p“, mit ihr kann man den Namespace (Package-Pfad) des Clients festlegen. Zu guter Letzt finde ich die Option „-o“ noch nützlich, da man mit ihr ein Zielverzeichnis für den generierten Code festlegen kann.

Im folgenden will ich beispielhaft veranschaulichen, wie man einen Client, ganz ohne Databinding, generiert und ausprogrammiert.

  1. Erstellen eines temporären Verzeichnisses und wechseln in das Verzeichnis
  2. Generieren des Client-Stubs:
    /opt/axis2-1.6.1/bin/wsdl2java.sh -uri http://localhost:8080/axis2/services/SampleService?wsdl -p
    sample.wsdl2java.client -s

    Das Ergebnis:

    juergen@vostrou64:~/loeschen$ ls -lR
    .:
    insgesamt 12
    -rw-rw-r-- 1 juergen juergen 5151 2011-12-29 03:23 build.xml
    drwxrwxr-x 3 juergen juergen 4096 2011-12-29 03:23 src
    ...
    ./src/sample/wsdl2java/client:
    -rw-rw-r-- 1 juergen juergen 132306 2011-12-29 03:23 SampleServiceStub.java 

     

  3. Projekt in Eclipse anlegen bzw. ergänzen um die Klasse
    sample.wsdl2java.client.SampleServiceStub
  4. Inhalt der Klasse vom temporären Verzeichnis in Eclipse kopieren
  5. Build-Path von Eclipse anpassen. Es müssen die entsprechenden JARs aus der Axis2 Installation im lib Verzeichnis hinzugefügt werden.
  6. Client erstellen:
    package sample.wsdl2java.client;
    
    import sample.wsdl2java.client.SampleServiceStub.*;
    
    public class Client {
    
    	/**
    	 * @param args
    	 */
    	public static void main(String[] args) {
            try {
                SampleServiceStub stub =
                    new SampleServiceStub
                    ("http://localhost:8080/axis2/services/SampleService");
    
                // Aufruf der Services:
                echo(stub);
                add(stub);
            } catch(Exception e) {
                e.printStackTrace();
                System.out.println("nnn");
            }	        
    	}
    
        /* Echo Service */
        public static void echo(SampleServiceStub stub){
            try{
                Echo req = new Echo();
                req.setArgs0("Hello World");
                EchoResponse resp = stub.echo(req);
                String response = resp.get_return();
                System.out.println("Response = " + response);
            } catch(Exception e){
                e.printStackTrace();
                System.out.println("nnn");
            }
        }
    	
        /* Add Service */
        public static void add(SampleServiceStub stub){
            try{
                Add req = new Add();
                req.setArgs0(1);
                req.setArgs1(2);
                AddResponse resp = stub.add(req);
                int response = resp.get_return();
                System.out.println("Response = " + response);
            } catch(Exception e){
                e.printStackTrace();
                System.out.println("nnn");
            }
        }
        
    }
  7. Kompilieren und testen.
 
Hinterlasse einen Kommentar

Verfasst von - Dezember 27, 2011 in Linux, WebServices

 

Schlagwörter: , , , , ,

Kurzmitteilung

Ich hatte das Problem, dass soapUI 4.0.1 auf Ubuntu 11.10 nicht startet. Das Problem ist „scheinbar“ behoben, wenn man im soapUI bin Verzeichnis die Datei soapui.sh editiert und die Zeile (125)

JAVA_OPTS="$JAVA_OPTS -Dsoapui.jxbrowser.disable=true" 

auskommentiert.

SOAP UI 4.0.1 auf Ubuntu 11.10/64 startet nicht

 
Ein Kommentar

Verfasst von - Dezember 27, 2011 in Linux, WebServices

 

Schlagwörter:

Kurzmitteilung

„Ubuntu Tweak ist eine Anwendung, die die Konfiguration von Ubuntu für jeden einfacher machen soll. Es bietet viele nützliche Optionen für den Desktop und das System, die die normale Desktopumgebung nicht bietet. Mit seiner Hilfe werden Sie Ubuntu genießen.“ (aus ubuntu-tweak.com)

Hier die Befehle zum Installieren:

sudo add-apt-repository ppa:tualatrix/ppa
sudo apt-get update
sudo apt-get install ubuntu-tweak

Ubuntu 11.10: Ubuntu Tweak 0.6 installieren

 
Hinterlasse einen Kommentar

Verfasst von - Dezember 23, 2011 in Linux

 

Schlagwörter: ,

JSON Provider erstellen. Part 1: Apache Tomcat – Installation auf Ubuntu

JSON Provider erstellen. Part 1: Apache Tomcat – Installation auf Ubuntu

Motivation

Ich befasse mich derzeit mit OData und JSON. Die meisten Beispiele, die man hierzu im Internet findet, sind Microsoft-lastig. Ich will versuchen mit Tomcat und AXIS2 einen JSON Server aufzubauen. AXIS2 soll nicht standalone, sondern auf einem Tomcat Server laufen. Die einzelnen Schritte, die dazu nötig sind, will ich in meinem Blog, in einer mehrteiligen Reihe beschreiben, wobei ich noch nicht weiß, ob das alles so funktioniert, wie ich mir das gedacht habe.

In den ersten Teilen will ich beschreiben, wie die Voraussetzungen erfüllt werden:

  • Installation Tomcat
  • Installation Axis2 auf Tomcat

In den darauf folgenden Teilen geht es darum, JSON als Server auf Axis2 bereitzustellen und von einem Cient zu konsumieren.

Tomcat – Quick Start…

Apache Tomcat ist Servlet Container mit JSP Compiler und einem (eingeschränkten) HTTP Server. Er eignet sich hervorragend, um JSP- und Servlet-Anwendungen zu schreiben und zu testen, aber auch, um beispielsweise AXIS2-Webservices anzubieten. Aufgrund seiner weiten Verbreitung ist der Tomcat Server sehr stabil, zudem ist er schlank und schnell und, meiner Meinung nach, falls man keine EJBs oder Portale etc. entwickeln will, einem „schweren“ Applikationsserver vorzuziehen.

Alles, was ich im Folgenden beschreibe, wurde auf Ubuntu Linux 11.10 ausgeführt.

Installation:

1) Download der Binary Distribution (tar.gz)  von hier

2) Entpacken der Distribution

3) Starten:

juergen@vostrou64:/opt/<strong>apache-tomcat-6.0.35/bin$ sudo ./startup.sh</strong>
Using CATALINA_BASE:   /opt/apache-tomcat-6.0.35
Using CATALINA_HOME:   /opt/apache-tomcat-6.0.35
Using CATALINA_TMPDIR: /opt/apache-tomcat-6.0.35/temp
Using JRE_HOME:        /usr
Using CLASSPATH:       /opt/apache-tomcat-6.0.35/bin/bootstrap.jar

4) Testen:

Mit der URL: http://localhost:8080/ können Sie die Installation überprüfen.

Konfiguration:

Die generelle Konfiguration wird in der Datei conf/server.xml festgelegt. Änderungen werden erst nach einem Neustart wirksam.

juergen@vostrou64:/opt/apach.../conf$ sudo vi server.xml

Im  Abschnitt „Connector“ wird u.a. festgelegt, auf welchem Port der Server läuft:

    &lt;!-- A "Connector" represents an endpoint by which requests are received
         and responses are returned. Documentation at :
         Java HTTP Connector: /docs/config/http.html (blocking &amp; non-blocking)
         Java AJP  Connector: /docs/config/ajp.html
         APR (HTTP/AJP) Connector: /docs/apr.html
         Define a non-SSL HTTP/1.1 Connector on port 8080
    --&gt;
    &lt;Connector <strong>port="8080"</strong> protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" /&gt;
    &lt;!-- A "Connector" using the shared thread pool--&gt;
    &lt;!--
    &lt;Connector executor="tomcatThreadPool"
               <strong>port="8080"</strong> protocol="HTTP/1.1"
               connectionTimeout="20000"
               redirectPort="8443" /&gt;
    --&gt;

Im Abschnitt „GlobalNamingRessources/UserDatabase“ wird festgelegt, wo die Benutzer konfiguriert werden:

  &lt;GlobalNamingResources&gt;
    &lt;!-- Editable user database that can also be used by
         UserDatabaseRealm to authenticate users
    --&gt;
    &lt;Resource name="<strong>UserDatabase</strong>" auth="Container"
              type="org.apache.catalina.UserDatabase"
              description="User database that can be updated and saved"
              factory="org.apache.catalina.users.MemoryUserDatabaseFactory"
              pathname="<strong>conf/tomcat-users.xml</strong>" /&gt;
  &lt;/GlobalNamingResources&gt;

Diese Datei sieht defaultmäßig wiefolgt aus:

<!--
  <role rolename="tomcat"/>
  <role rolename="role1"/>
  <user username="tomcat" password="tomcat" roles="tomcat"/>
  <user username="both" password="tomcat" roles="tomcat,role1"/>
  <user username="role1" password="tomcat" roles="role1"/>
-->

Es gibt Rollen und User mit Username, Password und Rolle. Im Standard sind diese Rollen und Benutzer auskommentiert („<!–“ und „–>“). Die Kommentierung muss entfernt werden, falls man Änderungen vornehmen will!

Der Manager-User ist quasi der Administrator, seit Tomcat 6.0.30 wurde die Managerrolle in vier Teilrollen aufgeteilt:

  • manager-gui – allows access to the HTML GUI and the status pages
  • manager-script – allows access to the text interface and the status pages
  • manager-jmx – allows access to the JMX proxy and the status pages
  • manager-status – allows access to the status pages only

Um nun die Rolle manager-gui dem User tomcat mit dem Passwort s3cret zuzuweisen,  müssen folgende Zeilen zu conf/tomcat-users.xml hinzugefügt werden:

<role rolename="manager-gui"/>
<user username="tomcat" password="s3cret" roles="manager-gui"/>

Zum Aktivieren ist ein Neustart des Tomcat Servers notwendig (shutdown.sh und dann startup.sh)! Anschließend auf http://localhost:8080/ den Link „Tomcat Manager“ (http://localhost:8080/manager/html) aufrufen und den oben konfigurierten User eingeben.

 

 

Deployment:

Auf Tomcat werden sog. Web-Applikation deployed. Seit der Servlet API Specification, Version 2 werden hierfür sog. Web Application Archives (WAR) Dateien verwendet. Die WAR Dateien haben eine festgelegte Verzeichnisstruktur und dienen als „Transportformat“ für das Deployment, also dem Verteilen bzw. Installieren einer Web-Applikation auf einem Server.

Die Verzeichnisstruktur ist wie folgt:

Verzeichnis Inhalt
/ Wurzelverzeichnis, enthält html, jsp, js etc. Dateien
/WEB-INF/web.xml der sog. Web Application Deployment Descriptor, welcher die Servlets etc. der Web-Applikation beschreibt
/WEB-INF/classes Klassendateien (class), aber keine JAR Dateien. Reflektiert die Struktur bei Packages in Form von Unterverzeichnissen
/WEB-INF/lib JAR Dateien

Weitere Informationen sind hier zu finden.

Um WAR-Dateien auf Tomcat zu deployen, kann man sie direkt in das „webapps“ Verzeichnis der Tomcat-Installation kopieren, oder man verwendet die Manager-GUI. Mit der Manager-GUI kann man die WAR-Datei lokal auswählen und deployen:

Falls die deployte Applikation anschließend nicht in der Liste erscheint, sollte man sich die Tomcat Logdateien anschauen.

Eigene Applikationen erstellen

Wie man eigene Applikationen für Tomcat erstellt, wird hier erklärt.

 
Hinterlasse einen Kommentar

Verfasst von - Dezember 22, 2011 in Linux, WebServices

 

Schlagwörter: ,

OData: Antwort in AtomPub, JSON oder XML


Die Rückgabe kann in AtomPub (Atom Publishing Protocol), JSON (JavaScript Object Notation) oder XML (Extensible Markup Langugage) erfolgen.

Atom ist der standardisierte Nachfolger des RSS Formats und nutzt XML als Basis. Es wird genutzt um sog. „Feeds“ zu abonnieren,also elektronische Nachrichten, die mehr oder weniger regelmäßig publiziert werden. Neben den allgemeinen Daten, wie Titel, Link, Autor, enthält die Nachricht ein Element „entry“, in welchem der eigentliche Inhalt abgelegt wird.

Beispiel:

<?xml version="1.0" encoding="utf-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <title>Example Feed</title>
  <link href="http://example.org/"/>
  <updated>2003-12-13T18:30:02Z</updated>
  <author>
    <name>John Doe</name>
  </author>
  <id>urn:uuid:60a76c80-d399-11d9-b93C-0003939e0af6</id>
  <entry>
    <title>Atom-Powered Robots Run Amok</title>
    <link href="http://example.org/2003/12/13/atom03"/>
    <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
    <updated>2003-12-13T18:30:02Z</updated>
    <summary>Some text.</summary>
  </entry>
</feed>

Innerhalb des „entry“ Tags kann es noch das „content“ Tag geben, das jeden beliebigen MIME Typ als Inhalt erlaubt.

Beispiel:

<entry>
    <title>Atom-Powered Robots Run Amok</title>
    <id>urn:uuid:1225c695-cfb8-4ebb-aaaa-80da344efa6a</id>
    <updated>2003-12-13T18:30:02Z</updated>
    <content type="xhtml">
     <div xmlns="http://www.w3.org/1999/xhtml">
        Those robots were <i>crazy</i>! ...
     </div>
    </content>
  </entry>

Während Atom lediglich das Lesen von elektronischen Nachrichten erlaubt, kann AtomPub auch neue Daten bzw. Nachrichten erzeugen, bestehende verändern oder löschen. Die Manipulation der Nachrichten erfolgt über die HTTP Operationen GET, POST, PUT und DELETE.

Die OData Spezifikation erweitert AtomPub um ein Datenmodell, d.h. Datentypen und um die Festlegung, wo die Daten zu finden sind. Diese Festlegung erfolgt in der URL.

Die Antwort kann neben Atom/AtomPub oder XML auch in JSON erfolgen, indem im Request als Accept type to “application/json” angegeben wird.

Beispiel:

{
  "Herausgeber": "Xema",
  "Nummer": "1234-5678-9012-3456",
  "Deckung": 2e+6,
  "Währung": "EURO",
  "Inhaber": {
    "Name": "Mustermann",
    "Vorname": "Max",
    "männlich": true,
    "Hobbys": [ "Reiten", "Golfen", "Lesen" ],
    "Alter": 42,
    "Kinder": [],
    "Partner": null
  }
}

JSON wird oft im Zusammenhang mit AJAX verwendet. Der folgende JavaScript Code zeigt, wie auf einem Client mit  XMLHttpRequest ein Response in JSON Format angefordert werden kann:

var my_JSON_object = {};
var http_request = new XMLHttpRequest();
http_request.open("GET", url, true);
http_request.onreadystatechange = function () {
  var done = 4, ok = 200;
  if (http_request.readyState == done && http_request.status == ok) {
       my_JSON_object = JSON.parse(http_request.responseText);
  }
};
http_request.send(null);

JSON entspricht dem JavaScript Format und ist intuitiv einfacher zu lesen als XML. Durch die Tag-Struktur in XML werden Elemente teilweise erheblich aufgebläht. In JSON können die Daten beliebig verschachtelt werden, beispielsweise ist ein Array von Objekten möglich. Zudem gibt es Datentypen. Als Zeichenkodierung benutzt JSON standardmäßig UTF-8; UTF-16 und UTF-32 sind auch möglich. Der MIME-Typ für JSON Dokumente ist „application/json„.

 

Links:

MSDN

RFC 4287

JSON (Wikipedia, OData.org)

OData Org

REW

 
Hinterlasse einen Kommentar

Verfasst von - Dezember 21, 2011 in Formate

 

Schlagwörter: , , ,

Kurzmitteilung
SAP IdM REST API: Aktualisierte Ausgabe der Doku

SAP Netweaver Identity Management Identity Center REST API

SAP IdM REST API: Aktualisierte Ausgabe der Doku

 
 

Schlagwörter: ,