public Interface SOAPFault

Creates an optional Detail object and sets it as the Detail object for this SOAPFault 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:Detail

the new Detail object

Exceptions

SOAPException:

if this SOAPFault object already contains a valid Detail object

Appends or replaces a Reason Text item containing the specified text message and an xml:lang derived from locale. If a Reason Text item with this xml:lang already exists its text value will be replaced with text. The locale parameter should not be null

Code sample:

SOAPFault fault = ...;
fault.addFaultReasonText("Version Mismatch", Locale.ENGLISH);

Parameters

text:String

-- reason message string

locale:Locale

-- Locale object representing the locale of the message

Exceptions

SOAPException:

if there was an error in adding the Reason text or the locale passed was null.

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Fault Reason.

Since

1.6, SAAJ 1.3

Adds a Subcode to the end of the sequence of Subcodes contained by this SOAPFault. Subcodes, which were introduced in SOAP 1.2, are represented by a recursive sequence of subelements rooted in the mandatory Code subelement of a SOAP Fault.

Parameters

subcode:QName

a QName containing the Value of the Subcode.

Exceptions

SOAPException:

if there was an error in setting the Subcode

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Subcode.

Since

1.6, SAAJ 1.3

Returns the optional detail element for this SOAPFault object.

A Detail object carries application-specific error information, the scope of the error information is restricted to faults in the SOAPBodyElement objects if this is a SOAP 1.1 Fault.

Returns:Detail

a Detail object with application-specific error information if present, null otherwise

Gets the fault actor for this SOAPFault object.

If this SOAPFault supports SOAP 1.2 then this call is equivalent to getFaultRole()

Returns:String

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

See Also

setFaultActor

Gets the fault code for this SOAPFault object.

Returns:String

a String with the fault code

See Also

getFaultCodeAsName, setFaultCode

Gets the mandatory SOAP 1.1 fault code for this SOAPFault object as a SAAJ Name 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 SAAJ Name object. This method should be used instead of the getFaultCode method since it allows applications to easily access the namespace name without additional parsing.

Returns:Name

a Name representing the faultcode

Since

1.6, SAAJ 1.2

See Also

setFaultCode(Name)

Gets the fault code for this SOAPFault object as a QName object.

Returns:QName

a QName representing the faultcode

Since

1.6, SAAJ 1.3

See Also

setFaultCode(QName)

Returns the optional Node element value for this SOAPFault object. The Node element is optional in SOAP 1.2.

Returns:String

Content of the env:Fault/env:Node element as a String or null if none

Exceptions

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Fault Node.

Since

1.6, SAAJ 1.3

Returns an Iterator over a distinct sequence of Locales for which there are associated Reason Text items. Any of these Locales can be used in a call to getFaultReasonText in order to obtain a localized version of the Reason Text string.

Returns:Iterator<Locale>

an Iterator over a sequence of Locale objects for which there are associated Reason Text items.

Exceptions

SOAPException:

if there was an error in retrieving the fault Reason locales.

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Fault Reason.

Since

1.6, SAAJ 1.3

Returns the Reason Text associated with the given Locale. If more than one such Reason Text exists the first matching Text is returned

Parameters

locale:Locale

-- the Locale for which a localized Reason Text is desired

Returns:String

the Reason Text associated with locale

Exceptions

SOAPException:

if there was an error in retrieving the fault Reason text for the specified locale .

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Fault Reason.

Since

1.6, SAAJ 1.3

See Also

getFaultString

Returns an Iterator over a sequence of String objects containing all of the Reason Text items for this SOAPFault.

Returns:Iterator<String>

an Iterator over env:Fault/env:Reason/env:Text items.

Exceptions

SOAPException:

if there was an error in retrieving the fault Reason texts.

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Fault Reason.

Since

1.6, SAAJ 1.3

Returns the optional Role element value for this SOAPFault object. The Role element is optional in SOAP 1.2.

Returns:String

Content of the env:Fault/env:Role element as a String or null if none

Exceptions

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Fault Role.

Since

1.6, SAAJ 1.3

Gets the fault string for this SOAPFault object.

If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to:

String reason = null;
   try {
       reason = (String) getFaultReasonTexts().next();
   } catch (SOAPException e) {}
   return reason;

Returns:String

a String giving an explanation of the fault

See Also

setFaultString(String), setFaultString(String, Locale)

Gets the locale of the fault string for this SOAPFault object.

If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to:

Locale locale = null;
   try {
       locale = (Locale) getFaultReasonLocales().next();
   } catch (SOAPException e) {}
   return locale;

Returns:Locale

a Locale object indicating the native language of the fault string or null if no locale was specified

Since

1.6, SAAJ 1.2

See Also

setFaultString(String, Locale)

Gets the Subcodes for this SOAPFault as an iterator over QNames.

Returns:Iterator<QName>

an Iterator that accesses a sequence of QNames. This Iterator should not support the optional remove method. The order in which the Subcodes are returned reflects the hierarchy of Subcodes present in the fault from top to bottom.

Exceptions

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Subcode.

Since

1.6, SAAJ 1.3

Returns true if this SOAPFault has a Detail subelement and false otherwise. Equivalent to (getDetail()!=null).

Returns:boolean

true if this SOAPFault has a Detail subelement and false otherwise.

Since

1.6, SAAJ 1.3

Removes any Subcodes that may be contained by this SOAPFault. Subsequent calls to getFaultSubcodes will return an empty iterator until a call to appendFaultSubcode is made.

Exceptions

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Subcode.

Since

1.6, SAAJ 1.3

Sets this SOAPFault object with the given fault actor.

The fault actor is the recipient in the message path who caused the fault to happen.

If this SOAPFault supports SOAP 1.2 then this call is equivalent to setFaultRole(String)

Parameters

faultActor:String

a String identifying the actor that caused this SOAPFault object

Exceptions

SOAPException:

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

See Also

getFaultActor

Sets this SOAPFault 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 type Name. 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);

Parameters

faultCodeQName:Name

a Name object giving the fault code to be set. It must be namespace qualified.

Exceptions

SOAPException:

if there was an error in adding the faultcode element to the underlying XML tree.

Since

1.6, SAAJ 1.2

See Also

getFaultCodeAsName

Sets this SOAPFault object with the given fault code. It is preferable to use this method over setFaultCode(Name).

Parameters

faultCodeQName:QName

a QName object giving the fault code to be set. It must be namespace qualified.

Exceptions

SOAPException:

if there was an error in adding the faultcode element to the underlying XML tree.

Since

1.6, SAAJ 1.3

See Also

getFaultCodeAsQName, setFaultCode(Name), getFaultCodeAsQName()

Sets this SOAPFault object with the give fault code.

Fault codes, which given information about the fault, are defined in the SOAP 1.1 specification. This element is mandatory in SOAP 1.1. Because the fault code is required to be a QName it is preferable to use the setFaultCode(Name) form of this method.

Parameters

faultCode:String

a String giving the fault code to be set. It must be of the form "prefix:localName" where the prefix has been defined in a namespace declaration.

Exceptions

SOAPException:

if there was an error in adding the faultCode to the underlying XML tree.

See Also

setFaultCode(Name), getFaultCode, SOAPElement#addNamespaceDeclaration

Creates or replaces any existing Node element value for this SOAPFault object. The Node element is optional in SOAP 1.2.

Parameters

uri:String

the URI of the Node

Exceptions

SOAPException:

if there was an error in setting the Node for this SOAPFault object.

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Fault Node.

Since

1.6, SAAJ 1.3

Creates or replaces any existing Role element value for this SOAPFault object. The Role element is optional in SOAP 1.2.

Parameters

uri:String

the URI of the Role

Exceptions

SOAPException:

if there was an error in setting the Role for this SOAPFault object.

UnsupportedOperationException:

if this message does not support the SOAP 1.2 concept of Fault Role.

Since

1.6, SAAJ 1.3

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

If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to:

addFaultReasonText(faultString, Locale.getDefault());

Parameters

faultString:String

a String giving an explanation of the fault

Exceptions

SOAPException:

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

See Also

getFaultString

Sets the fault string for this SOAPFault object to the given string and localized to the given locale.

If this SOAPFault is part of a message that supports SOAP 1.2 then this call is equivalent to:

addFaultReasonText(faultString, locale);

Parameters

faultString:String

a String giving an explanation of the fault

locale:Locale

a Locale object indicating the native language of the faultString

Exceptions

SOAPException:

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

Since

1.6, SAAJ 1.2

See Also

getFaultString