SOAP

From
(Difference between revisions)
Jump to: navigation, search
m (Soap Interface Purpose)
(Definitions, Acronyms and Abbreviations)
 
(8 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
 
 
== Background ==
 
== Background ==
  
From the draft W3C specification: “SOAP is a lightweight protocol for exchange of information in a decentralized, distributed environment.  It is an XML based communication protocol that consists of three parts:
+
From the draft W3C specification: SOAP is a lightweight protocol for exchange of information in a decentralized, distributed environment.  It is an XML based communication protocol that consists of three parts:
  
 
*An envelope that defines a framework for describing what is in a message and how to process it;
 
*An envelope that defines a framework for describing what is in a message and how to process it;
Line 37: Line 35:
 
|---- bgcolor=#CCFFFF
 
|---- bgcolor=#CCFFFF
 
|WSDL
 
|WSDL
|[[http://www.w3.org/TR/wsdl|Web Services Description Language]]
+
|[http://www.w3.org/TR/wsdl Web Services Description Language]
 
|}
 
|}
  
 
== Soap Interface Purpose ==
 
== Soap Interface Purpose ==
  
The SOAP interface to NADS is intended for communicating and responding to requests from a client application.  As such the format is designed with machine readability rather than human readability in mind.
+
The SOAP interface to [[NADS]] is intended for communicating and responding to requests from a client application.  As such the format is designed with machine readability rather than human readability in mind.
  
 
The SOAP interface has two major roles:
 
The SOAP interface has two major roles:
Line 52: Line 50:
  
  
Messages in this document are written to conform to the SOAP specification as registered at [http://schemas.xmlsoap.org/soap/envelope/].  More specifically, the internal structure of the messages match the WSDL describing the exact message structure used in relation to the NADS SOAP interface.
+
Messages in this document are written to conform to the SOAP specification as registered at [http://schemas.xmlsoap.org/soap/envelope/].  More specifically, the internal structure of the messages match the WSDL describing the exact message structure used in relation to the [[NADS]] SOAP interface.

Latest revision as of 01:26, 24 May 2010

Contents

[edit] Background

From the draft W3C specification: SOAP is a lightweight protocol for exchange of information in a decentralized, distributed environment. It is an XML based communication protocol that consists of three parts:

  • An envelope that defines a framework for describing what is in a message and how to process it;
  • A set of encoding rules for expressing instances of application-defined data types; and
  • A convention for representing remote procedure calls and responses.

Web Services Description Language (WSDL) is a specification defining how to describe Web Services in a common XML grammar. It describes four critical pieces of data:

  • Interface information describing all publicly available functions
  • Data type information for all message requests and message responses
  • Binding information about the transport protocol to be used
  • Address information for locating the specified service

WSDL is platform and language-independent and is used primarily (although not exclusively) to describe SOAP services. Using WSDL, a client can locate a web service and invoke any of its publicly available functions. With WSDL-aware tools (such as .NET), you can automate this process, enabling applications to easily integrate new services with little or no manual code.

[edit] Definitions, Acronyms and Abbreviations

This document uses the following definitions, acronyms and abbreviations.

Acronym Definition
SOAP Simple Object Access Protocol
XML Extended Mark-up Language
WSDL Web Services Description Language

[edit] Soap Interface Purpose

The SOAP interface to NADS is intended for communicating and responding to requests from a client application. As such the format is designed with machine readability rather than human readability in mind.

The SOAP interface has two major roles:

  1. Receipt and processing of incoming SOAP requests that describe new jobs to be created and dispatched.
  2. Generation and sending of responses to requests detailing job progress/status information to the originator of the job.

[edit] Encoding

Messages in this document are written to conform to the SOAP specification as registered at [1]. More specifically, the internal structure of the messages match the WSDL describing the exact message structure used in relation to the NADS SOAP interface.

Personal tools
MediaWiki Appliance - Powered by TurnKey Linux