Skip to main content

Generating a WCF Client from Service Metadata

This topic describes how to use the various switches in Svcutil.exe to generate clients from metadata documents.
Metadata documents can be on a durable storage or be retrieved online. Online retrieval follows either the WS-MetadataExchange protocol or the Microsoft Discovery (DISCO) protocol. Svcutil.exe issues the following metadata requests simultaneously to retrieve metadata:
  • WS-MetadataExchange (MEX) request to the supplied address.
  • MEX request to the supplied address with /mex appended.
  • DISCO request (using the DiscoveryClientProtocol from ASP.NET Web services) to the supplied address.
Svcutil.exe generates the client based on the Web Services Description Language (WSDL) or policy file received from the service. The user principal name (UPN) is generated by concatenating the user name with "@" and then adding a fully-qualified domain name (FQDN). However, for users who registered on Active Directory, this format is not valid and the UPN that the tool generates causes a failure in the Kerberos authentication with the following error message: The logon attempt failed. To resolve this problem, manually fix the client file that the tool generated.
svcutil.exe [/t:code]  <metadataDocumentPath>* | <url>* | <epr>

Option
Description
/reference:<file path>
References types in the specified assembly. When generating clients, use this option to specify assemblies that might contain types that represent the metadata being imported.
Short form: /r
/excludeType:<type>
Specifies a fully-qualified or assembly-qualified type name to be excluded from referenced contract types.
Short form: /et

Option
Description
/serializer:Auto
Automatically selects the serializer. This uses the DataContract serializer. If this fails, the XmlSerializer is used.
Short Form: /ser:Auto
/serializer:DataContractSerializer
Generates data types that use the DataContract serializer for serialization and deserialization.
Short form: /ser:DataContractSerializer
/serializer:XmlSerializer
Generates data types that use the XmlSerializer for serialization and deserialization.
Short form: /ser:XmlSerializer
/importXmlTypes
Configures the DataContract serializer to import non-DataContract types as IXmlSerializable types.
Short form: /ixt
/dataContractOnly
Generates code for DataContract types only. ServiceContract types are generated.
You should specify only local metadata files for this option.
Short form: /dconly

Option
Description
/language:<language>
Specifies the programming language to use for code generation. Provide either a language name registered in the Machine.config file or the fully-qualified name of a class that inherits from CodeDomProvider.
Values: c#, cs, csharp, vb, vbs, visualbasic, vbscript, javascript, c++, mc, cpp
Default: csharp
Short form: /l
For more information, see CodeDomProvider Class.

Option
Description
/namespace:<string,string>
Specifies a mapping from a WSDL or XML Schema targetNamespace to a common language runtime (CLR) namespace. Using a wildcard (*) for the targetNamespace maps all targetNamespaces without an explicit mapping to that CLR namespace.
To make sure that the message contract name does not collide with the operation name, either qualify the type reference with double colons (::) or make sure the names are unique.
Default: Derived from the target namespace of the schema document for DataContracts. The default namespace is used for all other generated types.
Short form: /n

Option
Description
/enableDataBinding
Implements the INotifyPropertyChanged interface on all DataContract types to enable data binding.
Short form: /edb

Option
Description
/config:<configFile>
Specifies the file name for the generated configuration file.
Default: output.config
/mergeConfig
Merges the generated configuration into an existing file, instead of overwriting the existing file.
/noConfig
Do not generate configuration files.


Labels:

Comments

Post a Comment

Popular posts from this blog

Tip/Trick: Fix Common SEO Problems Using the URL Rewrite Extension

Search engine optimization (SEO) is important for any publically facing web-site.  A large % of traffic to sites now comes directly from search engines, and improving your site’s search relevancy will lead to more users visiting your site from search engine queries.  This can directly or indirectly increase the money you make through your site. This blog post covers how you can use the free Microsoft  URL Rewrite Extension  to fix a bunch of common SEO problems that your site might have.  It takes less than 15 minutes (and no code changes) to apply 4 simple  URL Rewrite  rules to your site, and in doing so cause search engines to drive more visitors and traffic to your site.  The techniques below work equally well with both ASP.NET Web Forms and ASP.NET MVC based sites.  They also works with all versions of ASP.NET (and even work with non-ASP.NET content). [In addition to blogging, I am also now using Twitter for quick updates and to sh...
Post a Comment
Read more

ASP.NET MVC - Set custom IIdentity or IPrincipal

Here's how I do it. I decided to use IPrincipal instead of IIdentity because it means I don't have to implement both IIdentity and IPrincipal. Create the interface interface ICustomPrincipal : IPrincipal { int UserId { get ; set ; } string FirstName { get ; set ; } string LastName { get ; set ; } } CustomPrincipal public class CustomPrincipal : ICustomPrincipal { public IIdentity Identity { get ; private set ; } public bool IsInRole ( string role ) { return false ; } public CustomPrincipal ( string email ) { this . Identity = new GenericIdentity ( email ); } public int UserId { get ; set ; } public string FirstName { get ; set ; } public string LastName { get ; set ; } } CustomPrincipalSerializeModel - for serializing custom information into userdata field in FormsAuthenticationTicket object. public class CustomPrincipalSerializeMode...
8 comments
Read more

linq orderby multiple columns dynamically

So, it's been a while, but I thought I take moment and do my annual blog post ;). I've been playing around with  ASP.NET MVC  and the Linq stuff for  NHibernate  recently. I was in need of an OrderBy extension method that could take a SQL-Like OrderBy string and sort a IQueryable<> or IEnumerable<> collection. I wrote up an implementation that worked, but I just wasn't satisfied with its internals (quite a bit of reflection to get the correct type to construct a LambdaExpression, etc) At any rate, I couldn't leave well enough alone, and, after a bit of Googling, I ran across this  StackOverflow  answer about Dynamic LINQ OrderBy . The extension method wasn't exactly what I was looking for, but that ApplyOrder method is slick, and solved the portion of my implementation that was bothering me. So, I though I would post up my version in case anybody finds it useful. It handles the following inputs: list.OrderBy( "SomeProperty" ); list.Ord...
2 comments
Read more