javax.xml.soap
Interface SOAPFault
- org.w3c.dom.Element, Node, SOAPBodyElement, SOAPElement
- SOAPFault
public interface SOAPFault
An element in the
SOAPBody
object that contains
error and/or status information. This information may relate to
errors in the
SOAPMessage
object or to problems
that are not related to the content in the message itself.
Problems not related to the message itself are generally errors
in processing, such as the inability to communicate with an
upstream server.
The
SOAPFault
interface provides methods for
retrieving the information contained in a
SOAPFault
object and for setting the fault code, the
fault actor, and a string describing the fault. A fault code is
one of the codes defined in the SOAP 1.1 specification that
describe the fault. An actor is an intermediate recipient to
whom a message was routed. The message path may include one or
more actors, or, if no actors are specified, the message goes
only to the default actor, which is the final intended
recipient.
abstract Detail | addDetail() - Creates a
Detail object and sets it as the
Detail object for this SOAPFault
object.
|
abstract Detail | getDetail() - Returns the detail element for this
SOAPFault
object.
|
abstract String | getFaultActor() - Gets the fault actor for this
SOAPFault
object.
|
abstract String | getFaultCode() - Gets the fault code for this
SOAPFault
object.
|
abstract Name | getFaultCodeAsName() - Gets the mandatory SOAP 1.1 fault code for this
SOAPFault
object as a SAAJ Name object.
|
abstract String | getFaultString() - Gets the fault string for this
SOAPFault
object.
|
abstract Locale | getFaultStringLocale() - Returns the optional detail element for this
SOAPFault
object.
|
abstract void | setFaultActor(String faultActor) - Sets this
SOAPFault object with the given
fault actor.
|
abstract void | setFaultCode(String faultCode) - Sets this
SOAPFault object with the given
fault code.
|
abstract void | setFaultCode(Name name) - Sets this
SOAPFault object with the given fault code.
|
abstract void | setFaultString(String faultString) - Sets the fault string for this
SOAPFault
object to the given string.
|
abstract void | setFaultString(String faultString, Locale locale) - Sets the fault string for this
SOAPFault object to the given
string and localized to the given locale.
|
addAttribute , addChildElement , addChildElement , addChildElement , addChildElement , addChildElement , addNamespaceDeclaration , addTextNode , getAllAttributes , getAttributeValue , getChildElements , getChildElements , getElementName , getEncodingStyle , getNamespacePrefixes , getNamespaceURI , getVisibleNamespacePrefixes , removeAttribute , removeContents , removeNamespaceDeclaration , setEncodingStyle |
addDetail
public abstract Detail addDetail()
throws SOAPException
Creates a
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.
SOAPException
- if this
SOAPFault
object already contains a valid
Detail
object
getDetail
public abstract Detail getDetail()
Returns the detail element for this
SOAPFault
object.
A
Detail
object carries
application-specific error information related to
SOAPBodyElement
objects.
- a
Detail
object with
application-specific error information
getFaultActor
public abstract String getFaultActor()
Gets the fault actor for this SOAPFault
object.
- a
String
giving the actor in the message
path that caused this SOAPFault
object
setFaultActor(java.lang.String)
getFaultCode
public abstract String getFaultCode()
Gets the fault code for this SOAPFault
object.
- a
String
with the fault code
setFaultCode(java.lang.String)
getFaultCodeAsName
public abstract Name getFaultCodeAsName()
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.
In the future, a QName object version of this method may also be added.
- a
Name
representing the faultcode
getFaultString
public abstract String getFaultString()
Gets the fault string for this SOAPFault
object.
- a
String
giving an explanation of the
fault
getFaultStringLocale
public abstract Locale getFaultStringLocale()
Returns the optional detail element for this SOAPFault
object.
- a
Locale
object indicating the native language of
the fault string or null
if no locale was
specified
setFaultActor
public abstract void setFaultActor(String faultActor)
throws SOAPException
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.
faultActor
- a String
identifying the actor that caused this
SOAPFault
object
SOAPException
- if there was an error in
adding the faultActor
to the underlying XML
tree.
setFaultCode
public abstract void setFaultCode(String faultCode)
throws SOAPException
Sets this
SOAPFault
object with the given
fault code.
Fault codes, which given information about the fault,
are defined in the SOAP 1.1 specification.
faultCode
- a String
giving
the fault code to be set; must be one of the fault codes
defined in the SOAP 1.1 specification
SOAPException
- if there was an error in
adding the faultCode
to the underlying XML
tree.
setFaultCode
public abstract void setFaultCode(Name name)
throws SOAPException
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
QName
. 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);
It is preferable to use this method over setFaultCode(String).
name
- a Name
object giving the fault code to be set.
It must be namespace qualified.
SOAPException
- if there was an error in adding the
faultcode
element to the underlying XML tree
setFaultString
public abstract void setFaultString(String faultString)
throws SOAPException
Sets the fault string for this SOAPFault
object to the given string.
faultString
- a String
giving an explanation of the fault
SOAPException
- if there was an error in
adding the faultString
to the underlying XML
tree.
setFaultString
public abstract void setFaultString(String faultString,
Locale locale)
throws SOAPException
Sets the fault string for this SOAPFault
object to the given
string and localized to the given locale.
faultString
- a String
giving an explanation of
the faultlocale
- a Locale
object indicating the
native language of the faultString
SOAPException
- if there was an error in adding the
faultString
to the underlying XML tree
Copyright © 2005 Apache Web Services Project. All Rights Reserved.