|
Sun Java(tm) System Message Queue v3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
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.
| Method Summary | |
Detail |
addDetail()
Creates a Detail object and sets it as the
Detail object for this SOAPFault
object.
|
Detail |
getDetail()
Returns the 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. |
String |
getFaultString()
Gets the fault string for this SOAPFault object. |
void |
setFaultActor(String faultActor)
Sets this SOAPFault object with the given fault actor.
|
void |
setFaultCode(String faultCode)
Sets this SOAPFault object with the given fault code.
|
void |
setFaultString(String faultString)
Sets the fault string for this SOAPFault object
to the given string. |
| Methods inherited from interface javax.xml.soap.SOAPElement |
addAttribute, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, removeAttribute, removeNamespaceDeclaration, setEncodingStyle |
| Methods inherited from interface javax.xml.soap.Node |
detachNode, getParentElement, getValue, recycleNode, setParentElement |
| Method Detail |
public void setFaultCode(String faultCode)
throws SOAPException
SOAPFault object with the given fault code.
Fault codes, which given information about the fault, are defined in the SOAP 1.1 specification.
faultCode - a String giving the fault code to be set;
must be one of the fault codes defined in the SOAP 1.1
specification
SOAPException - if there was an error in adding the
faultCode to the underlying XML tree.getFaultCode()public String getFaultCode()
SOAPFault object.
String with the fault codesetFaultCode(java.lang.String)
public void setFaultActor(String faultActor)
throws SOAPException
SOAPFault object with the given fault actor.
The fault actor is the recipient in the message path who caused the fault to happen.
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.getFaultActor()public String getFaultActor()
SOAPFault object.
String giving the actor in the message path
that caused this SOAPFault objectsetFaultActor(java.lang.String)
public void setFaultString(String faultString)
throws SOAPException
SOAPFault object
to the given string.
faultString - a String giving an explanation of
the fault
SOAPException - if there was an error in adding the
faultString to the underlying XML tree.getFaultString()public String getFaultString()
SOAPFault object.
String giving an explanation of
the faultpublic Detail getDetail()
SOAPFault object.
A Detail object carries application-specific error
information related to SOAPBodyElement objects.
Detail object with application-specific
error information
public Detail addDetail()
throws SOAPException
Detail object and sets it as the
Detail object for this SOAPFault
object.
It is illegal to add a detail when the fault already contains a detail. Therefore, this method should be called only after the existing detail has been removed.
Detail object
SOAPException - if this
SOAPFault object already contains a
valid Detail object
SOAPException
|
Sun Java(tm) System Message Queue v3.6 |
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||