Brutex
/
XServices
1
0
Fork 0
Code Issues 2 Pull Requests Actions Projects Releases 4 Wiki Activity

Update documentation for MiscServices 

git-svn-id: https://brutex.net/svn/xservices/trunk@77 e7e49efb-446e-492e-b9ec-fcafc1997a86
tag-20130205r
Brian Rosenberger 2011-12-31 13:39:29 +00:00
parent a412a268ea
commit 72ae2fae1b
5 changed files with 148 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

65
doc/BruteXServices_User_Guide.dbk
View File

@ -640,7 +640,72 @@
<title>MiscServices</title> <title>MiscServices</title>
<para>The MiscService bundles various operations. Its WSDL is located at <para>The MiscService bundles various operations. Its WSDL is located at
http://server:port/XServices/MiscService?wsdl</para> http://server:port/XServices/MiscService?wsdl</para>
<section version="5.0" xml:base="MiscServices/generateUUID.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>generateUUID</title>
<para>Generates a UUID that represents a 128-bit value. This operation does not require any
input parameters. The output has the format:
<screen>
0xFFFFFFFF00000000 time_low
0x00000000FFFF0000 time_mid
0x000000000000F000 version
0x0000000000000FFF time_hi
</screen>
The least significant long consists of the following unsigned fields:
<screen>
0xC000000000000000 variant
0x3FFF000000000000 clock_seq
0x0000FFFFFFFFFFFF node
</screen>
Sample response:
<screen><![CDATA[
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:generateUUIDResponse
xmlns:ns1="http://ws.xservices.brutex.net">
<ns1:return>]]><emphasis>33b9e5c8-9102-423b-88af-bbee479ebea8</emphasis><![CDATA[</ns1:return>
</ns1:generateUUIDResponse>
</soap:Body>
</soap:Envelope>
]]></screen>
</para>
</section>
<section version="5.0" xml:base="MiscServices/getHostinfo.xml" xmlns="http://docbook.org/ns/docbook" xmlns:xi="http://www.w3.org/2001/XInclude">
<title>getHostinfo</title>
<para>Collect information about a host address.
Sample request:
<screen><![CDATA[
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:getHostinfo>
<ws:hostname>]]><emphasis>google.com</emphasis><![CDATA[</ws:hostname>
</ws:getHostinfo>
</soapenv:Body>
</soapenv:Envelope>
]]></screen>
Sample response:
<screen><![CDATA[
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getHostinfoResponse
xmlns:ns1="http://ws.xservices.brutex.net">
<ns1:return>
<ns1:domain>]]><emphasis>1e100.net</emphasis><![CDATA[</ns1:domain>
<ns1:ip4>]]><emphasis>173.194.66.105</emphasis><![CDATA[</ns1:ip4>
<ns1:ip6>]]><emphasis>::</emphasis><![CDATA[</ns1:ip6>
<ns1:name>]]><emphasis>we-in-f105</emphasis><![CDATA[</ns1:name>
</ns1:return>
</ns1:getHostinfoResponse>
</soap:Body>
</soap:Envelope>
]]></screen>
</para>
</section>
</section> </section>
</chapter> </chapter>

4
doc/BruteXServices_User_Guide.xml
View File

@ -21,7 +21,7 @@
<para> <para>
The copyright holders make no representation about the suitability The copyright holders make no representation about the suitability
of this document for any purpose. It is provided of this document for any purpose. It is provided
<quote>as is</quote> <emphasis>as is</emphasis>
without expressed or implied warranty. without expressed or implied warranty.
</para> </para>
</legalnotice> </legalnotice>
@ -34,7 +34,7 @@
<chapter id="installation"> <chapter id="installation">
<beginpage /> <beginpage />
<title>Getting started</title> <title>Getting started</title>
<para>This chapter describes the installation.</para> <para>This chapter describes the installation process.</para>
<xi:include href="common/installation.xml"/> <xi:include href="common/installation.xml"/>
</chapter> </chapter>
<chapter id="services"> <chapter id="services">

3
doc/MiscServices.xml
View File

@ -5,5 +5,6 @@
<title>MiscServices</title> <title>MiscServices</title>
<para>The MiscService bundles various operations. Its WSDL is located at <para>The MiscService bundles various operations. Its WSDL is located at
http://server:port/XServices/MiscService?wsdl</para> http://server:port/XServices/MiscService?wsdl</para>
<xi:include href="MiscServices/generateUUID.xml" />
<xi:include href="MiscServices/getHostinfo.xml" />
</section> </section>

37
doc/MiscServices/generateUUID.xml Normal file
View File

@ -0,0 +1,37 @@
<?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>generateUUID</title>
<para>Generates a UUID that represents a 128-bit value. This operation does not require any
input parameters. The output has the format:
<screen>
0xFFFFFFFF00000000 time_low
0x00000000FFFF0000 time_mid
0x000000000000F000 version
0x0000000000000FFF time_hi
</screen>
The least significant long consists of the following unsigned fields:
<screen>
0xC000000000000000 variant
0x3FFF000000000000 clock_seq
0x0000FFFFFFFFFFFF node
</screen>
Sample response:
<screen><![CDATA[
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:generateUUIDResponse
xmlns:ns1="http://ws.xservices.brutex.net">
<ns1:return>]]><emphasis>33b9e5c8-9102-423b-88af-bbee479ebea8</emphasis><![CDATA[</ns1:return>
</ns1:generateUUIDResponse>
</soap:Body>
</soap:Envelope>
]]></screen>
</para>
</section>

41
doc/MiscServices/getHostinfo.xml Normal file
View File

@ -0,0 +1,41 @@
<?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>getHostinfo</title>
<para>Collect information about a host address.
Sample request:
<screen><![CDATA[
<soapenv:Envelope
xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"
xmlns:ws="http://ws.xservices.brutex.net">
<soapenv:Header/>
<soapenv:Body>
<ws:getHostinfo>
<ws:hostname>]]><emphasis>google.com</emphasis><![CDATA[</ws:hostname>
</ws:getHostinfo>
</soapenv:Body>
</soapenv:Envelope>
]]></screen>
Sample response:
<screen><![CDATA[
<soap:Envelope
xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
<soap:Body>
<ns1:getHostinfoResponse
xmlns:ns1="http://ws.xservices.brutex.net">
<ns1:return>
<ns1:domain>]]><emphasis>1e100.net</emphasis><![CDATA[</ns1:domain>
<ns1:ip4>]]><emphasis>173.194.66.105</emphasis><![CDATA[</ns1:ip4>
<ns1:ip6>]]><emphasis>::</emphasis><![CDATA[</ns1:ip6>
<ns1:name>]]><emphasis>we-in-f105</emphasis><![CDATA[</ns1:name>
</ns1:return>
</ns1:getHostinfoResponse>
</soap:Body>
</soap:Envelope>
]]></screen>
</para>
</section>