javax.xml.soap

Интерфейс SOAPEnvelope

Все Суперинтерфейсы:

Элемент, Узел, SOAPElement

public interface SOAPEnvelope
extends SOAPElement

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

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

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

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

      se.getBody().detachNode();
 

Создать a 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();
 

Это - ошибка добавить a SOAPBody или SOAPHeader возразите, существуете ли Вы уже.

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

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

Полевая Сводка

Поля, наследованные от интерфейса org.w3c.dom. Узел

ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_POSITION_CONTAINED_BY, DOCUMENT_POSITION_CONTAINS, DOCUMENT_POSITION_DISCONNECTED, DOCUMENT_POSITION_FOLLOWING, DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC, DOCUMENT_POSITION_PRECEDING, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE

Сводка метода

Модификатор и Тип	Метод и Описание
SOAPBody	addBody() Создает a SOAPBody объект и наборы это как SOAPBody объект для этого SOAPEnvelope объект.
SOAPHeader	addHeader() Создает a SOAPHeader объект и наборы это как SOAPHeader объект для этого SOAPEnvelope объект.
Имя	createName(String localName) Создает новое Name объект инициализируется с данным локальным именем.
Имя	createName(String localName, String prefix, String uri) Создает новое Name объект, инициализированный с данным локальным именем, префиксом пространства имен, и URI пространства имен.
SOAPBody	getBody() Возвраты SOAPBody объект связался с этим SOAPEnvelope объект.
SOAPHeader	getHeader() Возвраты SOAPHeader объект для этого SOAPEnvelope объект.

Методы, наследованные от интерфейса javax.xml.soap. SOAPElement

addAttribute, addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, createQName, getAllAttributes, getAllAttributesAsQNames, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildElements, getElementName, getElementQName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeAttribute, removeContents, removeNamespaceDeclaration, setElementQName, setEncodingStyle

Методы, наследованные от интерфейса javax.xml.soap. Узел

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Методы, наследованные от интерфейса org.w3c.dom. Элемент

getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Методы, наследованные от интерфейса org.w3c.dom. Узел

appendChild, cloneNode, compareDocumentPosition, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, getTextContent, getUserData, hasAttributes, hasChildNodes, insertBefore, isDefaultNamespace, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, normalize, removeChild, replaceChild, setNodeValue, setPrefix, setTextContent, setUserData

Деталь метода

createName

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

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

Этот метод фабрики создает Name объекты для использования в SOAP/XML-еокументе.

Параметры:

localName - a String предоставление локального имени

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

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

Возвраты:

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

Броски:

SOAPException - если есть ошибка SOAP

createName

Name createName(String localName)
         throws SOAPException

Создает новое Name объект инициализируется с данным локальным именем.

Этот метод фабрики создает Name объекты для использования в SOAP/XML-еокументе.

Параметры:

localName - a String предоставление локального имени

Возвраты:

a Name объект инициализируется с данным локальным именем

Броски:

SOAPException - если есть ошибка SOAP

getHeader

SOAPHeader getHeader()
              throws SOAPException

Возвраты SOAPHeader объект для этого SOAPEnvelope объект.

Новое SOAPMessage объект по умолчанию создается с a SOAPEnvelope объект, который содержит пустое SOAPHeader объект. В результате метод getHeader будет всегда возвращать a SOAPHeader возразите, если заголовок не был удален, и новый не был добавлен.

Возвраты:

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

Броски:

SOAPException - если есть проблема, получая SOAPHeader объект

getBody

SOAPBody getBody()
          throws SOAPException

Возвраты SOAPBody объект связался с этим SOAPEnvelope объект.

Новое SOAPMessage объект по умолчанию создается с a SOAPEnvelope объект, который содержит пустое SOAPBody объект. В результате метод getBody будет всегда возвращать a SOAPBody возразите, если тело не было удалено, и новый не был добавлен.

Возвраты:

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

Броски:

SOAPException - если есть проблема, получая SOAPBody объект

addHeader

SOAPHeader addHeader()
              throws SOAPException

Создает a SOAPHeader объект и наборы это как SOAPHeader объект для этого SOAPEnvelope объект.

Это недопустимо, чтобы добавить заголовок, когда конверт уже содержит заголовок. Поэтому, этот метод нужно вызвать только после того, как существующий заголовок был удален.

Возвраты:

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

Броски:

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

addBody

SOAPBody addBody()
          throws SOAPException

Создает a SOAPBody объект и наборы это как SOAPBody объект для этого SOAPEnvelope объект.

Это недопустимо, чтобы добавить тело, когда конверт уже содержит тело. Поэтому, этот метод нужно вызвать только после того, как существующее тело было удалено.

Возвраты:

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

Броски:

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