public interface SOAPFault extends OMElement
SOAPBody
object that contains error and/or status information.
This information may relate to errors in the OMMessage
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. B 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.
CDATA_SECTION_NODE, COMMENT_NODE, DTD_NODE, ELEMENT_NODE, ENTITY_REFERENCE_NODE, PI_NODE, SPACE_NODE, TEXT_NODE
Modifier and Type | Method and Description |
---|---|
SOAPFaultCode |
getCode() |
SOAPFaultDetail |
getDetail() |
Exception |
getException()
Returns Exception if there is one in the SOAP fault.
|
SOAPFaultNode |
getNode()
Get the SOAP fault node.
|
SOAPFaultReason |
getReason() |
SOAPFaultRole |
getRole() |
void |
setCode(SOAPFaultCode soapFaultCode)
SOAPFaultCode is a mandatory item in a Fault, in SOAP 1.2 specification
|
void |
setDetail(SOAPFaultDetail detail)
SOAPFaultRoleImpl is an optional item in a Fault, in SOAP 1.2 specification
|
void |
setException(Exception e) |
void |
setNode(SOAPFaultNode node)
SOAPFaultNode is an optional item in a Fault, in SOAP 1.2 specification
|
void |
setReason(SOAPFaultReason reason)
SOAPFaultReason is a mandatory item in a Fault, in SOAP 1.2 specification
|
void |
setRole(SOAPFaultRole role)
SOAPFaultRoleImpl is an optional item in a Fault, in SOAP 1.2 specification
|
addAttribute, addAttribute, cloneOMElement, declareDefaultNamespace, declareNamespace, declareNamespace, findNamespace, findNamespaceURI, getAllAttributes, getAllDeclaredNamespaces, getAttribute, getAttributeValue, getChildElements, getDefaultNamespace, getFirstElement, getLineNumber, getNamespaceContext, getNamespacesInScope, getText, getTextAsQName, getTextAsStream, removeAttribute, resolveQName, serialize, serialize, serialize, serialize, serializeAndConsume, serializeAndConsume, serializeAndConsume, serializeAndConsume, setLineNumber, setNamespace, setNamespaceWithNoFindInCurrentScope, setText, setText, toString, toStringWithConsume, undeclarePrefix, writeTextTo
buildWithAttachments, detach, discard, getNextOMSibling, getParent, getPreviousOMSibling, getType, insertSiblingAfter, insertSiblingBefore
addChild, getBuilder, getChildren, getChildrenWithLocalName, getChildrenWithName, getChildrenWithNamespaceURI, getDescendants, getFirstChildWithName, getFirstOMChild, getSAXResult, getSAXSource, getXMLStreamReader, getXMLStreamReader, getXMLStreamReader, getXMLStreamReaderWithoutCaching, removeChildren
build, close, isComplete, serialize, serialize, serializeAndConsume
clone, getOMFactory
getLocalName, getNamespace, getNamespaceURI, getPrefix, getQName, hasName, setLocalName, setNamespace
void setCode(SOAPFaultCode soapFaultCode) throws SOAPProcessingException
soapFaultCode
- SOAPProcessingException
SOAPFaultCode getCode()
void setReason(SOAPFaultReason reason) throws SOAPProcessingException
reason
- SOAPProcessingException
SOAPFaultReason getReason()
void setNode(SOAPFaultNode node) throws SOAPProcessingException
node
- SOAPProcessingException
SOAPFaultNode getNode()
null
if there is no fault node or if fault nodes are
not supported by the SOAP versionvoid setRole(SOAPFaultRole role) throws SOAPProcessingException
role
- SOAPProcessingException
SOAPFaultRole getRole()
void setDetail(SOAPFaultDetail detail) throws SOAPProcessingException
detail
- SOAPProcessingException
SOAPFaultDetail getDetail()
Exception getException() throws OMException
If the exception is like; <SOAPFault> <Detail> <Exception> stack trace goes here </Exception> </Detail> </SOAPFault>
OMException
void setException(Exception e) throws OMException
OMException
Copyright © The Apache Software Foundation. All Rights Reserved.