WebMessageEncodingBindingElement Class

Reference

Definition

Namespace:: System.ServiceModel.Channels

Assembly:: System.ServiceModel.Web.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Enables plain-text XML, JavaScript Object Notation (JSON) message encodings and "raw" binary content to be read and written when used in a Windows Communication Foundation (WCF) binding.

public ref class WebMessageEncodingBindingElement sealed : System::ServiceModel::Channels::MessageEncodingBindingElement, System::ServiceModel::Description::IWsdlExportExtension

public sealed class WebMessageEncodingBindingElement : System.ServiceModel.Channels.MessageEncodingBindingElement, System.ServiceModel.Description.IWsdlExportExtension

type WebMessageEncodingBindingElement = class
    inherit MessageEncodingBindingElement
    interface IWsdlExportExtension

Public NotInheritable Class WebMessageEncodingBindingElement
Inherits MessageEncodingBindingElement
Implements IWsdlExportExtension

Inheritance: Object

BindingElement

MessageEncodingBindingElement
WebMessageEncodingBindingElement

Implements: IWsdlExportExtension

Remarks

Encoding is the process of transforming a message into a sequence of bytes. Decoding is the reverse process. These processes require the specification of a character encoding. The WebMessageEncodingBindingElement works by delegating to a series of inner encoders to handle the plain-text XML and JSON encodings, and "raw" binary data. This delegation is done by a composite message encoder.

This binding element and its composite encoder are used to control the encoding in scenarios that do not use SOAP messaging used by the WebHttpBinding. These scenarios include "Plain Old XML" (POX), Representational State Transfer (REST), Really Simple Syndication (RSS) and Atom syndication, and Asynchronous JavaScript and XML (AJAX). The composite message encoder does not support SOAP or WS-Addressing, and so MessageVersion always returns None.

The binding element can be configured with a write character encoding at construction time using the WebMessageEncodingBindingElement(Encoding) constructor. The Encoding value specifies the behavior on write for the JSON and Textual XML cases. On read, any valid message encoding and text encoding is understood.

This constructor sets default values on the maximum number of readers and writers that are allocated to pools and that are respectively available to process incoming and outgoing messages without allocating new readers or writers. The properties MaxReadPoolSize and MaxWritePoolSize can also be used to set the maximum number of readers and writers to be allocated respectively. By default 64 readers and 16 writers are allocated.

Default complexity constraints are also set by this constructor on the XmlDictionaryReaderQuotas associated with this encoding by the ReaderQuotas property to protect against a class of denial of service (DOS) attacks that attempt to use message complexity to tie up endpoint processing resources.

The WebMessageEncodingBindingElement has a CreateMessageEncoderFactory method that creates a message encoder factory that produces JSON, XML or Raw message decoders and encoders as appropriate depending on the content type specified.

The WebMessageEncodingBindingElement also provides the methods to build the factories and listeners for the channels through which the HTTP requests flow.

The composite encoder and its associated classes and configuration components are usable in partial trust and this use does not require any special permissions.

Constructors

WebMessageEncodingBindingElement()	Initializes a new instance of the WebMessageEncodingBindingElement class.
WebMessageEncodingBindingElement(Encoding)	Initializes a new instance of the WebMessageEncodingBindingElement class with a specified write character encoding.

Properties

ContentTypeMapper	Gets or sets how the content type of an incoming message is mapped to a format.
CrossDomainScriptAccessEnabled	Gets or sets a value that determines if cross domain script access is enabled.
MaxReadPoolSize	Gets or sets a value that specifies the maximum number of readers that is allocated to a pool and that is available to process incoming messages without allocating new readers.
MaxWritePoolSize	Gets or sets a value that specifies the maximum number of writers that is allocated to a pool and that is available to process outgoing messages without allocating new writers.
MessageVersion	Gets or sets the message version that indicates that the binding element does not use SOAP or WS-Addressing.
ReaderQuotas	Gets constraints on the complexity of SOAP messages that can be processed by endpoints configured with this binding.
WriteEncoding	Gets or sets the character encoding that is used to write the message text.

Methods

BuildChannelFactory<TChannel>(BindingContext)	Builds the channel factory stack on the client that creates a specified type of channel for a specified context.
BuildChannelListener<TChannel>(BindingContext)	Builds the channel listener stack on the client that accepts a specified type of channel for a specified context.
CanBuildChannelFactory<TChannel>(BindingContext)	Returns a value that indicates whether the binding element can build a channel factory for a specific type of channel. (Inherited from BindingElement)
CanBuildChannelListener<TChannel>(BindingContext)	Returns a value that indicates whether the current binding can build a listener for a specified type of channel and context.
Clone()	Creates a new WebMessageEncodingBindingElement object initialized from the current one.
CreateMessageEncoderFactory()	Creates a message encoder factory that produces message encoders that can write either JavaScript Object Notation (JSON) or XML messages.
Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetProperty<T>(BindingContext)	Returns the object of the type requested, if present, from the appropriate layer in the channel stack, or `null` if it is not present.
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)

Explicit Interface Implementations

IWsdlExportExtension.ExportContract(WsdlExporter, WsdlContractConversionContext)	Generates WSDL contract information from encoding policies contained in the binding element.
IWsdlExportExtension.ExportEndpoint(WsdlExporter, WsdlEndpointConversionContext)	Generates WSDL contract information from encoding policies contained in the binding element.

Applies to

Dela via