SoapHeader Class

 

When overridden in a derived class, represents the content of a SOAP header.

Namespace:   System.Web.Services.Protocols
Assembly:  System.Web.Services (in System.Web.Services.dll)

System.Object
  System.Web.Services.Protocols.SoapHeader
    System.Web.Services.Protocols.SoapUnknownHeader

public abstract class SoapHeader

NameDescription
System_CAPS_protmethodSoapHeader()

Initializes a new instance of the SoapHeader class.

NameDescription
System_CAPS_pubpropertyActor

Gets or sets the recipient of the SOAP header.

System_CAPS_pubpropertyDidUnderstand

Gets or sets a value indicating whether an XML Web service method properly processed a SOAP header.

System_CAPS_pubpropertyEncodedMustUnderstand

Gets or sets the value of the mustUnderstand XML attribute for the SOAP header when communicating with SOAP protocol version 1.1.

System_CAPS_pubpropertyEncodedMustUnderstand12

Gets or sets the value of the mustUnderstand XML attribute for the SOAP header when communicating with SOAP protocol version 1.2.

System_CAPS_pubpropertyEncodedRelay

Gets or sets the relay attribute of the SOAP 1.2 header.

System_CAPS_pubpropertyMustUnderstand

Gets or sets a value indicating whether the SoapHeader must be understood.

System_CAPS_pubpropertyRelay

Gets or sets a value that indicates whether the SOAP header is to be relayed to the next SOAP node if the current node does not understand the header.

System_CAPS_pubpropertyRole

Gets or sets the recipient of the SOAP header.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

SOAP headers offer a method for passing data to and from an XML Web service method if the data is not directly related to the XML Web service method's primary functionality. For instance, an XML Web service might contain several XML Web service methods that each require a custom authentication scheme. Instead of adding parameters to each XML Web service method for the custom authentication scheme, a SoapHeaderAttribute, referring to a class deriving from SoapHeader, can be applied to each XML Web service method. The implementation for the class deriving from SoapHeader handles the custom authentication scheme. In this manner, the XML Web service method implements only the functionality specific to it and adds additional functionality using a SOAP header.

The following list outlines the basic steps to receiving and processing a SOAP header:

  1. Create a class that derives from SoapHeader representing the data passed into the SOAP header.

  2. Add a member to the class implementing an XML Web service or an XML Web service client proxy class, of the type created in the first step.

  3. Apply a SoapHeaderAttribute to the XML Web service method or the corresponding method in the proxy class, specifying the member created in the second step in the MemberName property.

  4. Within the XML Web service method or XML Web service client code, access the MemberName property to process the data sent in the SOAP header.

The following MyWebService XML Web service defines the MyHeader SOAP header and requires it to be sent with any calls to the MyWebMethod XML Web service method. Additionally, MyWebMethod receives any SOAP headers other than the MyHeader SOAP header.

.NET Framework
Available since 1.1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: