Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD

org.jboss.axis.message
Class SOAPFaultImpl

java.lang.Object
  extended byorg.jboss.axis.message.NodeImpl (src) 
      extended byorg.jboss.axis.message.SOAPElementImpl (src) 
          extended byorg.jboss.axis.message.SOAPElementAxisImpl (src) 
              extended byorg.jboss.axis.message.SOAPBodyElementImpl (src) 
                  extended byorg.jboss.axis.message.SOAPBodyElementAxisImpl (src) 
                      extended byorg.jboss.axis.message.SOAPFaultImpl
All Implemented Interfaces:
java.lang.Cloneable, org.w3c.dom.Element, Node (src) , org.w3c.dom.Node, SOAPBodyElement (src) , SOAPElement (src) , SOAPFault (src)
Direct Known Subclasses:
DetailImpl (src)
public class SOAPFaultImpl
extends SOAPBodyElementAxisImpl (src)
implements SOAPFault (src)

A Fault body element.

Nested Class Summary
 
Nested classes inherited from class org.jboss.axis.message.SOAPElementAxisImpl (src)
SOAPElementAxisImpl.QNameAttr (src)
 
Field Summary
protected  AxisFault (src) fault
           
protected  java.lang.String prefix
           
 
Fields inherited from class org.jboss.axis.message.SOAPElementAxisImpl (src)
_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 (src)
domNode, soapParent
 
Fields inherited from interface org.w3c.dom.Node
ATTRIBUTE_NODE, CDATA_SECTION_NODE, COMMENT_NODE, DOCUMENT_FRAGMENT_NODE, DOCUMENT_NODE, DOCUMENT_TYPE_NODE, ELEMENT_NODE, ENTITY_NODE, ENTITY_REFERENCE_NODE, NOTATION_NODE, PROCESSING_INSTRUCTION_NODE, TEXT_NODE
 
Constructor Summary
SOAPFaultImpl(AxisFault (src)  fault)
           
SOAPFaultImpl(java.lang.String namespace, java.lang.String localName, java.lang.String prefix, org.xml.sax.Attributes attrs, DeserializationContext (src)  context)
           
 
Method Summary
 Detail (src) addDetail()
          Creates a Detail object and sets it as the Detail object for this SOAPFaultException object.
 Detail (src) getDetail()
          Returns the detail element for this SOAPFaultException object.
 AxisFault (src) getFault()
           
 java.lang.String getFaultActor()
          Gets the fault actor for this SOAPFaultException object.
 java.lang.String getFaultCode()
          Gets the fault code for this SOAPFaultException object.
 Name (src) getFaultCodeAsName()
           
 java.lang.String getFaultString()
          Gets the fault string for this SOAPFaultException object.
 java.util.Locale getFaultStringLocale()
           
 void outputImpl(SerializationContext (src)  context)
          Subclasses can override
 void setFault(AxisFault (src)  fault)
           
 void setFaultActor(java.lang.String faultActor)
          Sets this SOAPFaultException object with the given fault actor.
 void setFaultCode(Name (src)  faultCodeQName)
           
 void setFaultCode(java.lang.String faultCode)
          Sets this SOAPFaultException object with the given fault code.
 void setFaultString(java.lang.String faultString)
          Sets the fault string for this SOAPFaultException object to the given string.
 void setFaultString(java.lang.String faultString, java.util.Locale locale)
           
 
Methods inherited from class org.jboss.axis.message.SOAPBodyElementAxisImpl (src)
setParentElement
 
Methods inherited from class org.jboss.axis.message.SOAPElementAxisImpl (src)
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 (src)
getSchemaTypeInfo, setIdAttribute, setIdAttributeNode, setIdAttributeNS
 
Methods inherited from class org.jboss.axis.message.NodeImpl (src)
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 (src)
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 (src)
detachNode, getParentElement, getValue, recycleNode, setParentElement, setValue
 
Methods inherited from interface org.w3c.dom.Node
appendChild, cloneNode, getAttributes, getChildNodes, getFirstChild, getLastChild, getLocalName, getNamespaceURI, getNextSibling, getNodeName, getNodeType, getNodeValue, getOwnerDocument, getParentNode, getPrefix, getPreviousSibling, hasAttributes, hasChildNodes, insertBefore, isSupported, normalize, removeChild, replaceChild, setNodeValue, setPrefix
 
Methods inherited from interface org.w3c.dom.Element
getAttribute, getAttributeNode, getAttributeNodeNS, getAttributeNS, getElementsByTagName, getElementsByTagNameNS, getTagName, hasAttribute, hasAttributeNS, removeAttribute, removeAttributeNode, removeAttributeNS, setAttribute, setAttributeNode, setAttributeNodeNS, setAttributeNS
 

Field Detail

fault

protected AxisFault (src)  fault

prefix

protected java.lang.String prefix
Constructor Detail

SOAPFaultImpl

public SOAPFaultImpl(java.lang.String namespace,
                     java.lang.String localName,
                     java.lang.String prefix,
                     org.xml.sax.Attributes attrs,
                     DeserializationContext (src)  context)
              throws AxisFault (src)

SOAPFaultImpl

public SOAPFaultImpl(AxisFault (src)  fault)
Method Detail

outputImpl

public void outputImpl(SerializationContext (src)  context)
                throws java.io.IOException
Description copied from class: SOAPElementAxisImpl (src)
Subclasses can override

Overrides:
outputImpl in class SOAPElementAxisImpl (src)
Throws:
java.io.IOException

getFault

public AxisFault (src)  getFault()

setFault

public void setFault(AxisFault (src)  fault)

setFaultCode

public void setFaultCode(java.lang.String faultCode)
                  throws SOAPException (src)
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 SOAPFault (src)
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:
SOAPException (src) - if there was an error in adding the faultCode to the underlying XML tree.

getFaultCode

public java.lang.String getFaultCode()
Gets the fault code for this SOAPFaultException object.

Specified by:
getFaultCode in interface SOAPFault (src)
Returns:
a String with the fault code

setFaultActor

public void setFaultActor(java.lang.String faultActor)
                   throws SOAPException (src)
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 SOAPFault (src)
Parameters:
faultActor - a String identifying the actor that caused this SOAPFaultException object
Throws:
SOAPException (src) - if there was an error in adding the faultActor to the underlying XML tree.

getFaultActor

public java.lang.String getFaultActor()
Gets the fault actor for this SOAPFaultException object.

Specified by:
getFaultActor in interface SOAPFault (src)
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(java.lang.String faultString)
                    throws SOAPException (src)
Sets the fault string for this SOAPFaultException object to the given string.

Specified by:
setFaultString in interface SOAPFault (src)
Parameters:
faultString - a String giving an explanation of the fault
Throws:
SOAPException (src) - if there was an error in adding the faultString to the underlying XML tree.
See Also:
getFaultString()

getFaultString

public java.lang.String getFaultString()
Gets the fault string for this SOAPFaultException object.

Specified by:
getFaultString in interface SOAPFault (src)
Returns:
a String giving an explanation of the fault

getDetail

public Detail (src)  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 SOAPFault (src)
Returns:
a Detail object with application-specific error information

addDetail

public Detail (src)  addDetail()
                 throws SOAPException (src)
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 SOAPFault (src)
Returns:
the new Detail object
Throws:
SOAPException (src) - if this SOAPFaultException object already contains a valid Detail object

setFaultCode

public void setFaultCode(Name (src)  faultCodeQName)
                  throws SOAPException (src)
Specified by:
setFaultCode in interface SOAPFault (src)
Throws:
SOAPException (src)

getFaultCodeAsName

public Name (src)  getFaultCodeAsName()
Specified by:
getFaultCodeAsName in interface SOAPFault (src)

setFaultString

public void setFaultString(java.lang.String faultString,
                           java.util.Locale locale)
                    throws SOAPException (src)
Specified by:
setFaultString in interface SOAPFault (src)
Throws:
SOAPException (src)

getFaultStringLocale

public java.util.Locale getFaultStringLocale()
Specified by:
getFaultStringLocale in interface SOAPFault (src)
Overview  Package   Class  Tree  Deprecated  Index  Help 
 PREV CLASS (src)    NEXT CLASS (src) FRAMES    NO FRAMES    
SUMMARY: NESTED | FIELD | CONSTR | METHOD DETAIL: FIELD | CONSTR | METHOD