HttpRequestMessageProperty Class

Definition

Namespace:

System.ServiceModel.Channels

Assembly:

System.ServiceModel.Http.dll

Package:

System.ServiceModel.Http v8.1.0

Source:

HttpRequestMessageProperty.cs

Provides access to the HTTP request to access and respond to the additional information made available for requests over the HTTP protocol.

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

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

type HttpRequestMessageProperty = class
    interface IMessageProperty
    interface IMergeEnabledMessageProperty

Public NotInheritable Class HttpRequestMessageProperty
Implements IMergeEnabledMessageProperty, IMessageProperty

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

HttpRequestMessageProperty()

Initializes a new instance of the HttpRequestMessageProperty class.

Properties

Headers	Gets the HTTP headers from the HTTP request.
HttpRequestMessage
Method	Gets or sets the HTTP verb for the HTTP request.
Name	Gets the name of the message property associated with the HttpRequestMessageProperty class.
QueryString	Gets or sets the query string for the HTTP request.
SuppressEntityBody	Gets or sets a value that indicates whether the body of the message is ignored and only the headers are sent.

Methods

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)
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

IMergeEnabledMessageProperty.TryMergeWithProperty(Object)
IMessageProperty.CreateCopy()	Creates and returns a copy of the current object.