Prev Class | Next Class | Frames | No Frames |
Summary: Nested | Field | Method | Constr | Detail: Nested | Field | Method | Constr |
java.lang.Object
org.apache.axis.message.NodeImpl
org.apache.axis.message.MessageElement
org.apache.axis.message.SOAPBodyElement
org.apache.axis.message.SOAPFault
Nested Class Summary |
Nested classes/interfaces inherited from class org.apache.axis.message.MessageElement | |
MessageElement.QNameAttr |
Fields inherited from class org.apache.axis.message.MessageElement | |
_isRoot , context , encodingStyle , endEventIndex , fixupDeserializer , href , id , log , message , namespaces , qNameAttrs , recorder , startContentsIndex , startEventIndex , typeQName |
Fields inherited from class org.apache.axis.message.NodeImpl | |
_isDirty , attributes , children , document , log , name , namespaceURI , parent , prefix , textRep |
Constructor Summary | |
| |
Method Summary | |
Detail |
|
Detail |
|
AxisFault |
|
String |
|
String |
|
Name | |
String |
|
Locale | |
void |
|
void | |
void |
|
void |
|
void |
|
void |
|
void |
|
Methods inherited from class org.apache.axis.message.SOAPBodyElement | |
setParentElement |
public SOAPFault(String namespace, String localName, String prefix, Attributes attrs, DeserializationContext context) throws AxisFault
Advanced constructor used for deserialization.
- The context provides the mappings and Sax event recorder
- The soap messaging style is determined from the current message context, defaulting to SOAP1.1 if there is no current context.
- if there is an id attribute (any namespace), then the ID is registered with
DeserializationContext.registerElementByID(String,MessageElement)
;a new recorder is created if needed.- If there is an attribute "root" in the default SOAP namespace, then it is examined to see if it marks the element as root (value=="1" or not)
- If there is an arrayType attribute then we assume we are an array and set our
MessageElement.typeQName
field appropriately.- The
MessageElement.href
field is set if there is a relevant href value
- Parameters:
namespace
- namespace namespace of elementprefix
- prefix prefix of elementcontext
- deserialization context for this message element
- Throws:
AxisFault
- if the encoding style is not recognized/supported
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.
- Returns:
- the new
Detail
object
- Throws:
SOAPException
- if thisSOAPFaultException
object already contains a validDetail
object
public Detail getDetail()
Returns the detail element for thisSOAPFaultException
object. ADetail
object carries application-specific error information related toSOAPBodyElement
objects.
- Returns:
- a
Detail
object with application-specific error information
public String getFaultActor()
Gets the fault actor for thisSOAPFaultException
object.
- Specified by:
- getFaultActor in interface SOAPFault
- Returns:
- a
String
giving the actor in the message path that caused thisSOAPFaultException
object
- See Also:
setFaultActor(java.lang.String)
public String getFaultCode()
Gets the fault code for thisSOAPFaultException
object.
- Specified by:
- getFaultCode in interface SOAPFault
- Returns:
- a
String
with the fault code
public Name getFaultCodeAsName()
- Specified by:
- getFaultCodeAsName in interface SOAPFault
public String getFaultString()
Gets the fault string for thisSOAPFaultException
object.
- Specified by:
- getFaultString in interface SOAPFault
- Returns:
- a
String
giving an explanation of the fault
public Locale getFaultStringLocale()
- Specified by:
- getFaultStringLocale in interface SOAPFault
public void outputImpl(SerializationContext context) throws Exception
override point -output to a serialization context.
- Overrides:
- outputImpl in interface MessageElement
- Parameters:
public void setFaultActor(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 interface SOAPFault
- 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.
public void setFaultCode(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 interface SOAPFault
- 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.
public void setFaultCode(Name faultCodeQName) throws SOAPException
- Specified by:
- setFaultCode in interface SOAPFault
public void setFaultString(String faultString) throws SOAPException
Sets the fault string for thisSOAPFaultException
object to the given string.
- Specified by:
- setFaultString in interface SOAPFault
- 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()
public void setFaultString(String faultString, Locale locale) throws SOAPException
- Specified by:
- setFaultString in interface SOAPFault