IDataServiceHost Interface

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Interface that specifies interactions between WCF Data Services and its hosting environment.

Namespace:   System.Data.Services
Assembly:  System.Data.Services (in System.Data.Services.dll)

public interface IDataServiceHost

NameDescription
System_CAPS_pubpropertyAbsoluteRequestUri

Gets an absolute URI that is the URI as sent by the client.

System_CAPS_pubpropertyAbsoluteServiceUri

Gets an absolute URI that is the root URI of the data service.

System_CAPS_pubpropertyRequestAccept

The transport protocol specified by the request accept header.

System_CAPS_pubpropertyRequestAcceptCharSet

Gets a string representing the value of the Accept-Charset HTTP header.

System_CAPS_pubpropertyRequestContentType

Gets the transport protocol specified by the content type header.

System_CAPS_pubpropertyRequestHttpMethod

Gets the request method of GET, PUT, POST, or DELETE.

System_CAPS_pubpropertyRequestIfMatch

Gets the value for the If-Match header on the current request.

System_CAPS_pubpropertyRequestIfNoneMatch

Gets the value for the If-None-Match header on the current request.

System_CAPS_pubpropertyRequestMaxVersion

Gets the value that identifies the highest version that the request client is able to process.

System_CAPS_pubpropertyRequestStream

Gets the stream that contains the HTTP request body.

System_CAPS_pubpropertyRequestVersion

Gets the value that identifies the version of the request that the client submitted, possibly null.

System_CAPS_pubpropertyResponseCacheControl

Gets a string value that represents cache control information.

System_CAPS_pubpropertyResponseContentType

Gets the transport protocol of the response.

System_CAPS_pubpropertyResponseETag

Gets an eTag value that represents the state of data in response.

System_CAPS_pubpropertyResponseLocation

Gets or sets the service location.

System_CAPS_pubpropertyResponseStatusCode

Gets or sets the response code that indicates results of query.

System_CAPS_pubpropertyResponseStream

Gets the response stream to which the HTTP response body will be written.

System_CAPS_pubpropertyResponseVersion

Gets the version used by the host in the response.

NameDescription
System_CAPS_pubmethodGetQueryStringItem(String)

Gets a data item identified by the identity key contained by the parameter of the method.

System_CAPS_pubmethodProcessException(HandleExceptionArgs)

Handles a data service exception using information in the args parameter.

Each component that hosts WCF Data Services, such as Windows Communication Foundation (WCF) must implement this interface. IDataServiceHost is the contract between WCF Data Services and its hosting environment. This abstraction allows the WCF Data Services runtime to be agnostic to any particular hosting environment. The interface provides WCF Data Services with access to inbound HTTP requests. A new object implementing this interface is instantiated for each HTTP request and is then used to inspect properties of the HTTP request and configure the HTTP response.

.NET Framework
Available since 3.5
Return to top
Show: