HttpRequestMessageProperty Class

Definition

public ref class HttpRequestMessageProperty sealed : System::ServiceModel::Channels::IMessageProperty

public ref class HttpRequestMessageProperty sealed : System::ServiceModel::Channels::IMergeEnabledMessageProperty, System::ServiceModel::Channels::IMessageProperty

public ref class HttpRequestMessageProperty sealed

public sealed class HttpRequestMessageProperty : System.ServiceModel.Channels.IMessageProperty

public sealed class HttpRequestMessageProperty : System.ServiceModel.Channels.IMergeEnabledMessageProperty, System.ServiceModel.Channels.IMessageProperty

public sealed class HttpRequestMessageProperty

type HttpRequestMessageProperty = class
    interface IMessageProperty

type HttpRequestMessageProperty = class
    interface IMessageProperty
    interface IMergeEnabledMessageProperty

type HttpRequestMessageProperty = class

Public NotInheritable Class HttpRequestMessageProperty
Implements IMessageProperty

Public NotInheritable Class HttpRequestMessageProperty
Implements IMergeEnabledMessageProperty, IMessageProperty

Public NotInheritable Class HttpRequestMessageProperty

Inheritance

Object

HttpRequestMessageProperty

Implements

IMessageProperty System.ServiceModel.Channels.IMergeEnabledMessageProperty

Examples

The following code shows how to set several of the properties in an instance of this class and incorporate the instance into a message.

static Message BuildMessage()
{
    Message messageToSend = null;
    HttpRequestMessageProperty reqProps = new HttpRequestMessageProperty();
    reqProps.SuppressEntityBody = false;
    reqProps.Headers.Add("CustomHeader", "Test Value");
    reqProps.Headers.Add(HttpRequestHeader.UserAgent, "my user agent");

    try
    {
        messageToSend = Message.CreateMessage(MessageVersion.Soap11, "http://tempuri.org/IUntypedService/ProcessMessage", "Hello WCF");
    }
    catch (Exception e)
    {
        Console.WriteLine("got exception when sending message: " + e.ToString());
    }

    messageToSend.Properties[HttpRequestMessageProperty.Name] = reqProps;
    return messageToSend;
}

Private Shared Function BuildMessage() As Message
    Dim messageToSend As Message = Nothing
    Dim reqProps As New HttpRequestMessageProperty()
    reqProps.SuppressEntityBody = False
    reqProps.Headers.Add("CustomHeader", "Test Value")
    reqProps.Headers.Add(HttpRequestHeader.UserAgent, "my user agent")

    Try
        messageToSend = Message.CreateMessage(MessageVersion.Soap11, "http://tempuri.org/IUntypedService/ProcessMessage", "Hello WCF")
    Catch e As Exception
        Console.WriteLine("got exception when sending message: " & e.ToString())
    End Try

    messageToSend.Properties(HttpRequestMessageProperty.Name) = reqProps
    Return messageToSend
End Function

Remarks

This is a general-purpose class that gives the developer direct access to the HTTP request information, which can be used for encapsulating HTTP-specific information. One example of the use of this class is to support services implemented in accordance with the Representational State Transfer (REST) architecture.

This class enables support for the following scenarios:

• Varies the HTTP verb used for each request.

• Allows HTTP header (key, value) pairs to be set and queried by request.

• Allows the query string to be specified for an HTTP request.

This class can be used by HttpTransportBindingElement and related classes.

For incoming messages, this property is added to messages.

For outgoing messages, this property causes the following to happen:

• Method is set to Method.

• QueryString is appended to the RequestUri.

• Headers is added to the HTTP headers set to be transmitted.

Constructors

Properties

Methods

Explicit Interface Implementations

Applies to