Spec-Zone.ru › OpenJDK 8

Интерфейс SOAPBody

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

public interface SOAPBody
extends SOAPElement

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

Объект SOAPBody содержит объекты SOAPBodyElement, которые содержат содержимое для SOAP-тела. Объект SOAPFault, который несёт информацию о статусе и/или ошибках, является примером объекта SOAPBodyElement.

См. также:
SOAPFault

Поля

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

Методы

Модификатор и тип Метод и описание
SOAPBodyElement addBodyElement(Name name)

Создаёт новый объект SOAPBodyElement с указанным именем и добавляет его в этот объект SOAPBody.

SOAPBodyElement addBodyElement(QName qname)

Создаёт новый объект SOAPBodyElement с указанным QName и добавляет его в этот объект SOAPBody.

SOAPBodyElement addDocument(Document document)

Добавляет корневой узел DOM Document в этот объект SOAPBody.

SOAPFault addFault()

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody.

SOAPFault addFault(Name faultCode, String faultString)

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody.

SOAPFault addFault(Name faultCode, String faultString, Locale locale)

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody.

SOAPFault addFault(QName faultCode, String faultString)

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody.

SOAPFault addFault(QName faultCode, String faultString, Locale locale)

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody.

Document extractContentAsDocument()

Создаёт новый DOM Document и устанавливает первый дочерний элемент этого объекта SOAPBody в качестве элемента документа.

SOAPFault getFault()

Возвращает объект SOAPFault в этом объекте SOAPBody.

boolean hasFault()

Указывает, существует ли объект SOAPFault в этом объекте SOAPBody.

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

Методы

addFault

SOAPFault addFault()
            throws SOAPException

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody. У нового объекта SOAPFault будут установлены значения по умолчанию для обязательных дочерних элементов. Тип объекта SOAPFault будет SOAP 1.1 или SOAP 1.2 SOAPFault в зависимости от protocol, указанного при создании экземпляра объекта MessageFactory.

Объект SOAPBody может содержать не более одного дочернего элемента SOAPFault.

Возвращает:
новый объект SOAPFault
Изволяет:
SOAPException - если произошла ошибка SOAP

addFault

SOAPFault addFault(Name faultCode,
                   String faultString,
                   Locale locale)
            throws SOAPException

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody. Тип объекта SOAPFault будет SOAP 1.1 или SOAP 1.2 SOAPFault в зависимости от protocol, указанного при создании экземпляра объекта MessageFactory.

Для SOAP 1.2 параметр faultCode — значение элемента Fault/Code/Value, а параметр faultString — значение элемента Fault/Reason/Text. Для SOAP 1.1 параметр faultCode — значение элемента faultcode, а параметр faultString — значение элемента faultstring.

Объект SOAPBody может содержать не более одного дочернего элемента SOAPFault.

Параметры:
faultCode - объект Name, задающий код ошибки; должен быть одним из кодов ошибок, определённых в используемой версии спецификации SOAP
faultString - объект String, содержащий объяснение ошибки
locale - объект Locale, указывающий язык по умолчанию для faultString
Возвращает:
новый объект SOAPFault
Изволяет:
SOAPException - если произошла ошибка SOAP
С момента:
SAAJ 1.2
См. также:
SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)

addFault

SOAPFault addFault(QName faultCode,
                   String faultString,
                   Locale locale)
            throws SOAPException

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody. Тип объекта SOAPFault будет SOAP 1.1 или SOAP 1.2 SOAPFault в зависимости от protocol, указанного при создании экземпляра объекта MessageFactory.

Для SOAP 1.2 параметр faultCode — значение элемента Fault/Code/Value, а параметр faultString — значение элемента Fault/Reason/Text. Для SOAP 1.1 параметр faultCode — значение элемента faultcode, а параметр faultString — значение элемента faultstring.

Объект SOAPBody может содержать не более одного дочернего элемента SOAPFault.

Параметры:
faultCode - объект QName, задающий код ошибки; должен быть одним из кодов ошибок, определённых в используемой версии спецификации SOAP.
faultString - объект String, содержащий объяснение ошибки
locale - объект Locale, указывающий язык по умолчанию для faultString
Возвращает:
новый объект SOAPFault
Изволяет:
SOAPException - если произошла ошибка SOAP
С момента:
SAAJ 1.3
См. также:
SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String), addFault(Name faultCode, String faultString, Locale locale)

addFault

SOAPFault addFault(Name faultCode,
                   String faultString)
            throws SOAPException

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody. Тип объекта SOAPFault будет SOAP 1.1 или SOAP 1.2 SOAPFault в зависимости от protocol, указанного при создании экземпляра объекта MessageFactory.

Для SOAP 1.2 параметр faultCode — значение элемента Fault/Code/Value, а параметр faultString — значение элемента Fault/Reason/Text. Для SOAP 1.1 параметр faultCode — значение элемента faultcode, а параметр faultString — значение элемента faultstring.

В случае ошибки SOAP 1.2 значение по умолчанию для обязательного атрибута xml:lang элемента Fault/Reason/Text будет установлено в java.util.Locale.getDefault()

Объект SOAPBody может содержать не более одного дочернего элемента SOAPFault.

Параметры:
faultCode - объект Name, задающий код ошибки; должен быть одним из кодов ошибок, определённых в используемой версии спецификации SOAP
faultString - объект String, содержащий объяснение ошибки
Возвращает:
новый объект SOAPFault
Изволяет:
SOAPException - если произошла ошибка SOAP
С момента:
SAAJ 1.2
См. также:
SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String)

addFault

SOAPFault addFault(QName faultCode,
                   String faultString)
            throws SOAPException

Создаёт новый объект SOAPFault и добавляет его в этот объект SOAPBody. Тип объекта SOAPFault будет SOAP 1.1 или SOAP 1.2 SOAPFault в зависимости от protocol, указанного при создании экземпляра объекта MessageFactory.

Для SOAP 1.2 параметр faultCode — значение элемента Fault/Code/Value, а параметр faultString — значение элемента Fault/Reason/Text. Для SOAP 1.1 параметр faultCode — значение элемента faultcode, а параметр faultString — значение элемента faultstring.

В случае ошибки SOAP 1.2 значение по умолчанию для обязательного атрибута xml:lang элемента Fault/Reason/Text будет установлено в java.util.Locale.getDefault()

Объект SOAPBody может содержать не более одного дочернего элемента SOAPFault

Параметры:
faultCode - объект QName, задающий код ошибки; должен быть одним из кодов ошибок, определённых в используемой версии спецификации SOAP
faultString - объект String, содержащий объяснение ошибки
Возвращает:
новый объект SOAPFault
Изволяет:
SOAPException - если произошла ошибка SOAP
С момента:
SAAJ 1.3
См. также:
SOAPFault.setFaultCode(javax.xml.soap.Name), SOAPFault.setFaultString(java.lang.String), addFault(Name faultCode, String faultString)

hasFault

boolean hasFault()

Указывает, существует ли объект SOAPFault в этом объекте SOAPBody.

Возвращает:
true если объект SOAPFault существует в этом объекте SOAPBody; false в противном случае

getFault

SOAPFault getFault()

Возвращает объект SOAPFault в этом объекте SOAPBody.

Возвращает:
объект SOAPFault в этом объекте SOAPBody при наличии, иначе null.

addBodyElement

SOAPBodyElement addBodyElement(Name name)
                        throws SOAPException

Создаёт новый объект SOAPBodyElement с указанным именем и добавляет его в этот объект SOAPBody.

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

addBodyElement

SOAPBodyElement addBodyElement(QName qname)
                        throws SOAPException

Создаёт новый объект SOAPBodyElement с указанным QName и добавляет его в этот объект SOAPBody.

Параметры:
qname - объект QName с qname для нового объекта SOAPBodyElement
Возвращает:
новый объект SOAPBodyElement
Изволяет:
SOAPException - если произошла ошибка SOAP
С момента:
SAAJ 1.3
См. также:
addBodyElement(Name)

addDocument

SOAPBodyElement addDocument(Document document)
                     throws SOAPException

Добавляет корневой узел DOM-документа Document в этот объект SOAPBody.

Вызов этого метода делает параметр document недействительным. Приложение-клиент должно удалить все ссылки на этот объект Document и его содержимое после вызова addDocument. Поведение приложения, которое продолжает использовать такие ссылки, не определено.

Параметры:
document - объект Document, корневой узел которого будет добавлен в этот объект SOAPBody.
Возвращает:
объект SOAPBodyElement, представляющий добавленный корневой узел.
Изволяет:
SOAPException - если Document не может быть добавлен
С момента:
SAAJ 1.2

extractContentAsDocument

Document extractContentAsDocument()
                           throws SOAPException

Создаёт новый DOM-документ Document и устанавливает первый дочерний элемент этого объекта SOAPBody в качестве его корневого элемента. Дочерний элемент SOAPElement удаляется в ходе этого процесса.

Возвращает:
представление Document содержимого SOAPBody.
Исключения:
SOAPException - если нет ровно одного дочернего элемента SOAPElement у SOAPBody.
С:
SAAJ 1.3

© 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.

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API