org.jboss.axis.message
Class SOAPFaultImpl

java.lang.Object
  org.jboss.axis.message.NodeImpl
      org.jboss.axis.message.SOAPElementImpl
          org.jboss.axis.message.SOAPElementAxisImpl
              org.jboss.axis.message.SOAPBodyElementImpl
                  org.jboss.axis.message.SOAPBodyElementAxisImpl
                      org.jboss.axis.message.SOAPFaultImpl

All Implemented Interfaces:

Cloneable, javax.xml.soap.SOAPBodyElement, javax.xml.soap.SOAPElement, javax.xml.soap.SOAPFault, Element, Node

Direct Known Subclasses:

DetailImpl

public class SOAPFaultImpl
extends SOAPBodyElementAxisImpl
implements javax.xml.soap.SOAPFault

A Fault body element.

Author:

Sam Ruby (rubys@us.ibm.com), Glen Daniels (gdaniels@macromedia.com), Tom Jordahl (tomj@macromedia.com)

Nested Class Summary

Nested classes/interfaces inherited from class org.jboss.axis.message.SOAPElementAxisImpl

SOAPElementAxisImpl.QNameAttr

Field Summary

protected AxisFault	fault
protected String	prefix

Fields inherited from class org.jboss.axis.message.SOAPElementAxisImpl

_isRoot, attributes, context, elementRep, encodingStyle, endEventIndex, href, id, message, name, namespaces, namespaceURI, objectValue, qNameAttrs, recorder, soapPart, startContentsIndex, startEventIndex, typeQName

Fields inherited from class org.jboss.axis.message.NodeImpl

domNode, soapParent

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

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

SOAPFaultImpl(AxisFault fault)

SOAPFaultImpl(String namespace, String localName, String prefix, Attributes attrs, DeserializationContext context)

Method Summary

javax.xml.soap.Detail	addDetail() Creates a Detail object and sets it as the Detail object for this SOAPFaultException object.
javax.xml.soap.Detail	getDetail() Returns the detail element for this SOAPFaultException object.
AxisFault	getFault()
String	getFaultActor() Gets the fault actor for this SOAPFaultException object.
String	getFaultCode() Gets the fault code for this SOAPFaultException object.
javax.xml.soap.Name	getFaultCodeAsName()
String	getFaultString() Gets the fault string for this SOAPFaultException object.
Locale	getFaultStringLocale()
void	outputImpl(SerializationContext context) Subclasses can override
void	setFault(AxisFault fault)
void	setFaultActor(String faultActor) Sets this SOAPFaultException object with the given fault actor.
void	setFaultCode(javax.xml.soap.Name faultCodeQName)
void	setFaultCode(String faultCode) Sets this SOAPFaultException object with the given fault code.
void	setFaultString(String faultString) Sets the fault string for this SOAPFaultException object to the given string.
void	setFaultString(String faultString, Locale locale)

Methods inherited from class org.jboss.axis.message.SOAPBodyElementAxisImpl

setParentElement

Methods inherited from class org.jboss.axis.message.SOAPElementAxisImpl

addAttribute, addAttribute, addAttribute, addAttribute, addChild, addChildElement, addChildElement, addChildElement, addChildElement, addChildElement, addMapping, addNamespaceDeclaration, addTextNode, appendChild, cloneNode, clonning, detachAllChildren, detachNode, getAllAttributes, getAsDocument, getAsDOM, getAsString, getAsStringFromInternal, getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getAttributes, getAttributesEx, getAttributeValue, getAttributeValue, getChildElements, getChildElements, getChildNodes, getChildren, getCompleteAttributes, getElementName, getElementsByTagName, getElementsByTagNameNS, getElementsNS, getEncodingStyle, getEnvelope, getFirstChild, getFixupDeserializer, getHref, getID, getLastChild, getLocalName, getName, getNamespacePrefixes, getNamespaceURI, getNamespaceURI, getNextSibling, getNodeType, getNodeValue, getObjectValue, getObjectValue, getOwnerDocument, getParentElement, getParentNode, getPrefix, getPrefix, getPreviousSibling, getQName, getRealElement, getRecorder, getTagName, getType, getValueAsType, getValueAsType, getVisibleNamespacePrefixes, hasAttribute, hasAttributeNS, hasAttributes, hasChildNodes, insertBefore, isDirty, isImmutable, isRoot, isSupported, makeAttributesEditable, normalize, output, printFromInternal, publishContents, publishToHandler, removeAttribute, removeAttribute, removeAttributeNode, removeAttributeNS, removeChild, removeContents, removeNamespaceDeclaration, replaceChild, setAllAttributes, setAllImmutable, setAttribute, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS, setContentsIndex, setDirty, setEncodingStyle, setEndIndex, setEnvelope, setFixupDeserializer, setImmutable, setName, setNamespaceURI, setNSMappings, setObjectValue, setOwnerDocument, setPrefix, setQName, setRecorder, setType

Methods inherited from class org.jboss.axis.message.SOAPElementImpl

getSchemaTypeInfo, setIdAttribute, setIdAttributeNode, setIdAttributeNS

Methods inherited from class org.jboss.axis.message.NodeImpl

compareDocumentPosition, getBaseURI, getFeature, getNodeName, getTextContent, getUserData, getValue, hashCode, isDefaultNamespace, isEqualNode, isSameNode, lookupNamespaceURI, lookupPrefix, recycleNode, setNodeValue, setTextContent, setUserData, setValue, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, notify, notifyAll, wait, wait, wait

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

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

Field Detail

fault

protected AxisFault fault

prefix

protected String prefix

Constructor Detail

SOAPFaultImpl

public SOAPFaultImpl(String namespace,
                     String localName,
                     String prefix,
                     Attributes attrs,
                     DeserializationContext context)
              throws AxisFault

Throws:

AxisFault

SOAPFaultImpl

public SOAPFaultImpl(AxisFault fault)

Method Detail

outputImpl

public void outputImpl(SerializationContext context)
                throws IOException

Description copied from class: SOAPElementAxisImpl

Subclasses can override

Overrides:

outputImpl in class SOAPElementAxisImpl

Throws:

IOException

getFault

public AxisFault getFault()

setFault

public void setFault(AxisFault fault)

setFaultCode

public void setFaultCode(String faultCode)
                  throws javax.xml.soap.SOAPException

Sets this SOAPFaultException 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 interface javax.xml.soap.SOAPFault

Parameters:

faultCode - a String giving the fault code to be set; must be one of the fault codes defined in the SOAP 1.1 specification

Throws:

javax.xml.soap.SOAPException - if there was an error in adding the faultCode to the underlying XML tree.

getFaultCode

public String getFaultCode()

Gets the fault code for this SOAPFaultException object.

Specified by:

getFaultCode in interface javax.xml.soap.SOAPFault

Returns:

a String with the fault code

setFaultActor

public void setFaultActor(String faultActor)
                   throws javax.xml.soap.SOAPException

Sets this SOAPFaultException 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 interface javax.xml.soap.SOAPFault

Parameters:

faultActor - a String identifying the actor that caused this SOAPFaultException object

Throws:

javax.xml.soap.SOAPException - if there was an error in adding the faultActor to the underlying XML tree.

getFaultActor

public String getFaultActor()

Gets the fault actor for this SOAPFaultException object.

Specified by:

getFaultActor in interface javax.xml.soap.SOAPFault

Returns:

a String giving the actor in the message path that caused this SOAPFaultException object

See Also:

setFaultActor(java.lang.String)

setFaultString

public void setFaultString(String faultString)
                    throws javax.xml.soap.SOAPException

Sets the fault string for this SOAPFaultException object to the given string.

Specified by:

setFaultString in interface javax.xml.soap.SOAPFault

Parameters:

faultString - a String giving an explanation of the fault

Throws:

javax.xml.soap.SOAPException - if there was an error in adding the faultString to the underlying XML tree.

See Also:

getFaultString()

getFaultString

public String getFaultString()

Gets the fault string for this SOAPFaultException object.

Specified by:

getFaultString in interface javax.xml.soap.SOAPFault

Returns:

a String giving an explanation of the fault

getDetail

public javax.xml.soap.Detail getDetail()

Returns the detail element for this SOAPFaultException object.

A Detail object carries application-specific error information related to SOAPBodyElement objects.

Specified by:

getDetail in interface javax.xml.soap.SOAPFault

Returns:

a Detail object with application-specific error information

addDetail

public javax.xml.soap.Detail addDetail()
                                throws javax.xml.soap.SOAPException

Creates a Detail object and sets it as the Detail object for this SOAPFaultException 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 interface javax.xml.soap.SOAPFault

Returns:

the new Detail object

Throws:

javax.xml.soap.SOAPException - if this SOAPFaultException object already contains a valid Detail object

setFaultCode

public void setFaultCode(javax.xml.soap.Name faultCodeQName)
                  throws javax.xml.soap.SOAPException

Specified by:

setFaultCode in interface javax.xml.soap.SOAPFault

Throws:

javax.xml.soap.SOAPException

getFaultCodeAsName

public javax.xml.soap.Name getFaultCodeAsName()

Specified by:

getFaultCodeAsName in interface javax.xml.soap.SOAPFault

setFaultString

public void setFaultString(String faultString,
                           Locale locale)
                    throws javax.xml.soap.SOAPException

Specified by:

setFaultString in interface javax.xml.soap.SOAPFault

Throws:

javax.xml.soap.SOAPException

getFaultStringLocale

public Locale getFaultStringLocale()

Specified by:

getFaultStringLocale in interface javax.xml.soap.SOAPFault