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

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

Элемент, Узел, SOAPBodyElement, SOAPElement
```
public interface SOAPFault
extends SOAPBodyElement
```
Элемент в SOAPBody объект, который содержит ошибку и/или информацию о статусе. Эта информация может коснуться ошибок в SOAPMessage возразите или против проблем, которые не связываются с контентом в сообщении непосредственно. Проблемами, не связанными с самим сообщением, являются обычно ошибки в обработке, такие как неспособность связаться с вышестоящим сервером.
В зависимости от protocol определенный, создавая MessageFactory экземпляр, a SOAPFault имеет подэлементы как определено в SOAP 1.1/SOAP 1.2 спецификации.

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

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

Методы
Модификатор и Тип	Метод и Описание
`Деталь`	`addDetail()` Создает дополнительное `Detail` объект и наборы это как `Detail` объект для этого `SOAPFault` объект.
`void`	`addFaultReasonText(String text, Locale locale)` Добавляет или заменяет Причину текстовый элемент, содержащий указанное текстовое сообщение и xml:lang, полученный из `locale`.
`void`	`appendFaultSubcode(QName subcode)` Добавляет Подкод до конца последовательности Подкодов, содержавших этим `SOAPFault`.
`Деталь`	`getDetail()` Возвращает дополнительный элемент детали для этого `SOAPFault` объект.
`Строка`	`getFaultActor()` Получает агента отказа для этого `SOAPFault` объект.
`Строка`	`getFaultCode()` Получает код отказа для этого `SOAPFault` объект.
`Имя`	`getFaultCodeAsName()` Получает обязательный SOAP 1.1 кода отказа для этого `SOAPFault` возразите как SAAJ `Name` объект.
`QName`	`getFaultCodeAsQName()` Получает код отказа для этого `SOAPFault` возразите как a `QName` объект.
`Строка`	`getFaultNode()` Возвращает дополнительное значение элемента Узла для этого `SOAPFault` объект.
`Iterator`	`getFaultReasonLocales()` Возвраты `Iterator` по отличной последовательности `Locale`s, для которого там связываются Причина текстовые элементы.
`Строка`	`getFaultReasonText(Locale locale)` Возвращает Причину текст, связанный с данным `Locale`.
`Iterator`	`getFaultReasonTexts()` Возвраты `Iterator` по последовательности `String` объекты, содержащие всю Причину текстовые элементы для этого `SOAPFault`.
`Строка`	`getFaultRole()` Возвращает дополнительное Ролевое значение элемента для этого `SOAPFault` объект.
`Строка`	`getFaultString()` Получает строку отказа для этого `SOAPFault` объект.
`Локаль`	`getFaultStringLocale()` Получает локаль строки отказа для этого `SOAPFault` объект.
`Iterator`	`getFaultSubcodes()` Получает Подкоды для этого `SOAPFault` как iterator `QNames`.
`boolean`	`hasDetail()` Возвращает true если это `SOAPFault` имеет a `Detail` подэлемент и ложь иначе.
`void`	`removeAllFaultSubcodes()` Удаляет любые Подкоды, которые могут содержаться этим `SOAPFault`.
`void`	`setFaultActor(String faultActor)` Наборы это `SOAPFault` объект с данным агентом отказа.
`void`	`setFaultCode(Name faultCodeQName)` Наборы это `SOAPFault` объект с данным кодом отказа.
`void`	`setFaultCode(QName faultCodeQName)` Наборы это `SOAPFault` объект с данным кодом отказа.
`void`	`setFaultCode(String faultCode)` Наборы это `SOAPFault` объект с дать кодом отказа.
`void`	`setFaultNode(String uri)` Создает или заменяет любое существующее значение элемента Узла для этого `SOAPFault` объект.
`void`	`setFaultRole(String uri)` Создает или заменяет любое существующее Ролевое значение элемента для этого `SOAPFault` объект.
`void`	`setFaultString(String faultString)` Устанавливает строку отказа для этого `SOAPFault` возразите против данной строки.
`void`	`setFaultString(String faultString, Locale locale)` Устанавливает строку отказа для этого `SOAPFault` возразите против данной строки и локализованный к данной локали.

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

- Деталь метода
  - setFaultCode
```
void setFaultCode(Name faultCodeQName)
                  throws SOAPException
```
    Наборы это SOAPFault объект с данным кодом отказа.
    Коды отказа, которые дают информацию об отказе, определяются в SOAP 1.1 спецификации. Код отказа обязателен и должен иметь тип Name. Этот метод обеспечивает удобный способ установить код отказа. Например,
```
 SOAPEnvelope se = ...;
 // Create a qualified name in the SOAP namespace with a localName
 // of "Client". Note that prefix parameter is optional and is null
 // here which causes the implementation to use an appropriate prefix.
 Name qname = se.createName("Client", null,
                            SOAPConstants.URI_NS_SOAP_ENVELOPE);
 SOAPFault fault = ...;
 fault.setFaultCode(qname);
 
```
    Предпочтительно использовать этот метод setFaultCode(String).
    Параметры:
    faultCodeQName - a Name объект, дающий отказ, кодирует, чтобы быть установленным. Это должно быть квалифицированное пространство имен.
    
    Броски:
    
    SOAPException - если была ошибка в добавлении faultcode элемента к базовому дереву XML.
    С тех пор:
    
    SAAJ 1.2
    
    См. Также:
    getFaultCodeAsName()
  - setFaultCode
```
void setFaultCode(QName faultCodeQName)
                  throws SOAPException
```
    Наборы это SOAPFault объект с данным кодом отказа. Предпочтительно использовать этот метод setFaultCode(Name).
    
    Параметры:
    faultCodeQName - a QName объект, дающий отказ, кодирует, чтобы быть установленным. Это должно быть квалифицированное пространство имен.
    
    Броски:
    
    SOAPException - если была ошибка в добавлении faultcode элемент к базовому дереву XML.
    С тех пор:
    
    SAAJ 1.3
    
    См. Также:
    getFaultCodeAsQName(), setFaultCode(Name), getFaultCodeAsQName()
  - setFaultCode
```
void setFaultCode(String faultCode)
                  throws SOAPException
```
    Наборы это SOAPFault объект с дать кодом отказа.
    Коды отказа, который данный информацию об отказе, определяются в SOAP 1.1 спецификации. Этот элемент обязателен в SOAP 1.1. Поскольку код отказа обязан быть QName, предпочтительно использовать setFaultCode(Name) форма этого метода.
    
    Параметры:
    faultCode - a String предоставление отказа кодирует, чтобы быть установленным. Это должно иметь форму "prefix:localName", где префикс был определен в объявлении пространства имен.
    
    Броски:
    
    SOAPException - если была ошибка в добавлении faultCode к базовому дереву XML.
    См. Также:
    setFaultCode(Name), getFaultCode(), SOAPElement.addNamespaceDeclaration(java.lang.String, java.lang.String)
  - getFaultCodeAsName
```
Name getFaultCodeAsName()
```
    Получает обязательный SOAP 1.1 кода отказа для этого SOAPFault возразите как SAAJ Name объект. SOAP 1.1 спецификации требует, чтобы значение "faultcode" элемента имело тип QName. Этот метод возвращает контент элемента как QName в форме объекта Имени SAAJ. Этот метод должен использоваться вместо getFaultCode метод, так как это позволяет приложениям легко получать доступ к имени пространства имен без дополнительного парсинга.
    
    Возвраты:
    a Name представление faultcode
    С тех пор:
    
    SAAJ 1.2
    
    См. Также:
    setFaultCode(Name)
  - getFaultCodeAsQName
```
QName getFaultCodeAsQName()
```
    Получает код отказа для этого SOAPFault возразите как a QName объект.
    
    Возвраты:
    a QName представление faultcode
    С тех пор:
    
    SAAJ 1.3
    
    См. Также:
    setFaultCode(QName)
  - getFaultSubcodes
```
Iterator getFaultSubcodes()
```
    Получает Подкоды для этого SOAPFault как iterator QNames.
    
    Возвраты:
    Iterator это получает доступ к последовательности QNames. Это Iterator не должен поддерживать дополнительное remove метод. Порядок, в котором возвращаются Подкоды, отражает иерархию Подкодов, существующих в отказе сверху донизу.
    
    Броски:
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Подкода.
    С тех пор:
    
    SAAJ 1.3
  - removeAllFaultSubcodes
```
void removeAllFaultSubcodes()
```
    Удаляет любые Подкоды, которые могут содержаться этим SOAPFault. Последующие звонки getFaultSubcodes возвратит пустой iterator до звонка appendFaultSubcode делается.
    
    Броски:
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Подкода.
    С тех пор:
    
    SAAJ 1.3
  - appendFaultSubcode
```
void appendFaultSubcode(QName subcode)
                        throws SOAPException
```
    Добавляет Подкод до конца последовательности Подкодов, содержавших этим SOAPFault. Подкоды, которые были представлены в SOAP 1.2, представляются рекурсивной последовательностью подэлементов, базированных в обязательном подэлементе Кода Отказа SOAP.
    
    Параметры:
    subcode - QName, содержащий Значение Подкода.
    
    Броски:
    
    SOAPException - если была ошибка в установке Подкода
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Подкода.
    С тех пор:
    
    SAAJ 1.3
  - getFaultCode
```
String getFaultCode()
```
    Получает код отказа для этого SOAPFault объект.
    
    Возвраты:
    a String с кодом отказа
    См. Также:
    getFaultCodeAsName(), setFaultCode(javax.xml.soap.Name)
  - setFaultActor
```
void setFaultActor(String faultActor)
                   throws SOAPException
```
    Наборы это SOAPFault объект с данным агентом отказа.
    Агент отказа является получателем в пути сообщения, который заставил отказ происходить.
    Если это SOAPFault поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны setFaultRole(String)
    
    Параметры:
    faultActor - a String идентификация агента, который вызвал это SOAPFault объект
    
    Броски:
    
    SOAPException - если была ошибка в добавлении faultActor к базовому дереву XML.
    См. Также:
    getFaultActor()
  - getFaultActor
```
String getFaultActor()
```
    Получает агента отказа для этого SOAPFault объект.
    Если это SOAPFault поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны getFaultRole()
    
    Возвраты:
    a String предоставление агента в пути сообщения, который вызвал это SOAPFault объект
    См. Также:
    setFaultActor(java.lang.String)
  - setFaultString
```
void setFaultString(String faultString)
                    throws SOAPException
```
    Устанавливает строку отказа для этого SOAPFault возразите против данной строки.
    Если это SOAPFault часть сообщения, которое поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны:
```
      addFaultReasonText(faultString, Locale.getDefault());
 
```
    Параметры:
    faultString - a String предоставление объяснения отказа
    
    Броски:
    
    SOAPException - если была ошибка в добавлении faultString к базовому дереву XML.
    См. Также:
    getFaultString()
  - setFaultString
```
void setFaultString(String faultString,
                  Locale locale)
                    throws SOAPException
```
    Устанавливает строку отказа для этого SOAPFault возразите против данной строки и локализованный к данной локали.
    Если это SOAPFault часть сообщения, которое поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны:
```
      addFaultReasonText(faultString, locale);
 
```
    Параметры:
    faultString - a String предоставление объяснения отказа
    locale - a Locale объект, указывающий на родной язык faultString
    
    Броски:
    
    SOAPException - если была ошибка в добавлении faultString к базовому дереву XML.
    С тех пор:
    
    SAAJ 1.2
    
    См. Также:
    getFaultString()
  - getFaultString
```
String getFaultString()
```
    Получает строку отказа для этого SOAPFault объект.
    Если это SOAPFault часть сообщения, которое поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны:
```
    String reason = null;
    try {
        reason = (String) getFaultReasonTexts().next();
    } catch (SOAPException e) {}
    return reason;
 
```
    Возвраты:
    a String предоставление объяснения отказа
    См. Также:
    setFaultString(String), setFaultString(String, Locale)
  - getFaultStringLocale
```
Locale getFaultStringLocale()
```
    Получает локаль строки отказа для этого SOAPFault объект.
    Если это SOAPFault часть сообщения, которое поддерживает SOAP, которому 1.2 тогда этих вызова эквивалентны:
```
    Locale locale = null;
    try {
        locale = (Locale) getFaultReasonLocales().next();
    } catch (SOAPException e) {}
    return locale;
 
```
    Возвраты:
    a Locale объект, указывающий на родной язык строки отказа или null если никакая локаль не была определена
    С тех пор:
    
    SAAJ 1.2
    
    См. Также:
    setFaultString(String, Locale)
  - hasDetail
```
boolean hasDetail()
```
    Возвращает true если это SOAPFault имеет a Detail подэлемент и ложь иначе. Эквивалентный (getDetail()!=null).
    
    Возвраты:
    истина, если это SOAPFault имеет a Detail подэлемент и ложь иначе.
    С тех пор:
    
    SAAJ 1.3
  - getDetail
```
Detail getDetail()
```
    Возвращает дополнительный элемент детали для этого SOAPFault объект.
    A Detail возразите переносит специализированную информацию об ошибке, контекст информации об ошибке ограничивается отказам в SOAPBodyElement объекты, если это - SOAP 1.1 Отказа.
    
    Возвраты:
    a Detail объект со специализированной информацией об ошибке, если существующий, нулевой иначе
  - addDetail
```
Detail addDetail()
                 throws SOAPException
```
    Создает дополнительное Detail объект и наборы это как Detail объект для этого SOAPFault объект.
    Это недопустимо, чтобы добавить деталь, когда отказ уже содержит деталь. Поэтому, этот метод нужно вызвать только после того, как существующая деталь была удалена.
    
    Возвраты:
    новое Detail объект
    
    Броски:
    
    SOAPException - если это SOAPFault объект уже содержит допустимое Detail объект
  - getFaultReasonLocales
```
Iterator getFaultReasonLocales()
                               throws SOAPException
```
    Возвраты Iterator по отличной последовательности Locales, для которого там связываются Причина текстовые элементы. Любой из них Locales может использоваться в звонке getFaultReasonText чтобы получить локализованную версию Причины Текстовая строка.
    
    Возвраты:
    Iterator по последовательности Locale объекты, для которых там связываются Причина текстовые элементы.
    
    Броски:
    
    SOAPException - если была ошибка в получении Причины отказа локали.
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Причины Отказа.
    С тех пор:
    
    SAAJ 1.3
  - getFaultReasonTexts
```
Iterator getFaultReasonTexts()
                             throws SOAPException
```
    Возвраты Iterator по последовательности String объекты, содержащие всю Причину текстовые элементы для этого SOAPFault.
    
    Возвраты:
    Iterator по env:Fault/env:Reason/env:Text элементам.
    
    Броски:
    
    SOAPException - если была ошибка в получении Причины отказа тексты.
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Причины Отказа.
    С тех пор:
    
    SAAJ 1.3
  - getFaultReasonText
```
String getFaultReasonText(Locale locale)
                          throws SOAPException
```
    Возвращает Причину текст, связанный с данным Locale. Если больше чем одна такая Причина, текст существует первый текст соответствия, возвращается
    
    Параметры:
    locale - Locale для которого локализованная Причина требуется текст
    
    Возвраты:
    Причина текст, связанный с locale
    
    Броски:
    
    SOAPException - если была ошибка в получении Причины отказа текст для указанной локали.
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Причины Отказа.
    С тех пор:
    
    SAAJ 1.3
    
    См. Также:
    getFaultString()
  - addFaultReasonText
```
void addFaultReasonText(String text,
                      Locale locale)
                        throws SOAPException
```
    Добавляет или заменяет Причину текстовый элемент, содержащий указанное текстовое сообщение и xml:lang, полученный из locale. Если Причина, текстовый элемент с этим xml:lang уже существует свое текстовое значение, будет заменена text. locale параметр не должен быть null
    Пример кода:
```
 SOAPFault fault = ...;
 fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH);
 
```
    Параметры:
    text - рассуждают строка сообщения
    locale - Объект Локали представление локали сообщения
    
    Броски:
    
    SOAPException - если была ошибка в добавлении Причины текст или locale переданный был null.
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Причины Отказа.
    С тех пор:
    
    SAAJ 1.3
  - getFaultNode
```
String getFaultNode()
```
    Возвращает дополнительное значение элемента Узла для этого SOAPFault объект. Элемент Узла является дополнительным в SOAP 1.2.
    
    Возвраты:
    Контент env:Fault/env:Node элемента как Строка или null если ни один
    
    Броски:
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Узла Отказа.
    С тех пор:
    
    SAAJ 1.3
  - setFaultNode
```
void setFaultNode(String uri)
                  throws SOAPException
```
    Создает или заменяет любое существующее значение элемента Узла для этого SOAPFault объект. Элемент Узла является дополнительным в SOAP 1.2.
    
    Броски:
    
    SOAPException - если была ошибка в установке Узла для этого SOAPFault объект.
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Узла Отказа.
    С тех пор:
    
    SAAJ 1.3
  - getFaultRole
```
String getFaultRole()
```
    Возвращает дополнительное Ролевое значение элемента для этого SOAPFault объект. Ролевой элемент является дополнительным в SOAP 1.2.
    
    Возвраты:
    Контент env:Fault/env:Role элемента как Строка или null если ни один
    
    Броски:
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Роли Отказа.
    С тех пор:
    
    SAAJ 1.3
  - setFaultRole
```
void setFaultRole(String uri)
                  throws SOAPException
```
    Создает или заменяет любое существующее Ролевое значение элемента для этого SOAPFault объект. Ролевой элемент является дополнительным в SOAP 1.2.
    
    Параметры:
    uri - URI Роли
    
    Броски:
    
    SOAPException - если была ошибка в установке Роли для этого SOAPFault объект.
    
    UnsupportedOperationException - если это сообщение не поддерживает SOAP 1.2 понятия Роли Отказа.
    С тех пор:
    
    SAAJ 1.3

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

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

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

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

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

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

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

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

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

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

setFaultCode

setFaultCode

setFaultCode

getFaultCodeAsName

getFaultCodeAsQName

getFaultSubcodes

removeAllFaultSubcodes

appendFaultSubcode

getFaultCode

setFaultActor

getFaultActor

setFaultString

setFaultString

getFaultString

getFaultStringLocale

hasDetail

getDetail

addDetail

getFaultReasonLocales

getFaultReasonTexts

getFaultReasonText

addFaultReasonText

getFaultNode

setFaultNode

getFaultRole

setFaultRole