SOAPHeader (Платформа Java SE 7)

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

Элемент, Узел, SOAPElement
```
public interface SOAPHeader
extends SOAPElement
```
Представление элемента заголовка SOAP. Элемент заголовка SOAP состоит из данных XML, который влияет на способ, которым специализированный контент обрабатывается провайдером сообщения. Например, семантика транзакции, информация об аутентификации, и так далее, может быть определена как контент a SOAPHeader объект.
A SOAPEnvelope объект содержит пустое SOAPHeader объект по умолчанию. Если SOAPHeader объект, который является дополнительным, не необходим, он может быть получен и удален со следующей строкой кода. Переменная se является a SOAPEnvelope объект.
```
      se.getHeader().detachNode();
 
```
A SOAPHeader объект создается с SOAPEnvelope метод addHeader. Этот метод, который создает новый заголовок и добавляет это к конверту, можно вызвать только после того, как существующий заголовок был удален.
```
      se.getHeader().detachNode();
      SOAPHeader sh = se.addHeader();
 
```
A SOAPHeader объект может иметь только SOAPHeaderElement объекты как его непосредственные дочерние элементы. Метод addHeaderElement создает новое HeaderElement возразите и добавляет это к SOAPHeader объект. В следующей строке кода, параметра методу addHeaderElement a Name объект, который является именем для нового HeaderElement объект.
```
      SOAPHeaderElement shElement = sh.addHeaderElement(name);
 
```
См. Также:
SOAPHeaderElement

Полевая Сводка
- Поля, наследованные от интерфейса 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

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

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

- Деталь метода
  - addHeaderElement
```
SOAPHeaderElement addHeaderElement(Name name)
                                   throws SOAPException
```
    Создает новое SOAPHeaderElement объект, инициализированный с указанным именем и, добавляет это к этому SOAPHeader объект.
    
    Параметры:
    name - a Name объект с именем нового SOAPHeaderElement объект
    
    Возвраты:
    новое SOAPHeaderElement объект, который был вставлен в это SOAPHeader объект
    
    Броски:
    
    SOAPException - если ошибка SOAP происходит
    См. Также:
    addHeaderElement(javax.xml.namespace.QName)
  - addHeaderElement
```
SOAPHeaderElement addHeaderElement(QName qname)
                                   throws SOAPException
```
    Создает новое SOAPHeaderElement объект, инициализированный с указанным qname и, добавляет это к этому SOAPHeader объект.
    
    Параметры:
    qname - a QName объект с qname нового SOAPHeaderElement объект
    
    Возвраты:
    новое SOAPHeaderElement объект, который был вставлен в это SOAPHeader объект
    
    Броски:
    
    SOAPException - если ошибка SOAP происходит
    С тех пор:
    
    SAAJ 1.3
    
    См. Также:
    addHeaderElement(Name)
  - examineMustUnderstandHeaderElements
```
Iterator examineMustUnderstandHeaderElements(String actor)
```
    Возвраты Iterator по весь SOAPHeaderElement объекты в этом SOAPHeader объект, у которых есть указанный агент и которые сделали, чтобы MustUnderstand приписал, чье значение эквивалентно true.
    В SOAP 1.2 атрибут env:actor заменяется атрибутом env:role, но с по существу той же самой семантикой.
    
    Параметры:
    actor - a 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 объект, у которых есть указанный агент. Агент является глобальным атрибутом, который указывает на промежуточные стороны, которые должны обработать сообщение прежде, чем он достигнет своего окончательного получателя. Агент получает сообщение и обрабатывает его перед пересылкой его к следующему агенту. Агент по умолчанию является окончательным предполагаемым получателем для сообщения, так, если никакой атрибут агента не включается в a SOAPHeader объект, это отправляется окончательному получателю наряду с текстом сообщения.
    В SOAP 1.2 атрибут env:actor заменяется атрибутом env:role, но с по существу той же самой семантикой.
    
    Параметры:
    actor - a 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 объект, которые имеют указанного агента и отсоединяют их от этого SOAPHeader объект.
    Этот метод позволяет агенту обрабатывать части SOAPHeader объект, которые применяются к этому и удалить их перед передачей сообщения к следующему агенту.
    В SOAP 1.2 атрибут env:actor заменяется атрибутом env:role, но с по существу той же самой семантикой.
    
    Параметры:
    actor - a 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 - a QName объект с именем SOAPHeaderElement объект, который не был понят.
    
    Возвраты:
    новое SOAPHeaderElement объект, который был вставлен в это SOAPHeader объект
    
    Броски:
    
    SOAPException - если ошибка SOAP происходит.
    
    UnsupportedOperationException - если это - SOAP 1.1 Заголовка.
    С тех пор:
    
    SAAJ 1.3
  - addUpgradeHeaderElement
```
SOAPHeaderElement addUpgradeHeaderElement(Iterator supportedSOAPURIs)
                                          throws SOAPException
```
    Создает новое Обновление 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
```
    Создает новое Обновление 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
```
    Создает новое Обновление 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()

Представьте ошибку или функцию
Для дальнейшей ссылки API и документации разработчика, см. Java Документация SE. Та документация содержит более подробные, предназначенные разработчиком описания, с концептуальными краткими обзорами, определениями сроков, обходных решений, и рабочих примеров кода.
Авторское право © 1993, 2011, Oracle и/или его филиалы. Все права защищены.

Интерфейсный SOAPHeader

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

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

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

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

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

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

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

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

addHeaderElement

addHeaderElement

examineMustUnderstandHeaderElements

examineHeaderElements

extractHeaderElements

addNotUnderstoodHeaderElement

addUpgradeHeaderElement

addUpgradeHeaderElement

addUpgradeHeaderElement

examineAllHeaderElements

extractAllHeaderElements