HttpRequestMessageProperty Class
Provides access to the HTTP request to access and respond to the additional information made available for requests over the HTTP protocol.
Assembly: System.ServiceModel (in System.ServiceModel.dll)
The HttpRequestMessageProperty type exposes the following members.
| Name | Description | |
|---|---|---|
|
HttpRequestMessageProperty | Initializes a new instance of the HttpRequestMessageProperty class. |
| Name | Description | |
|---|---|---|
|
Headers | Gets the HTTP headers from the HTTP request. |
|
|
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. |
| Name | Description | |
|---|---|---|
|
|
Equals(Object) | Determines whether the specified Object is equal to the current Object. (Inherited from Object.) |
|
Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
|
|
GetHashCode | Serves as a hash function for a particular type. (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.) |
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:
-
QueryString is appended to the RequestUri.
-
Headers is added to the HTTP headers set to be transmitted.
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; }
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.
