SOAPFault (Java Platform SE 8 )

All Superinterfaces:

Element， Node， SOAPBodyElement， SOAPElement
```
public interface SOAPFault
extends SOAPBodyElement
```
在包含错误和/或状态信息的 SOAPBody对象元素。这些信息可能涉及到在 SOAPMessage对象或不在消息本身的内容相关问题的错误。与消息本身无关的问题通常是处理过程中的错误，如无法与上游服务器进行通信的错误。
根据指定在创建MessageFactory实例的protocol，一SOAPFault有子元素，如SOAP 1.2规范定义1.1/soap。

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`对象并设置为这个 `SOAPFault`对象的 `Detail`对象。
`void`	`addFaultReasonText(String text, Locale locale)` 添加或替换一个包含指定的文本消息和XML的原因：郎来自 `locale`文本项。
`void`	`appendFaultSubcode(QName subcode)` 增加了一个码的码序列结束的这 `SOAPFault`包含。
`Detail`	`getDetail()` 返回该对象的详细 `SOAPFault`可选元素。
`String`	`getFaultActor()` 获取此 `SOAPFault`对象故障的演员。
`String`	`getFaultCode()` 获取此 `SOAPFault`对象故障代码。
`Name`	`getFaultCodeAsName()` 获取此 `SOAPFault`对象强制肥皂1.1故障代码为SAAJ `Name`对象。
`QName`	`getFaultCodeAsQName()` 获取此 `SOAPFault`对象的故障代码为 `QName`对象。
`String`	`getFaultNode()` 返回该对象的 `SOAPFault`可选节点元素值。
`Iterator`	`getFaultReasonLocales()` 返回一个 `Iterator`在不同的 `Locale`s序列有相关的原因的文本项。
`String`	`getFaultReasonText(Locale locale)` 返回与给定的 `Locale`相关原因的文本。
`Iterator`	`getFaultReasonTexts()` 返回序列上 `String`对象包含所有这 `SOAPFault`原因的文本项 `Iterator`。
`String`	`getFaultRole()` 返回该对象的作用 `SOAPFault`可选元素值。
`String`	`getFaultString()` 获取此 `SOAPFault`对象错误字符串。
`Locale`	`getFaultStringLocale()` 得到这个 `SOAPFault`对象错误字符串的区域。
`Iterator`	`getFaultSubcodes()` 获取此 `SOAPFault`得到过 `QNames`迭代器。
`boolean`	`hasDetail()` 如果这 `SOAPFault`有 `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`对象给定字符串定位到特定地点错误字符串。

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对象集。
    故障代码，它提供有关故障的信息，在肥皂1.1规范中定义。故障代码是强制性的，必须是类型Name。该方法提供了一种方便的方法来设置故障代码。例如,
```
soapenvelope SE =…；/ /在LocalName SOAP命名空间创建一个合格的名字“客户”。请注意，前缀参数是可选的，并且是空的在这里使用适当的前缀的实现。名称属性= SE。createname（“客户”，空，soapconstants uri_ns_soap_envelope）；SoapFault故障=…；故障setfaultcode（12）；
```
    最好使用这种方法在 setFaultCode(String)。
    参数
    
    faultCodeQName - Name对象给出故障代码进行设置。它必须是命名空间限定的。
    
    异常
    
    SOAPException如果加入故障代码元至底层的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对象集。
    故障代码，它给出了关于故障的信息，在肥皂1.1规范中定义。此元素在肥皂1.1中是强制性的。因为需要一个QName最好使用这种方法的setFaultCode(Name)形式是故障代码。
    
    参数
    
    faultCode - String给出故障代码进行设置。它必须是形式的前缀：LocalName”前缀已在命名空间中定义。
    
    异常
    
    SOAPException如果加入 faultCode至底层的XML树中有一个错误。
    
    另请参见：
    
    setFaultCode(Name)， getFaultCode()， SOAPElement.addNamespaceDeclaration(java.lang.String, java.lang.String)
  - getFaultCodeAsName
```
Name getFaultCodeAsName()
```
    获取此 SOAPFault对象强制肥皂1.1故障代码为SAAJ Name对象。SOAP 1.1规范要求的“错误代码”元素的值的类型是12。此方法返回该元素的内容作为一个QName中形成了saaj名字对象。这种方法应该是因为它允许应用程序很容易地访问命名空间的名称而无需额外的分析代替了 getFaultCode方法。
    
    结果
    
    一个 Name代表故障代码
    
    从以下版本开始：
    
    SAAJ 1.2
    
    另请参见：
    
    setFaultCode(Name)
  - getFaultCodeAsQName
```
QName getFaultCodeAsQName()
```
    获取此 SOAPFault对象的故障代码为 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包含任何子。随后调用 getFaultSubcodes直到调用 appendFaultSubcode由迭代器返回一个空。
    
    异常
    
    UnsupportedOperationException -如果这消息不支持SOAP 1.2概念方法。
    
    从以下版本开始：
    
    SAAJ 1.3
  - appendFaultSubcode
```
void appendFaultSubcode(QName subcode)
                 throws SOAPException
```
    增加了一个码的码序列结束的这 SOAPFault包含。码，其中介绍了在SOAP 1.2，由植根于SOAP错误代码元素的子元素强制递归序列表示。
    
    参数
    
    subcode - 12包含代码的价值。
    
    异常
    
    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 - String识别导致 SOAPFault对象的演员
    
    异常
    
    SOAPException如果加入 faultActor至底层的XML树中有一个错误。
    
    另请参见：
    
    getFaultActor()
  - getFaultActor
```
String getFaultActor()
```
    获取此 SOAPFault对象故障的演员。
    如果这SOAPFault支持SOAP 1.2这个电话相当于getFaultRole()
    
    结果
    
    一个 String导致这 SOAPFault对象信息路径给演员
    
    另请参见：
    
    setFaultActor(java.lang.String)
  - setFaultString
```
void setFaultString(String faultString)
             throws SOAPException
```
    设置此 SOAPFault对象给定字符串错误字符串。
    如果这SOAPFault部分消息支持SOAP 1.2这个电话是等价的：
```
addfaultreasontext（faultstring，现场。getdefault()）；
```
    参数
    
    faultString - String给出故障解释
    
    异常
    
    SOAPException如果加入 faultString至底层的XML树中有一个错误。
    
    另请参见：
    
    getFaultString()
  - setFaultString
```
void setFaultString(String faultString,
                    Locale locale)
             throws SOAPException
```
    设置此 SOAPFault对象给定字符串定位到特定地点错误字符串。
    如果这SOAPFault部分消息支持SOAP 1.2这个电话是等价的：
```
addfaultreasontext（faultstring，现场）；
```
    参数
    
    faultString - String给出故障解释
    
    locale - Locale对象表示的 faultString母语
    
    异常
    
    SOAPException如果加入 faultString至底层的XML树中有一个错误。
    
    从以下版本开始：
    
    SAAJ 1.2
    
    另请参见：
    
    getFaultString()
  - getFaultString
```
String getFaultString()
```
    获取此 SOAPFault对象错误字符串。
    如果这SOAPFault部分消息支持SOAP 1.2这个电话是等价的：
```
字符串原因=空；尝试{原因=（字符串）getfaultreasontexts()。next()；} catch（soapexception e）{ }退货原因；
```
    结果
    
    一个 String给出故障解释
    
    另请参见：
    
    setFaultString(String)， setFaultString(String, Locale)
  - getFaultStringLocale
```
Locale getFaultStringLocale()
```
    得到这个 SOAPFault对象错误字符串的区域。
    如果这SOAPFault部分消息支持SOAP 1.2这个电话是等价的：
```
区域设置区域设置；尝试{现场getfaultreasonlocales() next() =（现场）；} catch（soapexception e）{ }返回现场；
```
    结果
    
    一个 Locale对象指示错误字符串或 null母语如果没有指定地点
    
    从以下版本开始：
    
    SAAJ 1.2
    
    另请参见：
    
    setFaultString(String, Locale)
  - hasDetail
```
boolean hasDetail()
```
    如果这 SOAPFault有 Detail子元素，返回“真”。相当于 (getDetail()!=null)。
    
    结果
    
    如果这 SOAPFault有 Detail子元素否则为假。
    
    从以下版本开始：
    
    SAAJ 1.3
  - getDetail
```
Detail getDetail()
```
    返回该对象的详细 SOAPFault可选元素。
    一个Detail对象进行应用程序特定的错误信息，错误的信息的范围被限制在SOAPBodyElement对象故障，如果这是一个SOAP 1.1故障。
    
    结果
    
    一个应用程序特定的错误信息，如果目前的 Detail对象，否则无效
  - addDetail
```
Detail addDetail()
          throws SOAPException
```
    创建一个可选的 Detail对象并设置为这个 SOAPFault对象的 Detail对象。
    在故障已经包含一个详细的细节时，添加一个细节是非法的。因此，这种方法应该被称为只有在现有的细节已被删除。
    
    结果
    
    新 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
```
    返回序列上 String对象包含所有这 SOAPFault原因的文本项 Iterator。
    
    结果
    
    在环境的 Iterator：故障/环境/环境：原因：文本项。
    
    异常
    
    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的原因：郎来自 locale文本项。如果这个XML的原因：郎文本项已经存在的文本值将被替换为 text， locale参数不应 null
    代码示例：
```
SoapFault故障=…；故障。addfaultreasontext（“版本不匹配”，现场。英语）；
```
    参数
    
    text ---原因消息字符串
    
    locale --- locale对象表示消息的现场
    
    异常
    
    SOAPException -如果有一个错误在增加的原因是 null通过文字或 locale。
    
    UnsupportedOperationException -如果这消息不支持SOAP 1.2概念的故障原因。
    
    从以下版本开始：
    
    SAAJ 1.3
  - getFaultNode
```
String getFaultNode()
```
    返回该对象的 SOAPFault可选节点元素值。在“1.2”中的节点元素是可选的。
    
    结果
    
    的环境内容：故障/环境：节点单元作为一个字符串或 null如果没有
    
    异常
    
    UnsupportedOperationException -如果这消息不支持SOAP 1.2概念Fault Node。
    
    从以下版本开始：
    
    SAAJ 1.3
  - setFaultNode
```
void setFaultNode(String uri)
           throws SOAPException
```
    创建或替换任何现有的节点元素值这个 SOAPFault对象。在“1.2”中的节点元素是可选的。
    
    异常
    
    SOAPException -如果设置节点的这 SOAPFault对象中有一个错误。
    
    UnsupportedOperationException -如果这消息不支持SOAP 1.2概念Fault Node。
    
    从以下版本开始：
    
    SAAJ 1.3
  - getFaultRole
```
String getFaultRole()
```
    返回该对象的作用 SOAPFault可选元素值。在肥皂1.2中的角色元素是可选的。
    
    结果
    
    的环境内容：故障/环境：作为一个字符串或 null如果没有作用的元素
    
    异常
    
    UnsupportedOperationException -如果这消息不支持SOAP 1.2系统概念的作用。
    
    从以下版本开始：
    
    SAAJ 1.3
  - setFaultRole
```
void setFaultRole(String uri)
           throws SOAPException
```
    创建或替换任何现有的角色元素值这个 SOAPFault对象。在肥皂1.2中的角色元素是可选的。
    
    参数
    
    uri -角色的URI
    
    异常
    
    SOAPException -如果在设定本 SOAPFault对象的角色中有一个错误。
    
    UnsupportedOperationException -如果这消息不支持SOAP 1.2系统概念的作用。
    
    从以下版本开始：
    
    SAAJ 1.3

Submit a bug or feature
For further API reference and developer documentation, see Java SE Documentation. That documentation contains more detailed, developer-targeted descriptions, with conceptual overviews, definitions of terms, workarounds, and working code examples.
Copyright © 1993, 2014, Oracle and/or its affiliates. All rights reserved.

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