Updated User Guide
git-svn-id: https://brutex.net/svn/xservices/trunk@160 e7e49efb-446e-492e-b9ec-fcafc1997a86xservices-jre6
Brian Rosenberger
parent
3e3498e50c
commit
ce3aa9d3b4
|
|
@ -4273,6 +4273,144 @@ xmlns:ws="http://ws.xservices.brutex.net">
|
|||
</soap:Body>
|
||||
</soap:Envelope>]]></programlisting>
|
||||
</para>
|
||||
</section>
|
||||
<section version="5.0" xml:base="XmlServices/selectXPath.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>selectXPath</title>
|
||||
<para>Selects xmlfragements, nodes, attribute or text from xml data using an XPath expression.
|
||||
This function requires namespaces to be declared correctly.</para>
|
||||
<para>
|
||||
Sample request:
|
||||
<programlisting language="xml"><![CDATA[
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
|
||||
xmlns:ws="http://ws.xservices.brutex.net">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<ws:selectXPath>
|
||||
<sourcexml>
|
||||
<![CDATA[<notes xmlns="http://demo.brutex.net" xmlns:bx="http://bx.brutex.net">
|
||||
<bx:note>
|
||||
<to>Lena</to>
|
||||
<from>Jani</from>
|
||||
<heading>Reminder ABC</heading>
|
||||
<body>Don't forget me this weekend!</body>
|
||||
</bx:note>
|
||||
<note>
|
||||
<to>John</to>
|
||||
<from>Lena</from>
|
||||
<heading>Call Mr. ABC</heading>
|
||||
<body>Please call back</body>
|
||||
</note>
|
||||
<bx:note>
|
||||
<to>Brian</to>
|
||||
<from>JJohn</from>
|
||||
<heading>Reminder XServices</heading>
|
||||
<body>How to use selectXPath?</body>
|
||||
</bx:note>
|
||||
</notes>
|
||||
]]]]><![CDATA[>
|
||||
</sourcexml>
|
||||
<encoding>utf-8</encoding>
|
||||
<namespaceList>
|
||||
<namespace>
|
||||
<prefix>ns</prefix>
|
||||
<uri>http://demo.brutex.net</uri>
|
||||
</namespace>
|
||||
<namespace>
|
||||
<prefix>bx</prefix>
|
||||
<uri>http://bx.brutex.net</uri>
|
||||
</namespace>
|
||||
</namespaceList>
|
||||
<xpath>*/bx:note/ns:heading/text()</xpath>
|
||||
</ws:selectXPath>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
]]></programlisting>
|
||||
Sample response:
|
||||
<programlisting language="xml"><![CDATA[
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<ns2:selectXPathResponse xmlns:ns2="http://ws.xservices.brutex.net">
|
||||
<return>
|
||||
<stringlist>Reminder ABC</stringlist>
|
||||
<stringlist>Reminder XServices</stringlist>
|
||||
<size>2</size>
|
||||
</return>
|
||||
</ns2:selectXPathResponse>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
]]></programlisting>
|
||||
</para>
|
||||
</section>
|
||||
<section version="5.0" xml:base="XmlServices/setAttribute.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>setAttribute</title>
|
||||
<para>Set an attribute into elements matched by an XPath expression.</para>
|
||||
<para>
|
||||
Sample request:
|
||||
<programlisting language="xml"><![CDATA[
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<ws:setAttribute>
|
||||
<sourcexml>
|
||||
<![CDATA[<notes xmlns="http://demo.brutex.net">
|
||||
<note>
|
||||
<to>Lena</to>
|
||||
<from>Jani</from>
|
||||
<heading>Reminder ABC</heading>
|
||||
<body>Don't forget me this weekend!</body>
|
||||
</note>
|
||||
<note>
|
||||
<to>John</to>
|
||||
<from>Lena</from>
|
||||
<heading>Call Mr. ABC</heading>
|
||||
<body>Please call back</body>
|
||||
</note>
|
||||
</notes>
|
||||
]]]]><![CDATA[></sourcexml>
|
||||
<encoding>utf-8</encoding>
|
||||
<!--Optional:-->
|
||||
<namespaceList>
|
||||
<!--Zero or more repetitions:-->
|
||||
<namespace>
|
||||
<prefix>bx</prefix>
|
||||
<uri>http://demo.brutex.net</uri>
|
||||
</namespace>
|
||||
</namespaceList>
|
||||
<xpath>*/bx:note</xpath>
|
||||
<attribute>
|
||||
<name>priority</name>
|
||||
<!--Optional:-->
|
||||
<value>high</value>
|
||||
</attribute>
|
||||
</ws:setAttribute>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
]]></programlisting>
|
||||
Sample response:
|
||||
<programlisting language="xml"><![CDATA[
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<ns2:setAttributeResponse xmlns:ns2="http://ws.xservices.brutex.net">
|
||||
<return><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
|
||||
<notes xmlns="http://demo.brutex.net">
|
||||
<note xmlns:axis2ns16="http://demo.brutex.net" axis2ns16:priority="high">
|
||||
<to>Lena</to>
|
||||
<from>Jani</from>
|
||||
<heading>Reminder ABC</heading>
|
||||
<body>Don't forget me this weekend!</body>
|
||||
</note>
|
||||
<note xmlns:axis2ns17="http://demo.brutex.net" axis2ns17:priority="high">
|
||||
<to>John</to>
|
||||
<from>Lena</from>
|
||||
<heading>Call Mr. ABC</heading>
|
||||
<body>Please call back</body>
|
||||
</note>
|
||||
</notes>]]]]><![CDATA[></return>
|
||||
</ns2:setAttributeResponse>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
]]></programlisting>
|
||||
</para>
|
||||
</section>
|
||||
<section version="5.0" xml:base="XmlServices/wrapInCDATA.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>wrapInCDATA</title>
|
||||
|
|
|
|||
|
|
@ -8,6 +8,8 @@
|
|||
http://server:port/XServices/XmlService?wsdl</para>
|
||||
<xi:include href="./insertNodes.xml" />
|
||||
<xi:include href="./replaceNodes.xml" />
|
||||
<xi:include href="./selectXPath.xml" />
|
||||
<xi:include href="./setAttribute.xml" />
|
||||
<xi:include href="./wrapInCDATA.xml" />
|
||||
|
||||
</section>
|
||||
|
|
@ -0,0 +1,73 @@
|
|||
<?xml version='1.0' encoding='utf-8'?>
|
||||
<!DOCTYPE section [
|
||||
<!ENTITY % myent SYSTEM "../entities.ent">
|
||||
%myent;
|
||||
]>
|
||||
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>selectXPath</title>
|
||||
<para>Selects xmlfragements, nodes, attribute or text from xml data using an XPath expression.
|
||||
This function requires namespaces to be declared correctly.</para>
|
||||
<para>
|
||||
Sample request:
|
||||
<programlisting language="xml"><![CDATA[
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
|
||||
xmlns:ws="http://ws.xservices.brutex.net">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<ws:selectXPath>
|
||||
<sourcexml>
|
||||
<![CDATA[<notes xmlns="http://demo.brutex.net" xmlns:bx="http://bx.brutex.net">
|
||||
<bx:note>
|
||||
<to>Lena</to>
|
||||
<from>Jani</from>
|
||||
<heading>Reminder ABC</heading>
|
||||
<body>Don't forget me this weekend!</body>
|
||||
</bx:note>
|
||||
<note>
|
||||
<to>John</to>
|
||||
<from>Lena</from>
|
||||
<heading>Call Mr. ABC</heading>
|
||||
<body>Please call back</body>
|
||||
</note>
|
||||
<bx:note>
|
||||
<to>Brian</to>
|
||||
<from>JJohn</from>
|
||||
<heading>Reminder XServices</heading>
|
||||
<body>How to use selectXPath?</body>
|
||||
</bx:note>
|
||||
</notes>
|
||||
]]]]><![CDATA[>
|
||||
</sourcexml>
|
||||
<encoding>utf-8</encoding>
|
||||
<namespaceList>
|
||||
<namespace>
|
||||
<prefix>ns</prefix>
|
||||
<uri>http://demo.brutex.net</uri>
|
||||
</namespace>
|
||||
<namespace>
|
||||
<prefix>bx</prefix>
|
||||
<uri>http://bx.brutex.net</uri>
|
||||
</namespace>
|
||||
</namespaceList>
|
||||
<xpath>*/bx:note/ns:heading/text()</xpath>
|
||||
</ws:selectXPath>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
]]></programlisting>
|
||||
Sample response:
|
||||
<programlisting language="xml"><![CDATA[
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<ns2:selectXPathResponse xmlns:ns2="http://ws.xservices.brutex.net">
|
||||
<return>
|
||||
<stringlist>Reminder ABC</stringlist>
|
||||
<stringlist>Reminder XServices</stringlist>
|
||||
<size>2</size>
|
||||
</return>
|
||||
</ns2:selectXPathResponse>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
]]></programlisting>
|
||||
</para>
|
||||
</section>
|
||||
|
|
@ -0,0 +1,77 @@
|
|||
<?xml version='1.0' encoding='utf-8'?>
|
||||
<!DOCTYPE section [
|
||||
<!ENTITY % myent SYSTEM "../entities.ent">
|
||||
%myent;
|
||||
]>
|
||||
<section xmlns="http://docbook.org/ns/docbook" version="5.0"
|
||||
xmlns:xi="http://www.w3.org/2001/XInclude">
|
||||
<title>setAttribute</title>
|
||||
<para>Set an attribute into elements matched by an XPath expression.</para>
|
||||
<para>
|
||||
Sample request:
|
||||
<programlisting language="xml"><![CDATA[
|
||||
<soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:ws="http://ws.xservices.brutex.net">
|
||||
<soapenv:Header/>
|
||||
<soapenv:Body>
|
||||
<ws:setAttribute>
|
||||
<sourcexml>
|
||||
<![CDATA[<notes xmlns="http://demo.brutex.net">
|
||||
<note>
|
||||
<to>Lena</to>
|
||||
<from>Jani</from>
|
||||
<heading>Reminder ABC</heading>
|
||||
<body>Don't forget me this weekend!</body>
|
||||
</note>
|
||||
<note>
|
||||
<to>John</to>
|
||||
<from>Lena</from>
|
||||
<heading>Call Mr. ABC</heading>
|
||||
<body>Please call back</body>
|
||||
</note>
|
||||
</notes>
|
||||
]]]]><![CDATA[></sourcexml>
|
||||
<encoding>utf-8</encoding>
|
||||
<!--Optional:-->
|
||||
<namespaceList>
|
||||
<!--Zero or more repetitions:-->
|
||||
<namespace>
|
||||
<prefix>bx</prefix>
|
||||
<uri>http://demo.brutex.net</uri>
|
||||
</namespace>
|
||||
</namespaceList>
|
||||
<xpath>*/bx:note</xpath>
|
||||
<attribute>
|
||||
<name>priority</name>
|
||||
<!--Optional:-->
|
||||
<value>high</value>
|
||||
</attribute>
|
||||
</ws:setAttribute>
|
||||
</soapenv:Body>
|
||||
</soapenv:Envelope>
|
||||
]]></programlisting>
|
||||
Sample response:
|
||||
<programlisting language="xml"><![CDATA[
|
||||
<soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
|
||||
<soap:Body>
|
||||
<ns2:setAttributeResponse xmlns:ns2="http://ws.xservices.brutex.net">
|
||||
<return><![CDATA[<?xml version='1.0' encoding='UTF-8'?>
|
||||
<notes xmlns="http://demo.brutex.net">
|
||||
<note xmlns:axis2ns16="http://demo.brutex.net" axis2ns16:priority="high">
|
||||
<to>Lena</to>
|
||||
<from>Jani</from>
|
||||
<heading>Reminder ABC</heading>
|
||||
<body>Don't forget me this weekend!</body>
|
||||
</note>
|
||||
<note xmlns:axis2ns17="http://demo.brutex.net" axis2ns17:priority="high">
|
||||
<to>John</to>
|
||||
<from>Lena</from>
|
||||
<heading>Call Mr. ABC</heading>
|
||||
<body>Please call back</body>
|
||||
</note>
|
||||
</notes>]]]]><![CDATA[></return>
|
||||
</ns2:setAttributeResponse>
|
||||
</soap:Body>
|
||||
</soap:Envelope>
|
||||
]]></programlisting>
|
||||
</para>
|
||||
</section>
|
||||
Loading…
Reference in New Issue