SoapExtension Class

The base class for SOAP extensions for XML Web services created using ASP.NET.

System.Object
  System.Web.Services.Protocols.SoapExtension

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

[<AbstractClass>]
type SoapExtension =  class end

The SoapExtension type exposes the following members.

  NameDescription
Protected methodSoapExtensionInitializes a new instance of the SoapExtension class.
Top

  NameDescription
Public methodChainStreamWhen overridden in a derived class, allows a SOAP extension access to the memory buffer containing the SOAP request or response.
Public methodEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Protected methodFinalizeAllows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.)
Public methodGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodGetInitializer(Type)When overridden in a derived class, allows a SOAP extension to initialize data specific to a class implementing an XML Web service at a one time performance cost.
Public methodGetInitializer(LogicalMethodInfo, SoapExtensionAttribute)When overridden in a derived class, allows a SOAP extension to initialize data specific to an XML Web service method using an attribute applied to the XML Web service method at a one time performance cost.
Public methodGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodInitializeWhen overridden in a derived class, allows a SOAP extension to initialize itself using the data cached in the GetInitializer method.
Protected methodMemberwiseCloneCreates a shallow copy of the current Object. (Inherited from Object.)
Public methodProcessMessageWhen overridden in a derived class, allows a SOAP extension to receive a SoapMessage to process at each SoapMessageStage.
Public methodToStringReturns a string that represents the current object. (Inherited from Object.)
Top

ASP.NET allows a SOAP-related infrastructure to be built by means of an extensibility mechanism. The ASP.NET SOAP extension architecture revolves around an extension that can inspect or modify a message at specific stages in message processing on either the client or the server.

ASP.NET SOAP extensions derive from the SoapExtension class. The GetInitializer and Initialize methods provide alternative mechanisms for initializing the SOAP extension to enhance performance. ProcessMessage is the heart of most SOAP extensions, as the method is called at each stage defined in SoapMessageStage, allowing the SOAP extension to perform the desired behavior of that specific SOAP extension. For SOAP extensions that need to modify the SOAP request or SOAP response, ChainStream provides an opportunity to receive the proposed data to be sent across the wire.

The following TraceExtension SOAP extension outputs the SOAP request and SOAP response to a specified file when applied to an XML Web service method. If the following SOAP extension is installed to run with an XML Web service, the ASPNET user account must have permission to write to the directory in which the log file is written.

No code example is currently available or this language may not be supported.

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0, 2.0, 1.1

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.
Was this page helpful?
(1500 characters remaining)
Thank you for your feedback
Show:
© 2015 Microsoft