HttpRequestMessageProperty Class

 

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

Namespace:   System.ServiceModel.Channels
Assembly:  System.ServiceModel (in System.ServiceModel.dll)

System.Object
  System.ServiceModel.Channels.HttpRequestMessageProperty

public sealed class HttpRequestMessageProperty : IMessageProperty

NameDescription
System_CAPS_pubmethodHttpRequestMessageProperty()

Initializes a new instance of the HttpRequestMessageProperty class.

NameDescription
System_CAPS_pubpropertyHeaders

Gets the HTTP headers from the HTTP request.

System_CAPS_pubpropertyMethod

Gets or sets the HTTP verb for the HTTP request.

System_CAPS_pubpropertySystem_CAPS_staticName

Gets the name of the message property associated with the HttpRequestMessageProperty class.

System_CAPS_pubpropertyQueryString

Gets or sets the query string for the HTTP request.

System_CAPS_pubpropertySuppressEntityBody

Gets or sets a value that indicates whether the body of the message is ignored and only the headers are sent.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

NameDescription
System_CAPS_pubinterfaceSystem_CAPS_privmethodIMessageProperty.CreateCopy()

Creates and returns a copy of the current object.

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:

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;
}

Universal Windows Platform
Available since 8
.NET Framework
Available since 3.0
Portable Class Library
Supported in: portable .NET platforms
Silverlight
Available since 3.0
Windows Phone Silverlight
Available since 7.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: