Интерфейс SOAPHeader

Все суперинтерфейсы:: Element, Node, SOAPElement

public interface SOAPHeader
extends SOAPElement

Представление элемента SOAP-заголовка. Элемент SOAP-заголовка состоит из XML-данных, которые влияют на обработку прикладного содержимого поставщиком сообщений. Например, семантика транзакции, информация об аутентификации и т. д. могут быть указаны в качестве содержимого объекта SOAPHeader.

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

se.getHeader().detachNode();

Объект SOAPHeader создается с помощью метода SOAPEnvelope addHeader. Этот метод, создающий новый заголовок и добавляющий его в конверт, может быть вызван только после удаления существующего заголовка.

se.getHeader().detachNode();
      SOAPHeader sh = se.addHeader();

Объект SOAPHeader может иметь только объекты SOAPHeaderElement в качестве непосредственных дочерних элементов. Метод addHeaderElement создает новый объект HeaderElement и добавляет его к объекту SOAPHeader. В следующей строке кода аргументом метода addHeaderElement является объект Name, который является именем для нового объекта HeaderElement.

SOAPHeaderElement shElement = sh.addHeaderElement(name);

См. также:: SOAPHeaderElement

Поля

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

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

Методы

Модификатор и тип	Метод и описание
`SOAPHeaderElement`	`addHeaderElement(Name name)` Создаёт новый объект `SOAPHeaderElement`, инициализированный указанным именем, и добавляет его к этому объекту `SOAPHeader`.
`SOAPHeaderElement`	`addHeaderElement(QName qname)` Создаёт новый объект `SOAPHeaderElement`, инициализированный указанным qname, и добавляет его к этому объекту `SOAPHeader`.
`SOAPHeaderElement`	`addNotUnderstoodHeaderElement(QName name)` Создаёт новый объект NotUnderstood `SOAPHeaderElement`, инициализированный указанным именем, и добавляет его к этому объекту `SOAPHeader`.
`SOAPHeaderElement`	`addUpgradeHeaderElement(Iterator supportedSOAPURIs)` Создаёт новый объект Upgrade `SOAPHeaderElement`, инициализированный указанным списком поддерживаемых SOAP-URI и добавляет его к этому объекту `SOAPHeader`.
`SOAPHeaderElement`	`addUpgradeHeaderElement(String supportedSoapUri)` Создаёт новый объект Upgrade `SOAPHeaderElement`, инициализированный указанным поддерживаемым SOAP-URI и добавляет его к этому объекту `SOAPHeader`.
`SOAPHeaderElement`	`addUpgradeHeaderElement(String[] supportedSoapUris)` Создаёт новый объект Upgrade `SOAPHeaderElement`, инициализированный указанным массивом поддерживаемых SOAP-URI и добавляет его к этому объекту `SOAPHeader`.
`Iterator`	`examineAllHeaderElements()` Возвращает итератор по всем объектам `SOAPHeaderElement` в этом объекте `SOAPHeader`.
`Iterator`	`examineHeaderElements(String actor)` Возвращает итератор по всем объектам `SOAPHeaderElement` в этом объекте `SOAPHeader` с указанным actor.
`Iterator`	`examineMustUnderstandHeaderElements(String actor)` Возвращает итератор по всем объектам `SOAPHeaderElement` в этом объекте `SOAPHeader` с указанным actor и имеющим атрибут MustUnderstand со значением, эквивалентным `true`.
`Iterator`	`extractAllHeaderElements()` Возвращает итератор по всем объектам `SOAPHeaderElement` в этом объекте `SOAPHeader` и отсоединяет их от этого объекта `SOAPHeader`.
`Iterator`	`extractHeaderElements(String actor)` Возвращает итератор по всем объектам `SOAPHeaderElement` в этом объекте `SOAPHeader` с указанным actor и отсоединяет их от этого объекта `SOAPHeader`.

Методы, унаследованные от интерфейса 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.Node

detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

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

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

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

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

Методы

addHeaderElement

SOAPHeaderElement addHeaderElement(Name name)
                            throws SOAPException

Создаёт новый объект SOAPHeaderElement , инициализированный указанным именем, и добавляет его в этот объект SOAPHeader.

Параметры:: name - объект Name с именем нового объекта SOAPHeaderElement
Возвращает:: новый объект SOAPHeaderElement , который был вставлен в этот объект SOAPHeader
Исключения:: SOAPException - если произошла ошибка SOAP
См. также:: addHeaderElement(javax.xml.namespace.QName)

addHeaderElement

SOAPHeaderElement addHeaderElement(QName qname)
                            throws SOAPException

Создаёт новый объект SOAPHeaderElement , инициализированный указанным qname, и добавляет его в этот объект SOAPHeader.

Параметры:: qname - объект QName с qname нового объекта SOAPHeaderElement
Возвращает:: новый объект SOAPHeaderElement , который был вставлен в этот объект SOAPHeader
Исключения:: SOAPException - если произошла ошибка SOAP
С момента:: SAAJ 1.3
См. также:: addHeaderElement(Name)

examineMustUnderstandHeaderElements

Iterator examineMustUnderstandHeaderElements(String actor)

Возвращает Iterator по всем объектам SOAPHeaderElement в этом объекте SOAPHeader , у которых указанный actor и атрибут MustUnderstand, значение которого эквивалентно true.

В SOAP 1.2 атрибут env:actor заменён на атрибут env:role, но с такими же семантическими характеристиками.

Параметры:: actor - String , указывающий URI actor / role , для которого выполняется поиск
Возвращает:: объект Iterator по всем объектам SOAPHeaderElement , которые содержат указанный actor / role и помечены как MustUnderstand
С момента:: SAAJ 1.2
См. также:: examineHeaderElements(java.lang.String), extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

examineHeaderElements

Iterator examineHeaderElements(String actor)

Возвращает Iterator по всем объектам SOAPHeaderElement в этом объекте SOAPHeader , у которых указанный actor. Actor — глобальный атрибут, который указывает промежуточные стороны, которые должны обработать сообщение перед достижением конечного получателя. Actor получает сообщение и обрабатывает его перед отправкой следующему actor. По умолчанию actor — конечный предполагаемый получатель сообщения, поэтому, если в объекте SOAPHeader атрибут actor не указан, он отправляется конечному получателю вместе с телом сообщения.

В SOAP 1.2 атрибут env:actor заменён на атрибут env:role, но с такими же семантическими характеристиками.

Параметры:: actor - String , указывающий URI actor / role , для которого выполняется поиск
Возвращает:: объект Iterator по всем объектам SOAPHeaderElement , которые содержат указанный actor / role
См. также:: extractHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

extractHeaderElements

Iterator extractHeaderElements(String actor)

Возвращает Iterator по всем объектам SOAPHeaderElement в этом объекте SOAPHeader , у которых указанный actor и отделяет их от этого объекта SOAPHeader.

Этот метод позволяет actor обработать части объекта SOAPHeader , относящиеся к нему, и удалить их перед передачей сообщения следующему actor.

В SOAP 1.2 атрибут env:actor заменён на атрибут env:role, но с такими же семантическими характеристиками.

Параметры:: actor - String , указывающий URI actor / role , для которого выполняется поиск
Возвращает:: объект Iterator по всем объектам SOAPHeaderElement , которые содержат указанный actor / role
См. также:: examineHeaderElements(java.lang.String), SOAPConstants.URI_SOAP_ACTOR_NEXT

addNotUnderstoodHeaderElement

SOAPHeaderElement addNotUnderstoodHeaderElement(QName name)
                                         throws SOAPException

Создаёт новый объект NotUnderstood SOAPHeaderElement , инициализированный указанным именем, и добавляет его в этот объект SOAPHeader . Эта операция поддерживается только SOAP 1.2.

Параметры:: name - объект QName с именем объекта SOAPHeaderElement , который не был понят.
Возвращает:: новый объект SOAPHeaderElement , который был вставлен в этот объект SOAPHeader
Исключения:: SOAPException - если произошла ошибка SOAP.; UnsupportedOperationException - если это заголовок SOAP 1.1.
С момента:: SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs)
                                   throws SOAPException

Создаёт новый объект Upgrade SOAPHeaderElement , инициализированный указанным списком поддерживаемых URI SOAP и добавляет его в этот объект SOAPHeader . Эта операция поддерживается как в заголовках SOAP 1.1, так и в SOAP 1.2.

Параметры:: supportedSOAPURIs - объект Iterator с URI поддерживаемых версий SOAP.
Возвращает:: новый объект SOAPHeaderElement , который был вставлен в этот объект SOAPHeader
Исключения:: SOAPException - если произошла ошибка SOAP.
С момента:: SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(String[] supportedSoapUris)
                                   throws SOAPException

Создаёт новый объект Upgrade SOAPHeaderElement , инициализированный указанным массивом поддерживаемых URI SOAP и добавляет его в этот объект SOAPHeader . Эта операция поддерживается как в заголовках SOAP 1.1, так и в SOAP 1.2.

Параметры:: supportedSoapUris - массив URI поддерживаемых версий SOAP.
Возвращает:: новый объект SOAPHeaderElement , который был вставлен в этот объект SOAPHeader
Исключения:: SOAPException - если произошла ошибка SOAP.
С момента:: SAAJ 1.3

addUpgradeHeaderElement

SOAPHeaderElement addUpgradeHeaderElement(String supportedSoapUri)
                                   throws SOAPException

Создаёт новый объект Upgrade SOAPHeaderElement , инициализированный указанным поддерживаемым URI SOAP, и добавляет его в этот объект SOAPHeader . Эта операция поддерживается как в заголовках SOAP 1.1, так и в SOAP 1.2.

Параметры:: supportedSoapUri - URI поддерживаемой версии SOAP.
Возвращает:: новый объект SOAPHeaderElement , который был вставлен в этот объект SOAPHeader
Исключения:: SOAPException - если произошла ошибка SOAP.
С момента:: SAAJ 1.3

examineAllHeaderElements

Iterator examineAllHeaderElements()

Возвращает Iterator по всем объектам SOAPHeaderElement в этом объекте SOAPHeader.

Возвращает:: объект Iterator по всем объектам SOAPHeaderElement , содержащимся в этом объекте SOAPHeader
С момента:: SAAJ 1.2
См. также:: extractAllHeaderElements()

extractAllHeaderElements

Iterator extractAllHeaderElements()

Возвращает Iterator по всем объектам SOAPHeaderElement в этом объекте SOAPHeader и отделяет их от этого объекта SOAPHeader.

Возвращает:: объект Iterator по всем объектам SOAPHeaderElement , содержащимся в этом объекте SOAPHeader
С момента:: SAAJ 1.2
См. также:: examineAllHeaderElements()

© 1993, 2020, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.