Package org.apache.axis.message
Class SOAPFault
- java.lang.Object
-
- org.apache.axis.message.NodeImpl
-
- org.apache.axis.message.MessageElement
-
- org.apache.axis.message.SOAPBodyElement
-
- org.apache.axis.message.SOAPFault
-
- All Implemented Interfaces:
java.io.Serializable
,java.lang.Cloneable
,Node
,SOAPBodyElement
,SOAPElement
,SOAPFault
,org.w3c.dom.Element
,org.w3c.dom.Node
,org.w3c.dom.NodeList
public class SOAPFault extends SOAPBodyElement implements SOAPFault
A Fault body element.- Author:
- Sam Ruby (rubys@us.ibm.com), Glen Daniels (gdaniels@apache.org), Tom Jordahl (tomj@macromedia.com)
- See Also:
- Serialized Form
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from class org.apache.axis.message.MessageElement
MessageElement.QNameAttr
-
-
Field Summary
Fields Modifier and Type Field Description protected Detail
detail
protected AxisFault
fault
protected java.lang.String
prefix
-
Fields inherited from class org.apache.axis.message.MessageElement
_isRoot, context, encodingStyle, endEventIndex, fixupDeserializer, href, id, message, namespaces, qNameAttrs, recorder, startContentsIndex, startEventIndex, typeQName
-
Fields inherited from class org.apache.axis.message.NodeImpl
_isDirty, attributes, children, document, name, namespaceURI, parent, textRep
-
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
-
-
Constructor Summary
Constructors Constructor Description SOAPFault(java.lang.String namespace, java.lang.String localName, java.lang.String prefix, org.xml.sax.Attributes attrs, DeserializationContext context)
SOAPFault(AxisFault fault)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Detail
addDetail()
Creates aDetail
object and sets it as theDetail
object for thisSOAPFaultException
object.Detail
getDetail()
Returns the detail element for thisSOAPFaultException
object.AxisFault
getFault()
java.lang.String
getFaultActor()
Gets the fault actor for thisSOAPFaultException
object.java.lang.String
getFaultCode()
Gets the fault code for thisSOAPFaultException
object.Name
getFaultCodeAsName()
Gets the mandatory SOAP 1.1 fault code for thisSOAPFault
object as a SAAJName
object.java.lang.String
getFaultString()
Gets the fault string for thisSOAPFaultException
object.java.util.Locale
getFaultStringLocale()
Returns the optional detail element for thisSOAPFault
object.void
outputImpl(SerializationContext context)
override point -output to a serialization context.void
setFault(AxisFault fault)
void
setFaultActor(java.lang.String faultActor)
Sets thisSOAPFaultException
object with the given fault actor.void
setFaultCode(java.lang.String faultCode)
Sets thisSOAPFaultException
object with the given fault code.void
setFaultCode(Name faultCodeQName)
Sets thisSOAPFault
object with the given fault code.void
setFaultString(java.lang.String faultString)
Sets the fault string for thisSOAPFaultException
object to the given string.void
setFaultString(java.lang.String faultString, java.util.Locale locale)
Sets the fault string for thisSOAPFault
object to the given string and localized to the given locale.-
Methods inherited from class org.apache.axis.message.SOAPBodyElement
setParentElement
-
Methods inherited from class org.apache.axis.message.MessageElement
addAttribute, addAttribute, addAttribute, addAttribute, addChild, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addMapping, addNamespaceDeclaration, addTextNode, childDeepCloned, cloneNode, cloning, detachAllChildren, equals, findElement, getAllAttributes, getAsDocument, getAsDOM, getAsString, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributesEx, getAttributeValue, getAttributeValue, getChildElement, getChildElements, getChildElements, getChildElements, getChildren, getCompleteAttributes, getDeserializationContext, getElementName, getElementsByTagName, getElementsByTagNameNS, getElementsNS, getEncodingStyle, getEnvelope, getFixupDeserializer, getHref, getID, getLength, getName, getNamespacePrefixes, getNamespaceURI, getObjectValue, getObjectValue, getOwnerDocument, getPrefix, getQName, getRealElement, getRecorder, getTagName, getType, getValue, getValueAsType, getValueAsType, getValueDOM, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, isRoot, item, output, publishContents, publishToHandler, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeContents, removeNamespaceDeclaration, setAllAttributes, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setContentsIndex, setEncodingStyle, setEndIndex, setEnvelope, setFixupDeserializer, setName, setNamespaceURI, setNSMappings, setObjectValue, setQName, setRecorder, setType, setValue, toString
-
Methods inherited from class org.apache.axis.message.NodeImpl
appendChild, compareDocumentPosition, convertAttrSAXtoDOM, detachNode, getAttributes, getBaseURI, getChildNodes, getFeature, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getParent, getParentElement, getParentNode, getPrefix, getPreviousSibling, getSchemaTypeInfo, getTextContent, getUserData, hasAttributes, hasChildNodes, initializeChildren, insertBefore, isDefaultNamespace, isDirty, isEqualNode, isSameNode, isSupported, lookupNamespaceURI, lookupPrefix, makeAttributesEditable, normalize, recycleNode, removeChild, replaceChild, reset, setDirty, setDirty, setIdAttribute, setIdAttributeNode, setIdAttributeNS, setNodeValue, setOwnerDocument, setParent, setPrefix, setTextContent, setUserData
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
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, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addNamespaceDeclaration, addTextNode, getAllAttributes, getAttributeValue, getChildElements, getChildElements, getElementName, getEncodingStyle, getNamespacePrefixes, getNamespaceURI, getVisibleNamespacePrefixes, removeAttribute, removeContents, removeNamespaceDeclaration, setEncodingStyle
-
-
-
-
Constructor Detail
-
SOAPFault
public SOAPFault(java.lang.String namespace, java.lang.String localName, java.lang.String prefix, org.xml.sax.Attributes attrs, DeserializationContext context) throws AxisFault
- Throws:
AxisFault
-
SOAPFault
public SOAPFault(AxisFault fault)
-
-
Method Detail
-
outputImpl
public void outputImpl(SerializationContext context) throws java.lang.Exception
Description copied from class:MessageElement
override point -output to a serialization context.- Overrides:
outputImpl
in classMessageElement
- Parameters:
context
- destination.- Throws:
java.lang.Exception
- if something went wrong.
-
getFault
public AxisFault getFault()
-
setFault
public void setFault(AxisFault fault)
-
setFaultCode
public void setFaultCode(java.lang.String faultCode) throws SOAPException
Sets thisSOAPFaultException
object with the given fault code.Fault codes, which given information about the fault, are defined in the SOAP 1.1 specification.
- Specified by:
setFaultCode
in interfaceSOAPFault
- Parameters:
faultCode
- aString
giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification- Throws:
SOAPException
- if there was an error in adding thefaultCode
to the underlying XML tree.- See Also:
getFaultCode()
-
getFaultCode
public java.lang.String getFaultCode()
Gets the fault code for thisSOAPFaultException
object.- Specified by:
getFaultCode
in interfaceSOAPFault
- Returns:
- a
String
with the fault code - See Also:
setFaultCode(java.lang.String)
-
setFaultActor
public void setFaultActor(java.lang.String faultActor) throws SOAPException
Sets thisSOAPFaultException
object with the given fault actor.The fault actor is the recipient in the message path who caused the fault to happen.
- Specified by:
setFaultActor
in interfaceSOAPFault
- Parameters:
faultActor
- aString
identifying the actor that caused thisSOAPFaultException
object- Throws:
SOAPException
- if there was an error in adding thefaultActor
to the underlying XML tree.- See Also:
getFaultActor()
-
getFaultActor
public java.lang.String getFaultActor()
Gets the fault actor for thisSOAPFaultException
object.- Specified by:
getFaultActor
in interfaceSOAPFault
- Returns:
- a
String
giving the actor in the message path that caused thisSOAPFaultException
object - See Also:
setFaultActor(java.lang.String)
-
setFaultString
public void setFaultString(java.lang.String faultString) throws SOAPException
Sets the fault string for thisSOAPFaultException
object to the given string.- Specified by:
setFaultString
in interfaceSOAPFault
- Parameters:
faultString
- aString
giving an explanation of the fault- Throws:
SOAPException
- if there was an error in adding thefaultString
to the underlying XML tree.- See Also:
getFaultString()
-
getFaultString
public java.lang.String getFaultString()
Gets the fault string for thisSOAPFaultException
object.- Specified by:
getFaultString
in interfaceSOAPFault
- Returns:
- a
String
giving an explanation of the fault
-
getDetail
public Detail getDetail()
Returns the detail element for thisSOAPFaultException
object.A
Detail
object carries application-specific error information related toSOAPBodyElement
objects.
-
addDetail
public Detail addDetail() throws SOAPException
Creates aDetail
object and sets it as theDetail
object for thisSOAPFaultException
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.
- Specified by:
addDetail
in interfaceSOAPFault
- Returns:
- the new
Detail
object - Throws:
SOAPException
- if thisSOAPFaultException
object already contains a validDetail
object
-
setFaultCode
public void setFaultCode(Name faultCodeQName) throws SOAPException
Description copied from interface:SOAPFault
Sets thisSOAPFault
object with the given fault code. Fault codes, which give information about the fault, are defined in the SOAP 1.1 specification. A fault code is mandatory and must be of typeQName
. This method provides a convenient way to set a fault code. For example,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); It is preferable to use this method over setFaultCode(String).
- Specified by:
setFaultCode
in interfaceSOAPFault
- Parameters:
faultCodeQName
- aName
object giving the fault code to be set. It must be namespace qualified.- Throws:
SOAPException
- if there was an error in adding thefaultcode
element to the underlying XML tree
-
getFaultCodeAsName
public Name getFaultCodeAsName()
Description copied from interface:SOAPFault
Gets the mandatory SOAP 1.1 fault code for thisSOAPFault
object as a SAAJName
object. The SOAP 1.1 specification requires the value of the "faultcode" element to be of type QName. This method returns the content of the element as a QName in the form of a SAAJName
object. This method should be used instead of thegetFaultCode()
method since it allows applications to easily access the namespace name without additional parsing.In the future, a QName object version of this method may also be added.
- Specified by:
getFaultCodeAsName
in interfaceSOAPFault
- Returns:
- a
Name
representing the faultcode
-
setFaultString
public void setFaultString(java.lang.String faultString, java.util.Locale locale) throws SOAPException
Description copied from interface:SOAPFault
Sets the fault string for thisSOAPFault
object to the given string and localized to the given locale.- Specified by:
setFaultString
in interfaceSOAPFault
- Parameters:
faultString
- aString
giving an explanation of the faultlocale
- aLocale
object indicating the native language of thefaultString
- Throws:
SOAPException
- if there was an error in adding thefaultString
to the underlying XML tree
-
getFaultStringLocale
public java.util.Locale getFaultStringLocale()
Description copied from interface:SOAPFault
Returns the optional detail element for thisSOAPFault
object.- Specified by:
getFaultStringLocale
in interfaceSOAPFault
- Returns:
- a
Locale
object indicating the native language of the fault string ornull
if no locale was specified
-
-