SOAP DECLARATION

Version 2004.3 (Geändert)

SOAP DECLARATION (Variable; Typ; Input_Output{; Alias})

Der Befehl SOAP DECLARATION deklariert explizit den SOAP Typ der Parameter in einer 4D Methode, die als Web Service veröffentlicht wird.

Wird eine Methode als ein Web Service veröffentlicht, werden die Standardparameter $0, $1 ... $n verwendet, um die Parameter des Web Service für die Aussenwelt zu beschreiben, insbesondere in der WSDL Datei. Für das SOAP Protokoll müssen Parameter explizit benannt werden; 4th Dimension verwendet standardmäßig die Namen "FourD_arg0, FourD_arg1 ... FourD_argn".

Diese Standardoperation kann jedoch aus folgenden Gründen problematisch sein:

• Es ist nicht möglich, $0 oder $1, $2, etc. als Array zu deklarieren. Dafür sind Zeiger erforderlich; in diesem Fall muss jedoch zum Erzeugen der WSDL Datei die Art der Werte bekannt sein.

• Als nächstes kann es hilfreich oder notwendig sein, die Parameternamen anzupassen (eingehend und ausgehend).

• Es kann auch notwendig sein, Werte größer als 32 000 Zeichen zurückzugeben (Limit für Textvariablen).

• Schliesslich macht es diese Operation unmöglich, in $0 mehr als einen Wert pro RPC Aufruf zurückzugeben.

Mit dem Befehl SOAP DECLARATION unterliegen Sie nicht diesen Einschränkungen. Sie können diesen Befehl für jeden ein- und ausgehenden Parameter ausführen und ihm einen Namen und einen Typ zuweisen.

Hinweis: Auch bei Verwendung des Befehls SOAP DECLARATION müssen Sie 4D Variablen und Arrays in der Methode "Compiler_Web" immer mit Befehlen aus dem Kapitel "Compiler" deklarieren.

In Variable übergeben Sie die 4D Variable, auf die im RPC Aufruf verwiesen wird.

Achtung: Sie können auf Prozessvariablen oder Parameter in 4D Methoden ($0 to $n) verweisen. Lokale und Interprozessvariablen können Sie nicht verwenden.

Da SOAP nur Texte vom Typ Argument verwenden kann, sind Antworten vom SOAP Server standardmäßig auf 32 KB begrenzt. Über BLOBs können Sie jedoch SOAP Argumente größer als 32 KB zurückgeben. Dazu müssen Sie lediglich vor Aufrufen von SOAP DECLARATION die Argumente als BLOBs deklarieren (siehe Beispiel 4).

Hinweis: Abonnieren Sie auf Client-Seite diese Art von Web Service mit 4th Dimension, generiert der Web Services Assistent eine Variable vom Typ Text. Um sie zu verwenden, müssen Sie lediglich die zurückgegebene Variable in der Proxy-Methode als BLOB typisieren.

In Typ übergeben Sie den entsprechenden 4D Typ. Sie können die meisten Arten von 4D Variablen und Arrays verwenden. Sie können die vordefinierten Konstanten unter dem Thema "Feld- und Variablentypen" einsetzen:

Hinweis: Nachfolgende Konstanten werden in SOAP Methoden nicht verwendet: Is Alpha Field, Is Pointer, Array 2D, Picture array, Pointer array, Is Picture, Is Subtable, Is Undefined.

In Input_Output übergeben Sie einen Wert, der anzeigt, ob der bearbeitete Parameter "eingehend" (z.B. Wert, den eine Methode empfängt) oder "ausgehend" (z.B. Wert, den eine Methode zurückgibt) ist. Sie können die vordefinierten Konstanten unter dem Thema "Web Services (Server)" einsetzen:

COMPILER_WEB Methode: Eingehende SOAP Argumente, die über 4D Variablen, also nicht über Argumente von 4D Methoden aufgerufen werden, müssen Sie zuerst über die Projektmethode "Compiler_Web" deklarieren. Setzen Sie in Methoden für Web Services Prozessvariablen ein, müssen diese deklariert sein, bevor die Methode aufgerufen wird. Die Projektmethode "Compiler_Web" wird – sofern vorhanden – für jede akzeptierte SOAP Anfrage aufgerufen. Die Methode "Compiler_Web" ist standardmäßig nicht vorhanden. Sie müssen diese explizit anlegen.

Der 4D Web Server ruft "Compiler_Web" auch auf, wenn er "konventionelle" Web Anfragen vom Typ POST erhält. Weitere Informationen dazu finden Sie im Abschnitt URLs und Form Actions.

In Alias übergeben Sie den Argumentnamen, wie er in WSDL und SOAP Austauschaktionen erscheinen muss.

Achtung: Dieser Name muss im RPC Aufruf einmalig sein (Eingabe- und Ausgabeparameter zusammengenommen), ansonsten berücksichtigt 4D nur die letzte Deklaration.

Hinweis: Die Namen dürfen in Anlehnung an die XML Standards für Marker-Namen WEDER Leerzeichen NOCH Zeichen aus dem erweiterten ASCII-Satz enthalten. Nur Zeichen des Latin-Satzes sind zulässig ([A-Za-z0-9._] | '-')*.

Übergeben Sie keinen Parameter in Alias, verwendet 4th Dimension standardmäßig den Namen der Variablen oder FourD_argN für die Argumente der 4D Methode ($0 to $n).

Hinweis: Der Befehl SOAP DECLARATION muss innerhalb der Methode liegen, die als Web Service veröffentlicht wird. Er lässt sich nicht über eine andere Methode aufrufen.

(1) Dieses Beispiel gibt den Parameternamen an:

   ` In der Methode COMPILER_WEB
   C_LONGINT($1)

      ` In der Methode Web Service 
      ` Beim Erzeugen der WSDL Datei und SOAP Aufrufe wird das Wort 
      ` PLZ anstelle von fourD_arg1verwendet.
   C_LONGINT($1)
   SOAP DECLARATION($1;Is LongInt;SOAP Input;"PLZ")

(2) Dieses Beispiel findet ein Array mit Postleitzahlen in Form von langen Ganzzahlen:

   ` Setzen Sie in die Methode "Compiler_Web"
   ARRAY LONGINT(codes;0)

   ` In der Service Methode
   SOAP DECLARATION(codes;LongInt array;SOAP Input;"in_codes")

(3) Dieses Beispiel verweist auf zwei zurückgegebene Werte ohne Angabe eines Argumentnamens:

   SOAP DECLARATION(ret1;Is LongInt;SOAP Output)
   SOAP DECLARATION(ret2;Is LongInt;SOAP Output)

(4) Dieses Beispiel ermöglicht dem 4D SOAP Server, ein Argument größer als 32 KB zurückzugeben:

   C_BLOB($0)
   SOAP DECLARATION($0; Is Text; SOAP Output)

Beachten Sie, dass der Typ Is Text und nicht Is BLOB ist. So lässt sich das Argument korrekt bearbeiten.

Get SOAP info, Is data file locked, SEND SOAP FAULT.

Themen Feld und Variablentypen und Web Services (Server)

Anwendung des Befehls

Connecting 4D Databases through SOAP, Returning Pictures Through SOAP, Subscribe to a SOAP based Web Service

---