MessageEncodingBindingElement クラス

リファレンス

定義

名前空間:: System.ServiceModel.Channels

アセンブリ:: System.ServiceModel.Primitives.dll

アセンブリ:: System.ServiceModel.dll

パッケージ:: System.ServiceModel.Primitives v6.0.0

パッケージ:: System.ServiceModel.Primitives v6.2.0

パッケージ:: System.ServiceModel.Primitives v8.0.0

ソース:: MessageEncodingBindingElement.cs

ソース:: MessageEncodingBindingElement.cs

ソース:: MessageEncodingBindingElement.cs

重要

一部の情報は、リリース前に大きく変更される可能性があるプレリリースされた製品に関するものです。 Microsoft は、ここに記載されている情報について、明示または黙示を問わず、一切保証しません。

メッセージをエンコードするために使用するメッセージバージョンを指定するバインド要素。

public ref class MessageEncodingBindingElement abstract : System::ServiceModel::Channels::BindingElement

public abstract class MessageEncodingBindingElement : System.ServiceModel.Channels.BindingElement

type MessageEncodingBindingElement = class
    inherit BindingElement

Public MustInherit Class MessageEncodingBindingElement
Inherits BindingElement

継承: Object

BindingElement
MessageEncodingBindingElement

派生: System.ServiceModel.Channels.BinaryMessageEncodingBindingElement

System.ServiceModel.Channels.ByteStreamMessageEncodingBindingElement

System.ServiceModel.Channels.MtomMessageEncodingBindingElement

System.ServiceModel.Channels.TextMessageEncodingBindingElement

System.ServiceModel.Channels.WebMessageEncodingBindingElement

例

MessageEncodingBindingElement から派生したクラスを実装する方法を次のコード例に示します。

public class CustomTextMessageBindingElement : MessageEncodingBindingElement, IWsdlExportExtension
{
    private MessageVersion msgVersion;
    private string mediaType;
    private string encoding;
    private XmlDictionaryReaderQuotas readerQuotas;

    CustomTextMessageBindingElement(CustomTextMessageBindingElement binding)
        : this(binding.Encoding, binding.MediaType, binding.MessageVersion)
    {
        this.readerQuotas = new XmlDictionaryReaderQuotas();
        binding.ReaderQuotas.CopyTo(this.readerQuotas);
    }

    public CustomTextMessageBindingElement(string encoding, string mediaType,
        MessageVersion msgVersion)
    {
        if (encoding == null)
            throw new ArgumentNullException(nameof(encoding));

        if (mediaType == null)
            throw new ArgumentNullException(nameof(mediaType));

        if (msgVersion == null)
            throw new ArgumentNullException(nameof(msgVersion));

        this.msgVersion = msgVersion;
        this.mediaType = mediaType;
        this.encoding = encoding;
        this.readerQuotas = new XmlDictionaryReaderQuotas();
    }

    public CustomTextMessageBindingElement(string encoding, string mediaType)
        : this(encoding, mediaType, MessageVersion.Soap11WSAddressing10)
    {
    }

    public CustomTextMessageBindingElement(string encoding)
        : this(encoding, "text/xml")
    {
    }

    public CustomTextMessageBindingElement()
        : this("UTF-8")
    {
    }

    public override MessageVersion MessageVersion
    {
        get
        {
            return this.msgVersion;
        }

        set
        {
            if (value == null)
                throw new ArgumentNullException(nameof(value));
            this.msgVersion = value;
        }
    }

    public string MediaType
    {
        get
        {
            return this.mediaType;
        }

        set
        {
            if (value == null)
                throw new ArgumentNullException(nameof(value));
            this.mediaType = value;
        }
    }

    public string Encoding
    {
        get
        {
            return this.encoding;
        }

        set
        {
            if (value == null)
                throw new ArgumentNullException(nameof(value));
            this.encoding = value;
        }
    }

    // This encoder does not enforces any quotas for the unsecure messages. The
    // quotas are enforced for the secure portions of messages when this encoder
    // is used in a binding that is configured with security.
    public XmlDictionaryReaderQuotas ReaderQuotas
    {
        get
        {
            return this.readerQuotas;
        }
    }

    #region IMessageEncodingBindingElement Members
    public override MessageEncoderFactory CreateMessageEncoderFactory()
    {
        return new CustomTextMessageEncoderFactory(this.MediaType,
            this.Encoding, this.MessageVersion);
    }

    #endregion

    public override BindingElement Clone()
    {
        return new CustomTextMessageBindingElement(this);
    }

    public override IChannelFactory<TChannel> BuildChannelFactory<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException(nameof(context));

        context.BindingParameters.Add(this);
        return context.BuildInnerChannelFactory<TChannel>();
    }

    public override bool CanBuildChannelFactory<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException(nameof(context));

        return context.CanBuildInnerChannelFactory<TChannel>();
    }

    public override IChannelListener<TChannel> BuildChannelListener<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException(nameof(context));

        context.BindingParameters.Add(this);
        return context.BuildInnerChannelListener<TChannel>();
    }

    public override bool CanBuildChannelListener<TChannel>(BindingContext context)
    {
        if (context == null)
            throw new ArgumentNullException(nameof(context));

        context.BindingParameters.Add(this);
        return context.CanBuildInnerChannelListener<TChannel>();
    }

    public override T GetProperty<T>(BindingContext context)
    {
        if (typeof(T) == typeof(XmlDictionaryReaderQuotas))
        {
            return (T)(object)this.readerQuotas;
        }
        else
        {
            return base.GetProperty<T>(context);
        }
    }

    #region IWsdlExportExtension Members

    void IWsdlExportExtension.ExportContract(WsdlExporter exporter, WsdlContractConversionContext context)
    {
    }

    void IWsdlExportExtension.ExportEndpoint(WsdlExporter exporter, WsdlEndpointConversionContext context)
    {
        // The MessageEncodingBindingElement is responsible for ensuring that the WSDL has the correct
        // SOAP version. We can delegate to the WCF implementation of TextMessageEncodingBindingElement for this.
        TextMessageEncodingBindingElement mebe = new TextMessageEncodingBindingElement();
        mebe.MessageVersion = this.msgVersion;
        ((IWsdlExportExtension)mebe).ExportEndpoint(exporter, context);
    }

    #endregion
}

注釈

エンコーディングは、メッセージをバイトシーケンスに変換するプロセスです。デコードは、その逆のプロセスです。 WCF (Windows Communication Foundation) には、SOAP メッセージのエンコードとして、テキスト、バイナリ、および MTOM (Message Transmission Optimization Mechanism) の 3 種類があります。

カスタムメッセージエンコーダーを実装する場合は、このクラスを使用します。独自のカスタムメッセージエンコーダーを実装するには、次の 3 つの抽象基本クラスのカスタム実装を提供する必要があります。

Encoder をオーバーライドして、独自のカスタム MessageEncoder のインスタンスを返します。 CreateMessageEncoderFactory メソッドをオーバーライドして、このファクトリのインスタンスを返します。

MessageEncodingBindingElement から派生するすべての型は、サービスに対して生成される WSDL ドキュメント内の SOAP バインドのバージョンを更新します。そのためには、生成される WSDL を変更する ExportEndpoint(WsdlExporter, WsdlEndpointConversionContext) メソッドを実装します。

Windows Communication Foundation (WCF) には、クラスから MessageEncodingBindingElement 派生した 3 種類のバインド要素が用意されています。この要素は、テキスト、バイナリ、およびメッセージ送信最適化メカニズム (MTOM) エンコードに使用できます。

TextMessageEncodingBindingElement : 相互運用性は最も高く、効率は最も低い、XML メッセージ用のエンコーダー。 Web サービスまたは Web サービスクライアントは、一般に、テキスト形式の XML を認識できます。ただし、大きいブロックのバイナリデータをテキストとして転送するのは効率的ではありません。
BinaryMessageEncodingBindingElement: バイナリベースの XML メッセージに使用される文字エンコーディングとメッセージのバージョン管理を指定するバインド要素を表します。これは、最も効率的ですが、エンコーディングオプションの相互運用性は最も低くなります。
MtomMessageEncodingBindingElement: メッセージ転送最適化メカニズム (MTOM) エンコードを使用してメッセージに使用される文字エンコードとメッセージのバージョン管理を指定するバインド要素を表します。 MTOM は、WCF メッセージでバイナリデータを転送するための効率的なテクノロジです。 MTOM エンコーダーは、効率と相互運用性のバランスをとろうとします。 MTOM エンコーディングは、ほとんどの XML をテキスト形式で転送しますが、大きいサイズのバイナリデータブロックはテキストに変換せずにそのまま転送することによって最適化します。

コンストラクター

MessageEncodingBindingElement()	MessageEncodingBindingElement クラスの新しいインスタンスを初期化します。
MessageEncodingBindingElement(MessageEncodingBindingElement)	既存の要素から初期化された MessageEncodingBindingElement クラスの新しいインスタンスを初期化します。

プロパティ

MessageVersion

派生クラスでオーバーライドされた場合、メッセージエンコーダーファクトリによって生成されるメッセージエンコーダーが処理できるメッセージバージョンを取得または設定します。

メソッド

BuildChannelFactory<TChannel>(BindingContext)	指定した種類のチャネルを生成するよう、バインドコンテキストからチャネルファクトリを初期化します。 (継承元 BindingElement)
BuildChannelListener<TChannel>(BindingContext)	指定した種類のチャネルを受け入れるよう、バインディングコンテキストからチャネルリスナーを初期化します。 (継承元 BindingElement)
CanBuildChannelFactory<TChannel>(BindingContext)	指定した種類のチャネルに対するチャネルファクトリをバインド要素が作成できるかどうかを示す値を返します。 (継承元 BindingElement)
CanBuildChannelListener<TChannel>(BindingContext)	指定した種類のチャネルに対するリスナーをバインド要素が作成できるかどうかを示す値を返します。 (継承元 BindingElement)
Clone()	派生クラスでオーバーライドされると、バインド要素オブジェクトのコピーを返します。 (継承元 BindingElement)
CreateMessageEncoderFactory()	派生クラスでオーバーライドされた場合、メッセージエンコーダーを生成するためのファクトリを作成します。
Equals(Object)	指定されたオブジェクトが現在のオブジェクトと等しいかどうかを判断します。 (継承元 Object)
GetHashCode()	既定のハッシュ関数として機能します。 (継承元 Object)
GetProperty<T>(BindingContext)	チャネルスタックの適切な層から、要求のあった型指定されたオブジェクト (ある場合) を返します。
GetType()	現在のインスタンスの Type を取得します。 (継承元 Object)
MemberwiseClone()	現在の Object の簡易コピーを作成します。 (継承元 Object)
ToString()	現在のオブジェクトを表す文字列を返します。 (継承元 Object)

適用対象

MessageEncodingBindingElement クラス

定義

例

注釈

コンストラクター

プロパティ

メソッド

適用対象

フィードバック

その他のリソース