-
- All Superinterfaces:
-
Element
,Node
,Node
,SOAPBodyElement
,SOAPElement
public interface SOAPFault extends SOAPBodyElement
SOAPBody
对象中包含错误和/或状态信息的元素。 该信息可能与SOAPMessage
对象中的错误或与消息本身内容无关的问题有关。 与消息本身无关的问题通常是处理中的错误,例如不能与上游服务器进行通信。取决于
protocol
而创建指定MessageFactory
例如,SOAPFault
具有如在SOAP 1.1 / SOAP 1.2规范中定义的子元素。- 从以下版本开始:
- 1.6
-
-
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 方法 描述 Detail
addDetail()
创建一个可选的Detail
对象,并将其设置为Detail
对象的SOAPFault
对象。void
addFaultReasonText(String text, Locale locale)
追加或替换包含指定短信的原因文本项目和从locale
派生的 xml:lang 。void
appendFaultSubcode(QName subcode)
在此SOAPFault
包含的子代码序列的末尾添加一个子SOAPFault
。Detail
getDetail()
返回此SOAPFault
对象的可选detail元素。String
getFaultActor()
获取此SOAPFault
对象的故障演员。String
getFaultCode()
获取此SOAPFault
对象的故障代码。Name
getFaultCodeAsName()
获取此SOAPFault
对象的必需SOAP 1.1故障代码作为SAAJName
对象。QName
getFaultCodeAsQName()
获取此SOAPFault
对象的故障代码,作为QName
对象。String
getFaultNode()
返回此SOAPFault
对象的可选Node元素值。Iterator<Locale>
getFaultReasonLocales()
返回一个Iterator
了独特序列Locale
对此有关联Reason Text项秒。String
getFaultReasonText(Locale locale)
返回与给定的Locale
关联的原因文本。Iterator<String>
getFaultReasonTexts()
在String
对象中返回Iterator
,该对象包含此SOAPFault
所有原因文本项。String
getFaultRole()
返回此SOAPFault
对象的可选Role元素值。String
getFaultString()
获取此SOAPFault
对象的故障字符串。Locale
getFaultStringLocale()
获取此SOAPFault
对象的故障字符串的区域设置。Iterator<QName>
getFaultSubcodes()
获取SOAPFault的子SOAPFault
作为迭代器超过QNames
。boolean
hasDetail()
如果这个SOAPFault
有一个Detail
子元素,则返回true,否则返回false。void
removeAllFaultSubcodes()
删除此SOAPFault
可能包含的SOAPFault
。void
setFaultActor(String faultActor)
使用给定的故障演员设置此SOAPFault
对象。void
setFaultCode(String faultCode)
使用给定故障代码设置此SOAPFault
对象。void
setFaultCode(QName faultCodeQName)
使用给定的故障代码设置此SOAPFault
对象。void
setFaultCode(Name faultCodeQName)
使用给定的故障代码设置此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 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 javax.xml.soap.Node
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
-
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
-
Methods inherited from interface 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
-
-
-
-
方法详细信息
-
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树中有错误。 - 从以下版本开始:
- 1.6,SAAJ 1.2
- 另请参见:
-
getFaultCodeAsName()
-
setFaultCode
void setFaultCode(QName faultCodeQName) throws SOAPException
使用给定的故障代码设置此SOAPFault
对象。 最好使用这种方法超过setFaultCode(Name)
。- 参数
-
faultCodeQName
- 给出要设置故障代码的QName
对象。 它必须是命名空间限定的。 - 异常
-
SOAPException
- 如果将faultcode
元素添加到底层XML树中有错误。 - 从以下版本开始:
- 1.6,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故障代码作为SAAJName
对象。 SOAP 1.1规范要求“faultcode”元素的值为QName类型。 此方法以SAAJ Name对象的形式将元素的内容作为QName返回。 应该使用这种方法来代替getFaultCode
方法,因为它允许应用程序轻松访问命名空间名称,而无需额外的解析。- 结果
-
一个表示
Name
- 从以下版本开始:
- 1.6,SAAJ 1.2
- 另请参见:
-
setFaultCode(Name)
-
getFaultCodeAsQName
QName getFaultCodeAsQName()
获取此SOAPFault
对象的故障代码作为QName
对象。- 结果
-
一个
QName
代表QName
代码 - 从以下版本开始:
- 1.6,SAAJ 1.3
- 另请参见:
-
setFaultCode(QName)
-
getFaultSubcodes
Iterator<QName> getFaultSubcodes()
获取SOAPFault的子SOAPFault
作为迭代器超过QNames
。- 结果
-
一个
Iterator
访问的序列QNames
。 这个Iterator
不应该支持可选的remove
方法。 子代码的返回顺序反映了从上到下的故障中存在的子代码的层次结构。 - 异常
-
UnsupportedOperationException
- 如果此消息不支持SOAP 1.2的子代码概念。 - 从以下版本开始:
- 1.6,SAAJ 1.3
-
removeAllFaultSubcodes
void removeAllFaultSubcodes()
删除此SOAPFault
可能包含的SOAPFault
。 对getFaultSubcodes
后续调用将返回一个空的迭代器,直到调用appendFaultSubcode
为止。- 异常
-
UnsupportedOperationException
- 如果此消息不支持SOAP 1.2概念的子代码。 - 从以下版本开始:
- 1.6,SAAJ 1.3
-
appendFaultSubcode
void appendFaultSubcode(QName subcode) throws SOAPException
将子代码添加到此SOAPFault所包含的子代码序列的SOAPFault
。 在SOAP 1.2中引入的子代码由基于SOAP Fault的强制代码子元素的子元素的递归序列表示。- 参数
-
subcode
- 包含子代码值的QName。 - 异常
-
SOAPException
- 如果设置子代码时出错 -
UnsupportedOperationException
- 如果此消息不支持SOAP 1.2概念的子代码。 - 从以下版本开始:
- 1.6,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
- aString
识别导致该SOAPFault
对象的演员 - 异常
-
SOAPException
- 如果将faultActor
添加到底层XML树中有错误。 - 另请参见:
-
getFaultActor()
-
getFaultActor
String getFaultActor()
获取此SOAPFault
对象的故障演员。如果这个
SOAPFault
支持SOAP 1.2,那么这个调用相当于getFaultRole()
- 结果
-
一个
String
给导致这个SOAPFault
对象的消息路径中的SOAPFault
- 另请参见:
-
setFaultActor(java.lang.String)
-
setFaultString
void setFaultString(String faultString) throws SOAPException
将此SOAPFault
对象的故障字符串设置为给定的字符串。如果这个
SOAPFault
是支持SOAP 1.2的消息的一部分,那么这个调用相当于:addFaultReasonText(faultString, Locale.getDefault());
- 参数
-
faultString
- aString
给出了故障的解释 - 异常
-
SOAPException
- 如果将faultString
添加到底层XML树中有错误。 - 另请参见:
-
getFaultString()
-
setFaultString
void setFaultString(String faultString, Locale locale) throws SOAPException
将此SOAPFault
对象的故障字符串设置为给定的字符串,并将其定位到给定的区域设置。如果这个
SOAPFault
是支持SOAP 1.2的消息的一部分,则此调用等同于:addFaultReasonText(faultString, locale);
- 参数
-
faultString
- aString
给出了故障的解释 -
locale
-一个Locale
对象,指示的母语faultString
- 异常
-
SOAPException
- 如果将faultString
添加到底层XML树中有错误。 - 从以下版本开始:
- 1.6,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
- 从以下版本开始:
- 1.6,SAAJ 1.2
- 另请参见:
-
setFaultString(String, Locale)
-
hasDetail
boolean hasDetail()
如果这个SOAPFault
有一个Detail
子元素,则返回true,否则返回false。 相当于(getDetail()!=null)
。- 结果
-
如果这个
SOAPFault
有一个Detail
子元素,Detail
true,否则为false。 - 从以下版本开始:
- 1.6,SAAJ 1.3
-
getDetail
Detail getDetail()
返回此SOAPFault
对象的可选detail元素。一个
Detail
对象携带应用程序特定的错误信息,如果这是一个SOAP 1.1故障,则错误信息的范围仅限于SOAPBodyElement
对象中的故障。- 结果
-
一个
Detail
对象,如果存在应用程序特定的错误信息,否则为空
-
addDetail
Detail addDetail() throws SOAPException
创建可选的Detail
对象,并将其设置为Detail
对象的SOAPFault
对象。当故障已包含详细信息时,添加详细信息是非法的。 因此,只有在删除现有的细节之后才应该调用此方法。
- 结果
-
新的
Detail
对象 - 异常
-
SOAPException
- 如果此SOAPFault
对象已包含有效的Detail
对象
-
getFaultReasonLocales
Iterator<Locale> getFaultReasonLocales() throws SOAPException
返回一个Iterator
了独特序列Locale
对此有关联Reason Text项秒。 任何这些Locale
可用于调用getFaultReasonText
以获取本地化版本的原因文本字符串。- 结果
-
一个
Iterator
的Locale
对象,其中有相关的原因文本项目。 - 异常
-
SOAPException
- 如果在检索故障原因区域设置时出现错误。 -
UnsupportedOperationException
- 如果此消息不支持SOAP 1.2故障原因概念。 - 从以下版本开始:
- 1.6,SAAJ 1.3
-
getFaultReasonTexts
Iterator<String> getFaultReasonTexts() throws SOAPException
在String
对象序列中返回Iterator
,其中包含此SOAPFault
所有原因文本项。- 结果
-
一个
Iterator
在env:Fault / env:Reason / env:文本项目。 - 异常
-
SOAPException
- 如果在检索故障原因文本时出现错误。 -
UnsupportedOperationException
- 如果此消息不支持SOAP 1.2故障原因概念。 - 从以下版本开始:
- 1.6,SAAJ 1.3
-
getFaultReasonText
String getFaultReasonText(Locale locale) throws SOAPException
返回与给定的Locale
相关联的原因文本。 如果存在多个此类原因文本,则返回第一个匹配的文本- 参数
-
locale
- - 需要本地化原因文本的Locale
- 结果
-
与
locale
相关联的原因文本 - 异常
-
SOAPException
- 如果在检索故障原因文本中指定区域设置时出现错误。 -
UnsupportedOperationException
- 如果此消息不支持SOAP 1.2故障原因概念。 - 从以下版本开始:
- 1.6,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故障原因概念。 - 从以下版本开始:
- 1.6,SAAJ 1.3
-
getFaultNode
String getFaultNode()
返回此SOAPFault
对象的可选Node元素值。 Node元素在SOAP 1.2中是可选的。- 结果
-
env:Fault / env:Node元素作为字符串的
null
如果没有,null
- 异常
-
UnsupportedOperationException
- 如果此消息不支持故障节点的SOAP 1.2概念。 - 从以下版本开始:
- 1.6,SAAJ 1.3
-
setFaultNode
void setFaultNode(String uri) throws SOAPException
创建或替换此SOAPFault
对象的任何现有Node元素值。 Node元素在SOAP 1.2中是可选的。- 参数
-
uri
- - 节点的URI - 异常
-
SOAPException
- 如果为此SOAPFault
对象设置节点时SOAPFault
。 -
UnsupportedOperationException
- 如果此消息不支持故障节点的SOAP 1.2概念。 - 从以下版本开始:
- 1.6,SAAJ 1.3
-
getFaultRole
String getFaultRole()
返回此SOAPFault
对象的可选Role元素值。 Role元素在SOAP 1.2中是可选的。- 结果
-
env的内容:Fault / env:角色元素作为字符串或
null
如果没有) - 异常
-
UnsupportedOperationException
- 如果此消息不支持SOAP 1.2概念的故障角色。 - 从以下版本开始:
- 1.6,SAAJ 1.3
-
setFaultRole
void setFaultRole(String uri) throws SOAPException
创建或替换此SOAPFault
对象的任何现有Role元素值。 Role元素在SOAP 1.2中是可选的。- 参数
-
uri
- - 角色的URI - 异常
-
SOAPException
- 如果在设置此SOAPFault
对象的角色时SOAPFault
。 -
UnsupportedOperationException
- 如果此消息不支持SOAP 1.2概念的故障角色。 - 从以下版本开始:
- 1.6, SAAJ 1.3
-
-