ServiceContractGenerator Class

Definition

Namespace:

System.ServiceModel.Description

Assembly:

System.ServiceModel.dll

The ServiceContractGenerator type generates service contract code and binding configurations from ServiceEndpoint description objects.

public ref class ServiceContractGenerator

public class ServiceContractGenerator

type ServiceContractGenerator = class

Public Class ServiceContractGenerator

Inheritance

Object

ServiceContractGenerator

Examples

The following example shows the use of a ServiceContractGenerator to convert downloaded metadata into code.

  static void GenerateCSCodeForService(EndpointAddress metadataAddress, string outputFile)
  {
MetadataExchangeClient mexClient = new MetadataExchangeClient(metadataAddress);
mexClient.ResolveMetadataReferences = true;
MetadataSet metaDocs = mexClient.GetMetadata();

      WsdlImporter importer = new WsdlImporter(metaDocs);
ServiceContractGenerator generator = new ServiceContractGenerator();

// Add our custom DCAnnotationSurrogate
// to write XSD annotations into the comments.
object dataContractImporter;
XsdDataContractImporter xsdDCImporter;
if (!importer.State.TryGetValue(typeof(XsdDataContractImporter), out dataContractImporter))
{
  Console.WriteLine("Couldn't find the XsdDataContractImporter! Adding custom importer.");
  xsdDCImporter = new XsdDataContractImporter();
  xsdDCImporter.Options = new ImportOptions();
  importer.State.Add(typeof(XsdDataContractImporter), xsdDCImporter);
}
else
{
  xsdDCImporter = (XsdDataContractImporter)dataContractImporter;
  if (xsdDCImporter.Options == null)
  {
    Console.WriteLine("There were no ImportOptions on the importer.");
    xsdDCImporter.Options = new ImportOptions();
  }
}
xsdDCImporter.Options.DataContractSurrogate = new DCAnnotationSurrogate();

// Uncomment the following code if you are going to do your work programmatically rather than add
// the WsdlDocumentationImporters through a configuration file.
/*
// The following code inserts a custom WsdlImporter without removing the other
// importers already in the collection.
System.Collections.Generic.IEnumerable<IWsdlImportExtension> exts = importer.WsdlImportExtensions;
System.Collections.Generic.List<IWsdlImportExtension> newExts
  = new System.Collections.Generic.List<IWsdlImportExtension>();
foreach (IWsdlImportExtension ext in exts)
{
  Console.WriteLine("Default WSDL import extensions: {0}", ext.GetType().Name);
  newExts.Add(ext);
}
newExts.Add(new WsdlDocumentationImporter());
System.Collections.Generic.IEnumerable<IPolicyImportExtension> polExts = importer.PolicyImportExtensions;
importer = new WsdlImporter(metaDocs, polExts, newExts);
*/

System.Collections.ObjectModel.Collection<ContractDescription> contracts
  = importer.ImportAllContracts();
importer.ImportAllEndpoints();
      foreach (ContractDescription contract in contracts)
      {
          generator.GenerateServiceContractType(contract);
      }
if (generator.Errors.Count != 0)
  throw new Exception("There were errors during code compilation.");

// Write the code dom
System.CodeDom.Compiler.CodeGeneratorOptions options
  = new System.CodeDom.Compiler.CodeGeneratorOptions();
      options.BracingStyle = "C";
      System.CodeDom.Compiler.CodeDomProvider codeDomProvider
  = System.CodeDom.Compiler.CodeDomProvider.CreateProvider("C#");
      System.CodeDom.Compiler.IndentedTextWriter textWriter
  = new System.CodeDom.Compiler.IndentedTextWriter(new System.IO.StreamWriter(outputFile));
      codeDomProvider.GenerateCodeFromCompileUnit(
  generator.TargetCompileUnit, textWriter, options
);
      textWriter.Close();
  }

Remarks

Use the ServiceContractGenerator to create tools or to modify the default contract generation process using an System.ServiceModel.Description.IWsdlImportExtension.

Constructors

ServiceContractGenerator()	Initializes a new instance of the ServiceContractGenerator class with a new CodeCompileUnit instance.
ServiceContractGenerator(CodeCompileUnit)	Initializes a new instance of the ServiceContractGenerator class with the specified CodeCompileUnit instance.
ServiceContractGenerator(CodeCompileUnit, Configuration)	Initializes a new instance of the ServiceContractGenerator class with the specified CodeCompileUnit instance and the specified Configuration instance.
ServiceContractGenerator(Configuration)	Initializes a new instance of the ServiceContractGenerator class with the specified Configuration instance.

Properties

Configuration	Gets the Configuration instance that contains the generated binding configurations.
Errors	Gets a collection of MetadataConversionError objects generated when generating service contract code and endpoint configurations.
NamespaceMappings	Gets a mapping from contract description namespaces to managed namespaces that is used when generating code.
Options	Gets or sets options for generating service contract code.
ReferencedTypes	Gets a mapping from contract descriptions to referenced contract types.
TargetCompileUnit	Gets the target CodeCompileUnit object for generating service contract code.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GenerateBinding(Binding, String, String)	Generates a binding configuration for the specified Binding instance.
GenerateServiceContractType(ContractDescription)	Generates a service contract type from the specified ContractDescription instance.
GenerateServiceEndpoint(ServiceEndpoint, ChannelEndpointElement)	Generates a service contract type and an endpoint configuration from the specified ServiceEndpoint instance.
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)