Export (0) Print
Expand All

WebContentTypeMapper Sample

This sample demonstrates how to map new content types to Windows Communication Foundation (WCF) message body formats.

The WebHttpEndpoint element plugs in the Web message encoder, which allows WCF to receive JSON, XML, or raw binary messages at the same endpoint. The encoder determines the body format of the message by looking at the HTTP content-type of the request. This sample introduces the WebContentTypeMapper class, which allows the user to control the mapping between content type and body format.

WCF provides a set of default mappings for content types. For example, application/json maps to JSON and text/xml maps to XML. Any content type that is not mapped to JSON or XML is mapped to raw binary format.

In some scenarios (for example, push-style APIs), the service developer does not control the content type returned by the client. For example, clients might return JSON as text/javascript instead of application/json. In this case, the service developer must provide a type that derives from WebContentTypeMapper to handle the given content type correctly, as shown in the following sample code.

public class JsonContentTypeMapper : WebContentTypeMapper
{
    public override WebContentFormat
               GetMessageFormatForContentType(string contentType)
    {
        if (contentType == "text/javascript")
        {
            return WebContentFormat.Json;
        }
        else
        {
            return WebContentFormat.Default;
        }
    }
}

The type must override the GetMessageFormatForContentType(String) method. The method must evaluate the contentType argument and return one of the following values: Json, Xml, Raw, or Default. Returning Default defers to the default Web message encoder mappings. In the previous sample code, the text/javascript content type is mapped to JSON, and all other mappings remain unchanged.

To use the JsonContentTypeMapper class, use the following in your Web.config:

<system.serviceModel>
  <standardEndpoints>
    <webHttpEndpoint>
      <standardEndpoint name="" contentTypeMapper="Microsoft.Samples.WebContentTypeMapper.JsonContentTypeMapper, JsonContentTypeMapper, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null" />
    </webHttpEndpoint>
  </standardEndpoints>
</system.serviceModel>

To verify the requirement for using the JsonContentTypeMapper, remove the contentTypeMapper attribute from the above configuration file. The client page fails to load when attempting to use text/javascript to send JSON content.

To set up, build, and run the sample

  1. Ensure that you have performed the One-Time Setup Procedure for the Windows Communication Foundation Samples.

  2. Build the solution WebContentTypeMapperSample.sln as described in Building the Windows Communication Foundation Samples.

  3. Navigate to http://localhost/ServiceModelSamples/JCTMClientPage.htm (do not open JCTMClientPage.htm in the browser from within the project directory).

Important note Important

The samples may already be installed on your machine. Check for the following (default) directory before continuing.

<InstallDrive>:\WF_WCF_Samples

If this directory does not exist, go to Windows Communication Foundation (WCF) and Windows Workflow Foundation (WF) Samples for .NET Framework 4 to download all Windows Communication Foundation (WCF) and WF samples. This sample is located in the following directory.

<InstallDrive>:\WF_WCF_Samples\WCF\Extensibility\Ajax\WebContentTypeMapper

Show:
© 2014 Microsoft