|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface SOAPFault
An element in the SOAPBody object that contains error and/or status information. This information may relate to errors in the SOAPMessage object or to problems that are not related to the content in the message itself. Problems not related to the message itself are generally errors in processing, such as the inability to communicate with an upstream server. The SOAPFault interface provides methods for retrieving the information contained in a SOAPFault object and for setting the fault code, the fault actor, and a string describing the fault. A fault code is one of the codes defined in the SOAP 1.1 specification that describe the fault. An actor is an intermediate recipient to whom a message was routed. The message path may include one or more actors, or, if no actors are specified, the message goes only to the default actor, which is the final intended recipient.
Field Summary |
---|
Method Summary | |
---|---|
Detail |
addDetail()
Creates an optional Detail object and sets it as the Detail object for this SOAPFault object. |
Detail |
getDetail()
Returns the optional detail element for this SOAPFault object. |
String |
getFaultActor()
Gets the fault actor for this SOAPFault object. |
String |
getFaultCode()
Gets the fault code for this SOAPFault object. |
Name |
getFaultCodeAsName()
Gets the mandatory SOAP 1.1 fault code for this SOAPFault object as a SAAJ Name object. |
String |
getFaultString()
Gets the fault string for this SOAPFault object. |
Locale |
getFaultStringLocale()
Gets the locale of the fault string for this SOAPFault object. |
void |
setFaultActor(String faultActor)
Sets this SOAPFault object with the given fault actor. |
void |
setFaultCode(Name faultCodeQName)
Sets this SOAPFault object with the given fault code. |
void |
setFaultCode(String faultCode)
Sets this SOAPFault object with the give fault code. |
void |
setFaultString(String faultString)
Sets the fault string for this SOAPFault object to the given string. |
void |
setFaultString(String faultString,
Locale locale)
Sets the fault string for this SOAPFault object to the given string and localized to the given locale. |
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 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 |
Method Detail |
---|
Detail addDetail() throws SOAPException
SOAPException
- if this SOAPFault object already contains a valid Detail objectDetail getDetail()
String getFaultActor()
String getFaultCode()
Name getFaultCodeAsName()
String getFaultString()
Locale getFaultStringLocale()
void setFaultActor(String faultActor) throws SOAPException
faultActor
- a String identifying the actor that caused this SOAPFault object
SOAPException
- if there was an error in adding the faultActor to the underlying XML tree.void setFaultCode(String faultCode) throws SOAPException
faultCode
- a String giving the fault code to be set.
It must be of the form "prefix:localName" where the prefix has been defined in a namespace declaration.
SOAPException
- if there was an error in adding the faultCode to the underlying XML tree.void setFaultCode(Name faultCodeQName) throws SOAPException
faultCodeQName
- a Name object giving the fault code to be set. It must be namespace qualified.
SOAPException
- if there was an error in adding the faultcode element to the underlying XML tree.void setFaultString(String faultString) throws SOAPException
faultString
- a String giving an explanation of the fault
SOAPException
- if there was an error in adding the faultString to the underlying XML tree.void setFaultString(String faultString, Locale locale) throws SOAPException
faultString
- a String giving an explanation of the faultlocale
- a Locale object indicating the native language of the faultString
SOAPException
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |