File: soap.xml.html

package info (click to toggle)
yaz 2.1.18-2
links: PTS
area: main
in suites: etch, etch-m68k
size: 11,988 kB
ctags: 11,045
sloc: xml: 109,719; ansic: 41,566; sh: 10,625; makefile: 1,115; tcl: 380; yacc: 288
file content (350 lines) | stat: -rw-r--r-- 5,979 bytes
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN""http://www.w3.org/TR/html4/loose.dtd">
<HTML
><HEAD
><TITLE
>SOAP Packages</TITLE
><META
NAME="GENERATOR"
CONTENT="Modular DocBook HTML Stylesheet Version 1.79"><LINK
REL="HOME"
TITLE="YAZ User's Guide and Reference"
HREF="yaz.html"><LINK
REL="UP"
TITLE="SOAP and SRW"
HREF="soap.html"><LINK
REL="PREVIOUS"
TITLE="HTTP"
HREF="soap.http.html"><LINK
REL="NEXT"
TITLE="SRW"
HREF="soap.srw.html"><LINK
REL="STYLESHEET"
TYPE="text/css"
HREF="common/style1.css"></HEAD
><BODY
CLASS="sect1"
BGCOLOR="#FFFFFF"
TEXT="#000000"
LINK="#0000FF"
VLINK="#840084"
ALINK="#0000FF"
><DIV
CLASS="NAVHEADER"
><TABLE
SUMMARY="Header navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TH
COLSPAN="3"
ALIGN="center"
>YAZ User's Guide and Reference</TH
></TR
><TR
><TD
WIDTH="10%"
ALIGN="left"
VALIGN="bottom"
><A
HREF="soap.http.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="80%"
ALIGN="center"
VALIGN="bottom"
>Chapter 7. SOAP and SRW</TD
><TD
WIDTH="10%"
ALIGN="right"
VALIGN="bottom"
><A
HREF="soap.srw.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
></TABLE
><HR
ALIGN="LEFT"
WIDTH="100%"></DIV
><DIV
CLASS="sect1"
><H1
CLASS="sect1"
><A
NAME="soap.xml"
>SOAP Packages</A
></H1
><P
>&#13;      Every SOAP package in YAZ is represented as follows:
      <PRE
CLASS="synopsis"
>&#13;#include &#60;yaz/soap.h&#62;

typedef struct {
    char *fault_code;
    char *fault_string;
    char *details;
} Z_SOAP_Fault;

typedef struct {
    int no;
    char *ns;
    void *p;
} Z_SOAP_Generic;

#define Z_SOAP_fault 1
#define Z_SOAP_generic 2
#define Z_SOAP_error 3
typedef struct {
    int which;
    union {
        Z_SOAP_Fault   *fault;
        Z_SOAP_Generic *generic;
        Z_SOAP_Fault   *soap_error;
    } u;
    const char *ns;
} Z_SOAP;
      </PRE
>
    </P
><P
>&#13;      The <TT
CLASS="literal"
>fault</TT
> and <TT
CLASS="literal"
>soap_error</TT
>
      arms represent both a SOAP fault - struct
      <TT
CLASS="literal"
>Z_SOAP_Fault</TT
>. Any other generic
        (valid) package is represented by <TT
CLASS="literal"
>Z_SOAP_Generic</TT
>.
    </P
><P
>&#13;      The <TT
CLASS="literal"
>ns</TT
> as part of <TT
CLASS="literal"
>Z_SOAP</TT
>
      is the namespace for SOAP itself and reflects the SOAP
      version. For version 1.1 it is
      <TT
CLASS="literal"
>http://schemas.xmlsoap.org/soap/envelope/</TT
>,
      for version 1.2 it is
      <TT
CLASS="literal"
>http://www.w3.org/2001/06/soap-envelope</TT
>.
    </P
><PRE
CLASS="synopsis"
>&#13;int z_soap_codec(ODR o, Z_SOAP **pp,
                 char **content_buf, int *content_len,
                 Z_SOAP_Handler *handlers);
    </PRE
><P
>&#13;      The <TT
CLASS="literal"
>content_buf</TT
> and <TT
CLASS="literal"
>content_len</TT
>
      is XML buffer and length of buffer respectively.
    </P
><P
>&#13;      The <TT
CLASS="literal"
>handlers</TT
> is a list of SOAP codec
      handlers - one handler for each service namespace. For SRW, the
      namespace would be <TT
CLASS="literal"
>http://www.loc.gov/zing/srw/v1.0/</TT
>.
    </P
><P
>&#13;      When decoding, the <CODE
CLASS="function"
>z_soap_codec</CODE
>
      inspects the XML content
      and tries to match one of the services namespaces of the
      supplied handlers. If there is a match a handler function
      is invoked which decodes that particular SOAP package.
      If successful, the returned <TT
CLASS="literal"
>Z_SOAP</TT
> package will be
      of type <TT
CLASS="literal"
>Z_SOAP_Generic</TT
>.
      Member <TT
CLASS="literal"
>no</TT
> is
      set the offset of handler that matched; <TT
CLASS="literal"
>ns</TT
>
      is set to namespace of matching handler; the void pointer
      <TT
CLASS="literal"
>p</TT
> is set to the C data structure assocatiated
      with the handler.
    </P
><P
>&#13;      When a NULL namespace is met (member <TT
CLASS="literal"
>ns</TT
> bwlow),
      that specifies end-of-list.
    </P
><P
>&#13;      Each handler is defined as follows:
      <PRE
CLASS="synopsis"
>&#13;typedef struct {
    char *ns;
    void *client_data;
    Z_SOAP_fun f;
} Z_SOAP_Handler;
      </PRE
>
      The <TT
CLASS="literal"
>ns</TT
> is namespace of service associated with
      handler <TT
CLASS="literal"
>f</TT
>. <TT
CLASS="literal"
>client_data</TT
>
      is user-defined data which is passed to handler.
    </P
><P
>&#13;      The prototype for a SOAP service handler is:
      <PRE
CLASS="synopsis"
>&#13;int handler(ODR o, void * ptr, void **handler_data,
            void *client_data, const char *ns);
      </PRE
>
      The <CODE
CLASS="parameter"
>o</CODE
> specifies the mode (decode/encode)
      as usual. The second argument, <CODE
CLASS="parameter"
>ptr</CODE
>,
      is a libxml2 tree node pointer (<TT
CLASS="literal"
>xmlNodePtr</TT
>)
      and is a pointer to the <TT
CLASS="literal"
>Body</TT
> element
      of the SOAP package. The <CODE
CLASS="parameter"
>handler_data</CODE
>
      is an opaque pointer to a C definitions associated with the
      SOAP service. <CODE
CLASS="parameter"
>client_data</CODE
> is the pointer
      which was set as part of the <TT
CLASS="literal"
>Z_SOAP_handler</TT
>.
      Finally, <CODE
CLASS="parameter"
>ns</CODE
> the service namespace.
    </P
></DIV
><DIV
CLASS="NAVFOOTER"
><HR
ALIGN="LEFT"
WIDTH="100%"><TABLE
SUMMARY="Footer navigation table"
WIDTH="100%"
BORDER="0"
CELLPADDING="0"
CELLSPACING="0"
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
><A
HREF="soap.http.html"
ACCESSKEY="P"
>Prev</A
></TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="yaz.html"
ACCESSKEY="H"
>Home</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
><A
HREF="soap.srw.html"
ACCESSKEY="N"
>Next</A
></TD
></TR
><TR
><TD
WIDTH="33%"
ALIGN="left"
VALIGN="top"
>HTTP</TD
><TD
WIDTH="34%"
ALIGN="center"
VALIGN="top"
><A
HREF="soap.html"
ACCESSKEY="U"
>Up</A
></TD
><TD
WIDTH="33%"
ALIGN="right"
VALIGN="top"
>SRW</TD
></TR
></TABLE
></DIV
></BODY
></HTML
>