SoapException Class

Definition

Namespace:

System.Web.Services.Protocols

Assembly:

System.Web.Services.dll

Represents the exception that is thrown when an XML Web service method is called over SOAP and an exception occurs.

public ref class SoapException : SystemException

[System.Serializable]
public class SoapException : SystemException

[<System.Serializable>]
type SoapException = class
    inherit SystemException

Public Class SoapException
Inherits SystemException

Inheritance

Object

Exception

SystemException

SoapException

Derived

System.Web.Services.Protocols.SoapHeaderException

Attributes

SerializableAttribute

Examples

The following example throws a SoapException where the XML Web service method sets the Detail property.

<%@ WebService Language="C#" class="ThrowSoapException"%>

using System;
using System.Web.Services;
using System.Web.Services.Protocols;
using System.Xml.Serialization;
using System.Xml;

public class ThrowSoapException : WebService 
{
//    This XML Web service method generates a SOAP Client Fault code 
    [WebMethod]
    public void myThrow(){

        // Build the detail element of the SOAP fault.
        System.Xml.XmlDocument doc = new System.Xml.XmlDocument();
        System.Xml.XmlNode node = doc.CreateNode(XmlNodeType.Element, SoapException.DetailElementName.Name, SoapException.DetailElementName.Namespace);


        // Build specific details for the SoapException.
        // Add first child of detail XML element.
        System.Xml.XmlNode details = doc.CreateNode(XmlNodeType.Element, "mySpecialInfo1", "http://tempuri.org/");
        System.Xml.XmlNode detailsChild = doc.CreateNode(XmlNodeType.Element, "childOfSpecialInfo", "http://tempuri.org/");
        details.AppendChild(detailsChild);

            
        // Add second child of detail XML element with an attribute.
        System.Xml.XmlNode details2 = doc.CreateNode(XmlNodeType.Element, "mySpecialInfo2", "http://tempuri.org/");
        XmlAttribute attr = doc.CreateAttribute("t", "attrName", "http://tempuri.org/");
        attr.Value = "attrValue";
        details2.Attributes.Append(attr);

        // Append the two child elements to the detail node.
        node.AppendChild(details);
        node.AppendChild(details2);

            
        //Throw the exception.    
        SoapException se = new SoapException("Fault occurred", SoapException.ClientFaultCode,Context.Request.Url.AbsoluteUri,node);

        throw se;
        return;    }
}

<%@ WebService Language="VB" class="ThrowSoapException"%>

Imports System
Imports System.Web.Services
Imports System.Web.Services.Protocols
Imports System.Xml.Serialization
Imports System.Xml

Public Class ThrowSoapException
    Inherits WebService
    
    ' This XML Web service method generates a SOAP Client Fault code 
    <WebMethod()> _
    Public Sub myThrow()
        
        ' Build the detail element of the SOAP fault.
        Dim doc As New System.Xml.XmlDocument()
        Dim node As System.Xml.XmlNode = doc.CreateNode(XmlNodeType.Element, _
            SoapException.DetailElementName.Name, _
            SoapException.DetailElementName.Namespace)
 
        ' Build specific details for the SoapException.
        ' Add first child of detail XML element.
        Dim details As System.Xml.XmlNode = doc.CreateNode(XmlNodeType.Element, _
            "mySpecialInfo1", "http://tempuri.org/")

        ' Add second child of detail XML element with an attribute.
        Dim details2 As System.Xml.XmlNode = doc.CreateNode(XmlNodeType.Element, _
            "mySpecialInfo2", "http://tempuri.org/")
        Dim attr As XmlAttribute = doc.CreateAttribute("t", "attrName", _
            "http://tempuri.org/")
        attr.Value = "attrValue"
        details2.Attributes.Append(attr)

        ' Append the two child elements to the detail node.
        node.AppendChild(details)
        node.AppendChild(details2)
                
        'Throw the exception    
        Dim se As New SoapException("Fault occurred", SoapException.ClientFaultCode, _
                                    Context.Request.Url.AbsoluteUri, node)
        Throw se
        Return
    End Sub
End Class

Remarks

The SoapException can either be thrown by the common language runtime or by an XML Web service method. The common language runtime can throw a SoapException if a response to a request is not formatted correctly. XML Web service methods can generate a SoapException by simply throwing an exception within the XML Web service method. If the client accessed the method over SOAP, the exception is caught on the server and wrapped inside a new SoapException. The SoapException thrown has the following property values:

Property	Value
Message	The Message property of the original exception.
Code	ServerFaultCode.
Actor	The URL of the XML Web service method.
Detail	null, but an empty detail element is present in the fault element.

An XML Web service method might throw a SoapException when clients call using SOAP. If an XML Web service throws the SoapException, other details can be added through the Actor, Code and Detail properties that cannot otherwise be set by an XML Web service method if another type of exception is thrown.

Constructors

SoapException()	Initializes a new instance of the SoapException class.
SoapException(SerializationInfo, StreamingContext)	Initializes a new instance of the SoapException class with serialized data.
SoapException(String, XmlQualifiedName)	Initializes a new instance of the SoapException class with the specified exception message and exception code.
SoapException(String, XmlQualifiedName, Exception)	Initializes a new instance of the SoapException class with the specified exception message, exception code, and reference to the root cause of the exception.
SoapException(String, XmlQualifiedName, SoapFaultSubCode)	Initializes a new instance of the SoapException class with the specified exception message, exception code, and subcode.
SoapException(String, XmlQualifiedName, String)	Initializes a new instance of the SoapException class with the specified exception message, exception code, and URI that identifies the piece of code that caused the exception.
SoapException(String, XmlQualifiedName, String, Exception)	Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the code that caused the exception, and reference to the root cause of the exception.
SoapException(String, XmlQualifiedName, String, String, String, XmlNode, SoapFaultSubCode, Exception)	Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, URI that represents the XML Web service's function in processing the SOAP message, the human language associated with the exception, the application-specific exception information, the subcode for the SOAP fault and reference to the root cause of the exception.
SoapException(String, XmlQualifiedName, String, String, XmlNode, SoapFaultSubCode, Exception)	Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, application-specific exception information, and reference to the root cause of the exception.
SoapException(String, XmlQualifiedName, String, XmlNode)	Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, and application specific exception information.
SoapException(String, XmlQualifiedName, String, XmlNode, Exception)	Initializes a new instance of the SoapException class with the specified exception message, exception code, URI that identifies the piece of code that caused the exception, application-specific exception information, and reference to the root cause of the exception.

Fields

ClientFaultCode	Specifies a SOAP fault code that represents a client call that is not formatted correctly or does not contain the appropriate information.
DetailElementName	Gets an XmlQualifiedName that represents the Detail element of a SOAP Fault code.
MustUnderstandFaultCode	A SOAP Fault Code that represents a SOAP element marked with the MustUnderstand attribute was not processed.
ServerFaultCode	Specifies that a SOAP fault code that represents an error occurred during the processing of a client call on the server, where the problem is not due to the message contents.
VersionMismatchFaultCode	A SOAP fault code that represents an invalid namespace for a SOAP envelope was found during the processing of the SOAP message.

Properties

Actor	Gets the piece of code that caused the exception.
Code	Gets the type of SOAP fault code.
Data	Gets a collection of key/value pairs that provide additional user-defined information about the exception. (Inherited from Exception)
Detail	Gets an XmlNode that represents the application-specific error information details.
HelpLink	Gets or sets a link to the help file associated with this exception. (Inherited from Exception)
HResult	Gets or sets HRESULT, a coded numerical value that is assigned to a specific exception. (Inherited from Exception)
InnerException	Gets the Exception instance that caused the current exception. (Inherited from Exception)
Lang	Gets the human language associated with the exception.
Message	Gets a message that describes the current exception. (Inherited from Exception)
Node	Gets a URI that represents the piece of code that caused the exception.
Role	Gets a URI that represents the XML Web service's function in processing the SOAP message.
Source	Gets or sets the name of the application or the object that causes the error. (Inherited from Exception)
StackTrace	Gets a string representation of the immediate frames on the call stack. (Inherited from Exception)
SubCode	Gets the optional error information contained in the subcode XML element of a SOAP fault.
TargetSite	Gets the method that throws the current exception. (Inherited from Exception)

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetBaseException()	When overridden in a derived class, returns the Exception that is the root cause of one or more subsequent exceptions. (Inherited from Exception)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetObjectData(SerializationInfo, StreamingContext)	Sets the SerializationInfo with information about the exception.
GetType()	Gets the runtime type of the current instance. (Inherited from Exception)
IsClientFaultCode(XmlQualifiedName)	Returns a value that indicates whether the SOAP fault code is equivalent to the Client SOAP fault code regardless of the version of the SOAP protocol used.
IsMustUnderstandFaultCode(XmlQualifiedName)	Returns a value that indicates whether the SOAP fault code is equivalent to MustUnderstand regardless of the version of the SOAP protocol used.
IsServerFaultCode(XmlQualifiedName)	Returns a value that indicates whether the SOAP fault code is equivalent to the Server SOAP fault code regardless of the version of the SOAP protocol used.
IsVersionMismatchFaultCode(XmlQualifiedName)	Returns a value that indicates whether the SOAP fault code is equivalent to the VersionMismatch SOAP fault code regardless of the version of the SOAP protocol used.
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Creates and returns a string representation of the current exception. (Inherited from Exception)

Events

SerializeObjectState

Occurs when an exception is serialized to create an exception state object that contains serialized data about the exception. (Inherited from Exception)