Интерфейс SOAPEnvelope

public interface SOAPEnvelope
extends SOAPElement

Контейнер для разделов SOAPHeader и SOAPBody объекта SOAPPart. По умолчанию объект SOAPMessage создается с объектом SOAPPart, который имеет объект SOAPEnvelope. Объект SOAPEnvelope по умолчанию имеет пустой объект SOAPBody и пустой объект SOAPHeader. Объект SOAPBody обязателен, а объект SOAPHeader, хотя и необязателен, используется в большинстве случаев. Если объект SOAPHeader не нужен, его можно удалить, что показано позже.

Клиент может получить доступ к объектам SOAPHeader и SOAPBody, вызвав методы SOAPEnvelope.getHeader и SOAPEnvelope.getBody. Следующие строки кода используют эти два метода после начала с объекта SOAPMessage message для получения объекта SOAPPart sp, который затем используется для получения объекта SOAPEnvelope se.

SOAPPart sp = message.getSOAPPart();
     SOAPEnvelope se = sp.getEnvelope();
     SOAPHeader sh = se.getHeader();
     SOAPBody sb = se.getBody();

Можно изменить тело или заголовок объекта SOAPEnvelope путем получения текущего, удаления его и добавления нового тела или заголовка. Метод javax.xml.soap.Node deleteNode удаляет XML-элемент (узел), на котором он вызывается. Например, следующая строка кода удаляет объект SOAPBody, полученный методом getBody.

se.getBody().detachNode();

Для создания объекта SOAPHeader для замены удаленного клиент использует метод SOAPEnvelope.addHeader, который создает новый заголовок и добавляет его к объекту SOAPEnvelope. Аналогично, метод addBody создает новый объект SOAPBody и добавляет его к объекту SOAPEnvelope. Следующий фрагмент кода получает текущий заголовок, удаляет его и добавляет новый. Затем он получает текущее тело, удаляет его и добавляет новое.

SOAPPart sp = message.getSOAPPart();
     SOAPEnvelope se = sp.getEnvelope();
     se.getHeader().detachNode();
     SOAPHeader sh = se.addHeader();
     se.getBody().detachNode();
     SOAPBody sb = se.addBody();

Добавление объекта SOAPBody или SOAPHeader , если он уже существует, является ошибкой.

Интерфейс SOAPEnvelope предоставляет три метода для создания объектов Name. Один метод создает объекты Name с локальным именем, префиксом пространства имен и URI пространства имен. Второй метод создает объекты Name с локальным именем и префиксом пространства имен, а третий — объекты Name только с локальным именем. Следующая строка кода, в которой se — это объект SOAPEnvelope, создает новый объект Name со всеми тремя.

Name name = se.createName("GetLastTradePrice", "WOMBAT",
                                "http://www.wombat.org/trader");

Методы

createName

Name createName(String localName,
                String prefix,
                String uri)
         throws SOAPException

Параметры:

localName - a String дающее локальное имя

prefix - a String дающее префикс пространства имен

uri - a String дающее URI пространства имен

Возвращает:

объект Name , инициализированный заданным локальным именем, префиксом пространства имен и URI пространства имен

Исключения:

SOAPException - если произошла ошибка SOAP

createName

Name createName(String localName)
         throws SOAPException

Параметры:

localName - a String дающее локальное имя

Возвращает:

объект Name , инициализированный заданным локальным именем

Исключения:

SOAPException - если произошла ошибка SOAP

getHeader

SOAPHeader getHeader()
              throws SOAPException

Возвращает:

объект SOAPHeader или null, если его нет

Исключения:

SOAPException - если возникла проблема с получением объекта SOAPHeader

getBody

SOAPBody getBody()
          throws SOAPException

Возвращает:

объект SOAPBody для этого объекта SOAPEnvelope или null, если его нет

Исключения:

SOAPException - если возникла проблема с получением объекта SOAPBody

addHeader

SOAPHeader addHeader()
              throws SOAPException

Возвращает:

новый объект SOAPHeader

Исключения:

SOAPException - если этот объект SOAPEnvelope уже содержит допустимый объект SOAPHeader

addBody

SOAPBody addBody()
          throws SOAPException

Возвращает:

новый объект SOAPBody

Исключения:

SOAPException - если этот объект SOAPEnvelope уже содержит допустимый объект SOAPBody