ProtocolImporter Class

.NET Framework (current version)

Other Versions

Use BaseTrue

Provides common functionality across communication protocols for generating classes for Web services.

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

Inheritance Hierarchy

System.Object
System.Web.Services.Description.ProtocolImporter
System.Web.Services.Description.SoapProtocolImporter

Syntax

C++

[PermissionSetAttribute(SecurityAction.InheritanceDemand, Name = "FullTrust")]
[PermissionSetAttribute(SecurityAction.LinkDemand, Name = "FullTrust")]
public abstract class ProtocolImporter

Constructors

	Name	Description
	ProtocolImporter()	Initializes a new instance of the ProtocolImporter class.

Properties

	Name	Description
	AbstractSchemas	Gets the abstract XML schemas used by the associated ServiceDescriptionImporter instance.
	Binding	Gets the Web Services Description Language (WSDL) binding that the protocol importer is currently processing to generate a class.
	ClassName	Gets the name of the binding class that is currently being generated.
	ClassNames	Gets the CodeIdentifiers object that generates a unique name for the binding class that is currently being generated.
	CodeNamespace	Gets a representation of the .NET Framework namespace of the binding classes that are being generated.
	CodeTypeDeclaration	Gets a representation of the binding class that is currently being generated.
	ConcreteSchemas	Gets the concrete XML schemas used by the associated ServiceDescriptionImporter instance.
	InputMessage	Gets the Web Services Description Language (WSDL) input message for the abstract operation that the protocol importer is currently processing to generate a method in a binding class.
	MethodName	Gets the name of the binding class method which that the protocol importer is currently generating.
	Operation	Gets the abstract Web Services Description Language (WSDL) operation that the protocol importer is currently processing to generate a method in a binding class.
	OperationBinding	Gets the Web Services Description Language (WSDL) operation binding that the protocol importer is currently processing to generate a method in a binding class.
	OutputMessage	Gets the Web Services Description Language (WSDL) output message for the abstract operation that the protocol importer is currently processing to generate a method in a binding class.
	Port	Gets a Web Services Description Language (WSDL) port that contains a reference to the binding that the protocol importer is currently processing to generate a binding class. If more than one port refers to the current binding, the current port is the one in which the binding has most recently been found.
	PortType	Gets the Web Services Description Language (WSDL) PortType that is implemented by the binding that the protocol importer is currently processing to generate a binding class.
	ProtocolName	Abstract property that concrete derived classes must implement to get the name of the protocol being used.
	Schemas	Gets all the XML schemas, both abstract and concrete, used by the associated ServiceDescriptionImporter instance.
	Service	Gets the Web Services Description Language (WSDL) service that contains a reference to the binding that the protocol importer is currently processing to generate a binding class.
	ServiceDescriptions	Gets the ServiceDescriptionCollection objects that belong to the associated ServiceDescriptionImporter instance that are searched for bindings from which to generate binding classes.
	Style	Gets an enumeration value that indicates whether a client proxy class or an abstract server class is being generated. The values are Client and Server. The value is that of the associated ServiceDescriptionImporter instance's Style property.
	Warnings	Gets or sets a ServiceDescriptionImportWarnings enumeration value that indicates the types of warnings, if any, issued by the protocol importer while generating binding classes.

Methods

	Name	Description
	AddExtensionWarningComments(CodeCommentStatementCollection, ServiceDescriptionFormatExtensionCollection)	For each unhandled extension or XML element in the input extensions collection, turns on a RequiredExtensionsIgnored or OptionalExtensionsIgnored warning for each unhandled extension or XML element in the input extensions collection.
	BeginClass()	When overridden in a derived class, initializes the generation of a binding class.
	BeginNamespace()	When overridden in a derived class, performs namespace-wide initialization during code generation.
	EndClass()	When overridden in a derived class, processes a binding class.
	EndNamespace()	When overridden in a derived class, performs processing for an entire namespace.
	Equals(Object)	Determines whether the specified object is equal to the current object.(Inherited from Object.)
	Finalize()	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)
	GenerateMethod()	When overridden in a derived class, generates method code for binding classes.
	GetHashCode()	Serves as the default hash function. (Inherited from Object.)
	GetType()	Gets the Type of the current instance.(Inherited from Object.)
	IsBindingSupported()	When overridden in a derived class, determines whether a class can be generated for the current binding.
	IsOperationFlowSupported(OperationFlow)	When overridden in a derived class, determines whether the current operation's operation flow is supported.
	MemberwiseClone()	Creates a shallow copy of the current Object.(Inherited from Object.)
	OperationBindingSyntaxException(String)	Produces an Exception indicating that the current OperationBinding instance for which a binding class is being generated is invalid within the target namespace.
	OperationSyntaxException(String)	Produces an Exception indicating that the current Operation instance for which a binding class is being generated is invalid within the target namespace.
	ToString()	Returns a string that represents the current object.(Inherited from Object.)
	UnsupportedBindingWarning(String)	Turns on an UnsupportedBindingsIgnored warning in the ServiceDescriptionImportWarnings enumeration obtained through the Warnings property. This method also adds a warning message to the comments for the class that is being generated.
	UnsupportedOperationBindingWarning(String)	Turns on an UnsupportedOperationsIgnored warning in the ServiceDescriptionImportWarnings enumeration obtained through the Warnings property. This method also adds a warning message to the comments for the class that is being generated.
	UnsupportedOperationWarning(String)	Turns on an UnsupportedOperationsIgnored warning in the ServiceDescriptionImportWarnings enumeration obtained through the Warnings property. This method also adds a warning message to the comments for the class that is being generated.

The abstract ProtocolImporter class and its concrete derived classes generate client proxy code or abstract server code according to a specified communication protocol. ProtocolImporter provides common functionality regardless of the protocol. Within a given protocol, a concrete derived class generates a class for each supported binding defined in a Web Services Description Language (WSDL) document. Typically, instead of directly invoking classes derived from ProtocolImporter, a developer uses these classes indirectly through the ServiceDescriptionImporter class.

Version Information

.NET Framework
Available since 1.1

Thread Safety

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