SOAP Body

SOAP Header

SOAP Envelope

SOAP

Основные протоколы

Для начала рассмотрим SOAP-Web Service. Основными протоколами, которые описывают Web Service и используются при их вызовах являются:

  • SOAP
  • WSDL
  • UDDI

 

Протокол SOAP представляет собой типичную пакетную структуру, состоящую из двух основных частей:

  • Header – заголовок
  • Body – тело или полезная нагрузка

SOAP использует XML для описания сообщения. Типичное сообщение в формате SOAP выглядит следующим образом:

 

<?xml version="1.0"?>

<soap:Envelope

xmlns:soap="http://www.w3.org/2001/12/soap-envelope"

soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

 

<soap:Header>

...

...

</soap:Header>

 

<soap:Body>

...

...

<soap:Fault>

...

...

</soap:Fault>

</soap:Body>

 

</soap:Envelope>

 

При этом части Header и Fault являются опциональными. Т.образом валидное SOAP сообщение может состоять только из одного Body. Обратите внимание на то, что протокол XML является case sensitive, поэтому элементы BODY и Body – это не одно и тоже.

 

Сообщение SOAP должно быть заключено в элемент Envelope.

 

Этот элемент содержит специфичные для приложения или сервиса заголовки (иначе - метаинформацию), которая может быть использована, например, при маршрутизации сообщения. Типичными примерами заголовков являются информация о транзакции, аутентификационная информация.

Для заголовка, протоколом SOAP определены ряд атрибутов, которые определяют как заголовок должен обрабатываться получателем. Такими атрибутами являются:

  • actor – это атрибут задаёт конечного получателя заголовка; так как сообщение в процессе передачи и маршрутизации может переходить от одного получателя к другому, заголовки могут добавляться и отбрасываться на каждом этапе; что бы это регламентировать, протокол SOAP задаёт порядок обработки заголовков и определяет что необходимо делать при получении заголовка сервисом, принимая во внимание факт того – является ли сервис конечным получателем (в SOAP 1.2 определены следующие значения:
    • http://www.w3.org/2002/06/soap-envelope/role/next
    • http://www.w3.org/2002/06/soap-envelope/role/none
    • http://www.w3.org/2002/06/soap-envelope/role/ultimateReceiver)
  • mustUnderstand – принимает значения 0 или 1; этот атрибут задаёт должен ли этот заголовок обрабатываться получателем, и если получатель не имеет возможности его обработать, то он должен сгенерировать сообщение об ошибке
  • encodingStyle – этот атрибут используется для задания формата представления объектов (например дат и чисел) в элементе.

 

 

Этот элемент содержит полезную нагрузку или так называемое сообщение для окончательного получателя (ultimate endpoint).

Примером Body является:

<?xml version="1.0"?>

<soap:Envelope

xmlns:soap="http://www.w3.org/2001/12/soap-envelope"

soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

 

<soap:Body>

<m:GetPrice xmlns:m="http://www.w3schools.com/prices">

<m:Item>Apples</m:Item>

</m:GetPrice>

</soap:Body>

 

</soap:Envelope>

 

При этом, элемент <m:GetPrice> является специфичным для конкретного приложения или сервиса.

 

В ответ на получение такого сообщения сервис может вернуть сообщение вида:

<?xml version="1.0"?>

<soap:Envelope

xmlns:soap="http://www.w3.org/2001/12/soap-envelope"

soap:encodingStyle="http://www.w3.org/2001/12/soap-encoding">

 

<soap:Body>

<m:GetPriceResponse xmlns:m="http://www.w3schools.com/prices">

<m:Price>1.90</m:Price>

</m:GetPriceResponse>

</soap:Body>

 

</soap:Envelope>