XML-RPC

XML-RPC is a remote procedure call (RPC) protocol which uses XML to encode its calls and HTTP as a transport mechanism.[1] "XML-RPC" also refers generically to the use of XML for remote procedure call, independently of the specific protocol. This article is about the protocol named "XML-RPC".

History

The XML-RPC protocol was created in 1998 by Dave Winer of UserLand Software and Microsoft,[2] with Microsoft seeing the protocol as an essential part of scaling up its efforts in business-to-business e-commerce.[3] As new functionality was introduced, the standard evolved into what is now SOAP.[4]

UserLand supported XML-RPC from version 5.1 of its Frontier web content management system,[4] released in June 1998.[5]

XML-RPC's idea of a human-readable-and-writable, script-parsable standard for HTTP-based requests and responses has also been implemented in competing specifications such as Allaire's Web Distributed Data Exchange (WDDX) and webMethod's Web Interface Definition Language (WIDL).[6] Prior art wrapping COM, CORBA, and Java RMI objects in XML syntax and transporting them via HTTP also existed in DataChannel's WebBroker technology.[7][8]

The generic use of XML for remote procedure call (RPC) was patented by Phillip Merrick, Stewart Allen, and Joseph Lapp in April 2006, claiming benefit to a provisional application filed in March 1998. The patent is assigned to webMethods, located in Fairfax, VA.[9]

Usage

XML-RPC works by sending an HTTP request to a server implementing the protocol. The client in that case is typically software wanting to call a single method of a remote system. Multiple input parameters can be passed to the remote method, one return value is returned. The parameter types allow nesting of parameters into maps and lists, thus larger structures can be transported. Therefore, XML-RPC can be used to transport objects or structures both as input and as output parameters.

Identification of clients for authorization purposes can be achieved using popular HTTP security methods. Basic access authentication is used for identification, HTTPS is used when identification (via certificates) and encrypted messages are needed. Both methods can be combined.

In comparison to REST, where resource representations (documents) are transferred, XML-RPC is designed to call methods.

XML-RPC can be argued as simpler than SOAP because it

JSON-RPC is similar to XML-RPC.

Data types

Common datatypes are converted into their XML equivalents with example values shown below:

Name Tag Example Description
array 
<array>
  <data>
    <value><i4>1404</i4></value>
    <value><string>Something here</string></value>
    <value><i4>1</i4></value>
  </data>
</array>
Array of values, storing no keys
base64 
<base64>eW91IGNhbid0IHJlYWQgdGhpcyE=</base64>
Base64-encoded binary data
boolean 
<boolean>1</boolean>
Boolean logical value (0 or 1)
date/time 
<dateTime.iso8601>19980717T14:08:55</dateTime.iso8601>
Date and time in ISO 8601 format
double 
<double>-12.53</double>
Double precision floating point number
integer 
<int>42</int>

or

<i4>42</i4>
Whole number, integer
string 
<string>Hello world!</string>

or

Hello world!
String of characters. Must follow XML encoding.
struct 
<struct>
  <member>
    <name>foo</name>
    <value><i4>1</i4></value>
  </member>
  <member>
    <name>bar</name>
    <value><i4>2</i4></value>
  </member>
</struct>
Associative array
nil 
<nil/>
Discriminated null value; an XML-RPC extension

Examples

An example of a typical XML-RPC request would be:

<?xml version="1.0"?>
<methodCall>
  <methodName>examples.getStateName</methodName>
  <params>
    <param>
        <value><i4>40</i4></value>
    </param>
  </params>
</methodCall>

An example of a typical XML-RPC response would be:

<?xml version="1.0"?>
<methodResponse>
  <params>
    <param>
        <value><string>South Dakota</string></value>
    </param>
  </params>
</methodResponse>

A typical XML-RPC fault would be:

<?xml version="1.0"?>
<methodResponse>
  <fault>
    <value>
      <struct>
        <member>
          <name>faultCode</name>
          <value><int>4</int></value>
        </member>
        <member>
          <name>faultString</name>
          <value><string>Too many parameters.</string></value>
        </member>
      </struct>
    </value>
  </fault>
</methodResponse>

Criticism

Recent critics (from 2010 and onwards) of XML-RPC argue that RPC calls can be made with plain XML, and that XML-RPC does not add any value over XML. Both XML-RPC and XML require an application-level data model, such as which field names are defined in the XML schema or the parameter names in XML-RPC. Furthermore, XML-RPC uses about 4 times the number of bytes compared to plain XML to encode the same objects, which is itself verbose compared to JSON.[10][11][12]

Implementations

Ruby

Python

C++

Objective-C / GNUstep / Cocoa

Erlang

Groovy

Java

JavaScript

XMPP

PHP

Perl

Other

See also

References

  1. ↑ Simon St. Laurent, Joe Johnston, Edd Dumbill. (June 2001) Programming Web Services with XML-RPC. O'Reilly. First Edition.
  2. ↑ Box, Don (1 April 2001). "A Brief History of SOAP". O'Reilly. Retrieved 27 October 2010.
  3. ↑ Rupley, Sebastian (1999-06-30). "XML's Next Step". PC Magazine. Archived from the original on 4 March 2000. Retrieved 2015-11-17.
  4. 1 2 Walsh, Jeff (1999-07-10). "Microsoft spearheads protocol push". Infoworld. Archived from the original on 14 September 1999. Retrieved 2015-11-17.
  5. ↑ Walsh, Jeff (June 29, 1998). "UserLand releases Frontier 5.1, drops freeware model". InfoWorld. Archived from the original on September 15, 1999. Retrieved November 17, 2015.
  6. ↑ Udell, Jon (1999-06-07). "Exploring XML-RPC: DCOM? CORBA? RMI? Why Not Just XML-RPC?". Byte. Archived from the original on 4 March 2000. Retrieved 2015-11-17.
  7. ↑ Walsh, Jeff (1998-05-25). "W3C gives a nod to DataChannel's WebBroker". Infoworld 20 (21). Archived from the original on 10 September 1999. Retrieved 2015-11-17.
  8. ↑ Vizard, Michael; Walsh, Jeff (1998-06-29). "DataChannel's Dave Pool talks about shaping the role of XML to suit different needs". Infoworld. Archived from the original on 16 September 1999. Retrieved 2015-12-08.
  9. ↑ Merrick; et al. (11 April 2006). "US Patent 7,028,312". Retrieved 18 September 2008.
  10. ↑ "What is the benefit of XML-RPC over plain XML?". Stack Overflow. 9 September 2009. Retrieved 7 April 2011.
  11. ↑ "An open poll on the merits of XmlRpc versus alternatives". intertwingly.net. 22 November 2006. Retrieved 7 April 2011. External link in |publisher= (help)
  12. ↑ Jon Canady (14 January 2010). "If you have REST, why XML-RPC?". joncanady.com. Retrieved 7 April 2011. External link in |publisher= (help)

External links

This article is issued from Wikipedia - version of the Sunday, April 17, 2016. The text is available under the Creative Commons Attribution/Share Alike but additional terms may apply for the media files.