javax.xml.soap

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

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

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

public interface SOAPBody
extends SOAPElement

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

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

См. Также:

SOAPFault

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

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

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

Методы

Модификатор и Тип	Метод и Описание
SOAPBodyElement	addBodyElement(Name name) Создает новое SOAPBodyElement объект с указанным именем и добавляет это к этому SOAPBody объект.
SOAPBodyElement	addBodyElement(QName qname) Создает новое SOAPBodyElement объект с указанным QName и добавляет это к этому SOAPBody объект.
SOAPBodyElement	addDocument(Document document) Добавляет корневой узел ДОМА 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 объект.
Документ	extractContentAsDocument() Создает нового ДОМА Document и устанавливает первый дочерний элемент этого SOAPBody поскольку это - элемент документа.
SOAPFault	getFault() Возвраты SOAPFault объект в этом SOAPBody объект.
boolean	hasFault() Указывает ли a 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. Узел

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

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

addFault

SOAPFault addFault()
                   throws SOAPException

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

A 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 параметр является значением элемента Отказа/Кода/Значения и faultString параметр является значением элемента Отказа/Причины/Текста. Для SOAP 1.1 faultCode параметр является значением faultcode элемент и faultString параметр является значением faultstring элемент.

A SOAPBody может содержать самое большее один SOAPFault дочерний элемент.

Параметры:

faultCode - a Name объект, дающий отказ, кодирует, чтобы быть установленным; должен быть один из кодов отказа, определенных в Версии спецификации SOAP в использовании

faultString - a String предоставление объяснения отказа

locale - a 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 параметр является значением элемента Отказа/Кода/Значения и faultString параметр является значением элемента Отказа/Причины/Текста. Для SOAP 1.1 faultCode параметр является значением faultcode элемент и faultString параметр является значением faultstring элемент.

A SOAPBody может содержать самое большее один SOAPFault дочерний элемент.

Параметры:

faultCode - a QName объект, дающий отказ, кодирует, чтобы быть установленным; должен быть один из кодов отказа, определенных в версии спецификации SOAP в использовании.

faultString - a String предоставление объяснения отказа

locale - a 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 параметр является значением элемента Отказа/Кода/Значения и faultString параметр является значением элемента Отказа/Причины/Текста. Для SOAP 1.1 faultCode параметр является значением faultcode элемента и faultString параметр является значением faultstring элемента.

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

A SOAPBody может содержать самое большее один SOAPFault дочерний элемент.

Параметры:

faultCode - a Name объект, дающий отказ, кодирует, чтобы быть установленным; должен быть один из кодов отказа, определенных в версии спецификации SOAP в использовании

faultString - a 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 параметр является значением элемента Отказа/Кода/Значения и faultString параметр является значением элемента Отказа/Причины/Текста. Для SOAP 1.1 faultCode параметр является значением faultcode элемента и faultString параметр является значением faultstring элемента.

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

A SOAPBody может содержать самое большее один SOAPFault дочерний элемент

Параметры:

faultCode - a QName объект, дающий отказ, кодирует, чтобы быть установленным; должен быть один из кодов отказа, определенных в версии спецификации SOAP в использовании

faultString - a 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()

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

Возвраты:

true если a SOAPFault объект существует в этом SOAPBody объект; false иначе

getFault

SOAPFault getFault()

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

Возвраты:

SOAPFault объект в этом SOAPBody возразите если существующий, нулевой иначе.

addBodyElement

SOAPBodyElement addBodyElement(Name name)
                               throws SOAPException

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

Параметры:

name - a Name объект с именем для нового SOAPBodyElement объект

Возвраты:

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

Броски:

SOAPException - если ошибка SOAP происходит

См. Также:

addBodyElement(javax.xml.namespace.QName)

addBodyElement

SOAPBodyElement addBodyElement(QName qname)
                               throws SOAPException

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

Параметры:

qname - a QName объект с qname для нового SOAPBodyElement объект

Возвраты:

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

Броски:

SOAPException - если ошибка SOAP происходит

С тех пор:

SAAJ 1.3

См. Также:

addBodyElement(Name)

addDocument

SOAPBodyElement addDocument(Document document)
                            throws SOAPException

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

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

Параметры:

document - Document возразите, чей корневой узел будет добавлен к этому SOAPBody.

Возвраты:

SOAPBodyElement это представляет корневой узел, который был добавлен.

Броски:

SOAPException - если Document не может быть добавлен

С тех пор:

SAAJ 1.2

extractContentAsDocument

Document extractContentAsDocument()
                                  throws SOAPException

Создает нового ДОМА Document и устанавливает первый дочерний элемент этого SOAPBody поскольку это - элемент документа. Дочерний элемент SOAPElement удаляется как часть процесса.

Возвраты:

Document представление SOAPBody контент.

Броски:

SOAPException - если нет точно одного дочернего элемента SOAPElement из SOAPBody.

Since:

SAAJ 1.3