Class SOAPFault

protected Detail detail

protected AxisFault fault

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

Advanced constructor used for deserialization.

1. The context provides the mappings and Sax event recorder
2. The soap messaging style is determined from the current message context, defaulting to SOAP1.1 if there is no current context.
3. 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.
4. 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)
5. If there is an arrayType attribute then we assume we are an array and set our MessageElement.typeQName field appropriately.
6. The MessageElement.href field is set if there is a relevant href value

Parameters:

namespace - namespace namespace of element

prefix - prefix prefix of element

context - deserialization context for this message element

Throws:

AxisFault - if the encoding style is not recognized/supported

public SOAPFault(AxisFault fault)

public Detail addDetail()
            throws 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 SOAPFault

Returns:

the new Detail object

Throws:

SOAPException - if this SOAPFaultException object already contains a valid Detail object

public 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 SOAPFault

Returns:

a Detail object with application-specific error information

public AxisFault getFault()

public String getFaultActor()

Gets the fault actor for this SOAPFaultException object.

Specified by:

getFaultActor in interface SOAPFault

Returns:

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

See Also:

setFaultActor(java.lang.String)

public String getFaultCode()

Gets the fault code for this SOAPFaultException 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 this SOAPFaultException 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 setFault(AxisFault fault)

public void setFaultActor(String faultActor)
            throws 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 SOAPFault

Parameters:

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

Throws:

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

public void setFaultCode(String faultCode)
            throws 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 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:

SOAPException - if there was an error in adding the faultCode 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 this SOAPFaultException object to the given string.

Specified by:

setFaultString in interface SOAPFault

Parameters:

faultString - a String giving an explanation of the fault

Throws:

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

See Also:

getFaultString()

public void setFaultString(String faultString,
                           Locale locale)
            throws SOAPException

Specified by:

setFaultString in interface SOAPFault