Export (0) Print
Expand All

HttpRequestMessageProperty Class

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

System.Object
  System.ServiceModel.Channels.HttpRequestMessageProperty

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

public sealed class HttpRequestMessageProperty : IMessageProperty

The HttpRequestMessageProperty type exposes the following members.

  NameDescription
Public methodSupported by Portable Class LibraryHttpRequestMessagePropertyInitializes a new instance of the HttpRequestMessageProperty class.
Top

  NameDescription
Public propertySupported by Portable Class LibraryHeadersGets the HTTP headers from the HTTP request.
Public propertySupported by Portable Class LibraryMethodGets or sets the HTTP verb for the HTTP request.
Public propertyStatic memberSupported by Portable Class LibraryNameGets the name of the message property associated with the HttpRequestMessageProperty class.
Public propertySupported by Portable Class LibraryQueryStringGets or sets the query string for the HTTP request.
Public propertySupported by Portable Class LibrarySuppressEntityBodyGets or sets a value that indicates whether the body of the message is ignored and only the headers are sent.
Top

  NameDescription
Public methodSupported by Portable Class LibraryEquals(Object)Determines whether the specified object is equal to the current object. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetHashCodeServes as the default hash function. (Inherited from Object.)
Public methodSupported by Portable Class LibraryGetTypeGets the Type of the current instance. (Inherited from Object.)
Public methodSupported by Portable Class LibraryToStringReturns a string that represents the current object. (Inherited from Object.)
Top

  NameDescription
Explicit interface implemetationPrivate methodIMessageProperty.CreateCopyCreates and returns a copy of the current object.
Top

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

.NET Framework

Supported in: 4.6, 4.5, 4, 3.5, 3.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Portable Class Library

Supported in: Portable Class Library

Supported in: Windows Phone 8.1

Supported in: Windows Phone Silverlight 8.1

Supported in: Windows Phone Silverlight 8

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