SOAPFault (Java Platform SE 8 )

All Superinterfaces:

Element ， Node ， SOAPBodyElement ， SOAPElement
```
public interface SOAPFault
extends SOAPBodyElement
```
SOAPBody对象中包含错误和/或状态信息的元素。该信息可能与SOAPMessage对象中的错误或与消息本身内容无关的问题有关。与消息本身无关的问题通常是处理中的错误，例如不能与上游服务器进行通信。
取决于protocol而创建指定MessageFactory例如， SOAPFault具有如在SOAP 1.1 / SOAP 1.2规范中定义的子元素。

Field Summary
- Fields inherited from interface 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

方法摘要

所有方法接口方法抽象方法
Modifier and Type	Method and Description
`Detail`	`addDetail()` 创建可选的 `Detail`对象，并将其设置为 `Detail`对象的 `SOAPFault`对象。
`void`	`addFaultReasonText(String text, Locale locale)` 追加或替换包含指定文本消息的原因文本项和从 `locale`派生的 xml：lang 。
`void`	`appendFaultSubcode(QName subcode)` 在此 `SOAPFault`包含的子代码序列的末尾添加一个子代码。
`Detail`	`getDetail()` 返回此 `SOAPFault`对象的可选detail元素。
`String`	`getFaultActor()` 获取此 `SOAPFault`对象的故障演员。
`String`	`getFaultCode()` 获取此 `SOAPFault`对象的故障代码。
`Name`	`getFaultCodeAsName()` 获取此 `SOAPFault`对象的强制SOAP 1.1故障代码作为SAAJ `Name`对象。
`QName`	`getFaultCodeAsQName()` 获取此 `SOAPFault`对象的故障代码作为 `QName`对象。
`String`	`getFaultNode()` 返回此 `SOAPFault`对象的可选Node元素值。
`Iterator`	`getFaultReasonLocales()` 在 `Iterator`的不同序列上 `Locale` ，其中有相关的原因文本项。
`String`	`getFaultReasonText(Locale locale)` 返回与给定 `Locale`的原因文本。
`Iterator`	`getFaultReasonTexts()` 返回 `Iterator`的序列 `String`对象，其中包含此 `SOAPFault`所有原因文本项。
`String`	`getFaultRole()` 返回此 `SOAPFault`对象的可选Role元素值。
`String`	`getFaultString()` 获取此 `SOAPFault`对象的故障字符串。
`Locale`	`getFaultStringLocale()` 获取此 `SOAPFault`对象的故障字符串的区域设置。
`Iterator`	`getFaultSubcodes()` 获取此子码 `SOAPFault`为在一个迭代 `QNames` 。
`boolean`	`hasDetail()` 如果这个 `SOAPFault`有一个 `Detail`子元素，则返回true，否则返回false。
`void`	`removeAllFaultSubcodes()` 删除此 `SOAPFault`可能包含的任何子 `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`对象的任何现有Node元素值。
`void`	`setFaultRole(String uri)` 创建或替换此 `SOAPFault`对象的任何现有Role元素值。
`void`	`setFaultString(String faultString)` 将此 `SOAPFault`对象的故障字符串设置为给定的字符串。
`void`	`setFaultString(String faultString, Locale locale)` 将此 `SOAPFault`对象的故障字符串设置为给定的字符串，并将其定位到给定的区域设置。

Methods inherited from interface javax.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue

Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getSchemaTypeInfo, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from interface 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

- 方法详细信息
  - 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 - 给出要设置的故障代码的Name对象。它必须是命名空间限定的。
    
    异常
    
    SOAPException - 如果将 faultcode元素添加到底层XML树中有错误。
    
    从以下版本开始：
    
    SAAJ 1.2
    
    另请参见：
    
    getFaultCodeAsName()
  - setFaultCode
```
void setFaultCode(QName faultCodeQName)
           throws SOAPException
```
    使用给定的故障代码设置此SOAPFault对象。最好使用这种方法超过setFaultCode(Name) 。
    
    参数
    
    faultCodeQName - 一个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 - 一个String给出要设置的故障代码。它必须是前缀在命名空间声明中定义的形式“prefix：localName”。
    
    异常
    
    SOAPException - 如果将 faultCode添加到底层XML树中有错误。
    
    另请参见：
    
    setFaultCode(Name) ， getFaultCode() ， SOAPElement.addNamespaceDeclaration(java.lang.String, java.lang.String)
  - getFaultCodeAsName
```
Name getFaultCodeAsName()
```
    获取此SOAPFault对象的强制性SOAP 1.1故障代码作为SAAJ Name对象。 SOAP 1.1规范要求“faultcode”元素的值为QName类型。此方法以SAAJ Name对象的形式将元素的内容作为QName返回。应使用此方法代替getFaultCode方法，因为它允许应用程序轻松访问命名空间名称，无需额外的解析。
    
    结果
    
    一个 Name故障码的Name
    
    从以下版本开始：
    
    SAAJ 1.2
    
    另请参见：
    
    setFaultCode(Name)
  - getFaultCodeAsQName
```
QName getFaultCodeAsQName()
```
    获取此 SOAPFault对象的故障代码作为 QName对象。
    
    结果
    
    一个 QName故障码的QName
    
    从以下版本开始：
    
    SAAJ 1.3
    
    另请参见：
    
    setFaultCode(QName)
  - getFaultSubcodes
```
Iterator getFaultSubcodes()
```
    获取此子码 SOAPFault为在一个迭代 QNames 。
    
    结果
    
    一个Iterator访问的序列QNames 。这Iterator不应该支持可选的remove方法。子代码的返回顺序反映了从上到下的故障中存在的子代码的层次结构。
    
    异常
    
    UnsupportedOperationException - 如果此消息不支持SOAP 1.2子代码概念。
    
    从以下版本开始：
    
    SAAJ 1.3
  - removeAllFaultSubcodes
```
void removeAllFaultSubcodes()
```
    删除此SOAPFault可能包含的任何子SOAPFault 。随后呼叫getFaultSubcodes直到通话将返回一个空迭代appendFaultSubcode而成。
    
    异常
    
    UnsupportedOperationException - 如果此消息不支持SOAP 1.2概念的子代码。
    
    从以下版本开始：
    
    SAAJ 1.3
  - appendFaultSubcode
```
void appendFaultSubcode(QName subcode)
                 throws SOAPException
```
    在此SOAPFault包含的子代码序列的末尾添加一个子代码。在SOAP 1.2中引入的子代码由基于SOAP Fault的强制代码子元素的子元素的递归序列表示。
    
    参数
    
    subcode - 包含子代码值的QName。
    
    异常
    
    SOAPException - 如果设置子代码时出现错误
    
    UnsupportedOperationException - 如果此消息不支持SOAP 1.2子代码概念。
    
    从以下版本开始：
    
    SAAJ 1.3
  - getFaultCode
```
String getFaultCode()
```
    获取此 SOAPFault对象的故障代码。
    
    结果
    
    一个 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()
    
    结果
    
    一个 String给导致这个 SOAPFault对象的消息路径中的actor
    
    另请参见：
    
    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 -一个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; 
```
    结果
    
    一个 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; 
```
    结果
    
    一个 Locale表示的错误字符串或的本机语言对象 null如果没有指定的区域设置
    
    从以下版本开始：
    
    SAAJ 1.2
    
    另请参见：
    
    setFaultString(String, Locale)
  - hasDetail
```
boolean hasDetail()
```
    如果SOAPFault有一个Detail子元素，则返回true，否则返回false。相当于(getDetail()!=null) 。
    
    结果
    
    如果这个 SOAPFault有一个 Detail子元素，则为true，否则为false。
    
    从以下版本开始：
    
    SAAJ 1.3
  - getDetail
```
Detail getDetail()
```
    返回此SOAPFault对象的可选detail元素。
    Detail对象携带应用程序特定的错误信息，如果这是SOAP 1.1 Fault，则错误信息的范围仅限于SOAPBodyElement对象中的故障。
    
    结果
    
    一个 Detail对象，如果存在应用程序特定的错误信息，否则为空
  - addDetail
```
Detail addDetail()
          throws SOAPException
```
    创建可选的Detail对象，并将其设置为Detail对象的SOAPFault对象。
    当故障已包含详细信息时，添加详细信息是非法的。因此，只有在删除现有的细节之后才应该调用此方法。
    
    结果
    
    新的 Detail对象
    
    异常
    
    SOAPException - 如果此 SOAPFault对象已经包含有效的 Detail对象
  - getFaultReasonLocales
```
Iterator getFaultReasonLocales()
                        throws SOAPException
```
    在Iterator的不同序列上Locale ，其中有相关的原因文本项。这些Locale的任何一个可以用于调用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 items。
    
    异常
    
    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
```
    追加或替换包含指定短信的原因文本项目和从locale派生的xml：lang 。如果具有此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对象的可选Node元素值。 Node元素在SOAP 1.2中是可选的。
    
    结果
    
    env：Fault / env：Node元素作为字符串的 null如果没有， null
    
    异常
    
    UnsupportedOperationException - 如果此消息不支持故障节点的SOAP 1.2概念。
    
    从以下版本开始：
    
    SAAJ 1.3
  - setFaultNode
```
void setFaultNode(String uri)
           throws SOAPException
```
    创建或替换此SOAPFault对象的任何现有Node元素值。 Node元素在SOAP 1.2中是可选的。
    
    异常
    
    SOAPException - 如果为此 SOAPFault对象设置节点时 SOAPFault 。
    
    UnsupportedOperationException - 如果此消息不支持故障节点的SOAP 1.2概念。
    
    从以下版本开始：
    
    SAAJ 1.3
  - getFaultRole
```
String getFaultRole()
```
    返回此SOAPFault对象的可选Role元素值。 Role元素在SOAP 1.2中是可选的。
    
    结果
    
    env的内容：Fault / env：角色元素作为字符串或 null如果没有）
    
    异常
    
    UnsupportedOperationException - 如果此消息不支持SOAP 1.2概念的故障角色。
    
    从以下版本开始：
    
    SAAJ 1.3
  - setFaultRole
```
void setFaultRole(String uri)
           throws SOAPException
```
    创建或替换此SOAPFault对象的任何现有Role元素值。 Role元素在SOAP 1.2中是可选的。
    
    参数
    
    uri - - 角色的URI
    
    异常
    
    SOAPException - 如果设置此 SOAPFault对象的角色有错误。
    
    UnsupportedOperationException - 如果此消息不支持“故障角色”的SOAP 1.2概念。
    
    从以下版本开始：
    
    SAAJ 1.3

Interface SOAPFault

Field Summary

Fields inherited from interface org.w3c.dom.Node

方法摘要

Methods inherited from interface javax.xml.soap.SOAPElement

Methods inherited from interface javax.xml.soap.Node

Methods inherited from interface org.w3c.dom.Element

Methods inherited from interface org.w3c.dom.Node

方法详细信息

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