HttpRequestMetadata Class |
The request metadata for HTTP Request, it adds some additional information from standard Request Metadata. See remarks for more information.
Inheritance HierarchySystemObject
Hummingbird.TestFrameworkIdentifier
Hummingbird.TestFramework.ServicesAbstractMetadata
Hummingbird.TestFramework.ServicesHttpMetadata
Hummingbird.TestFramework.ServicesHttpRequestMetadata
Hummingbird.TestFrameworkIdentifier
Hummingbird.TestFramework.ServicesAbstractMetadata
Hummingbird.TestFramework.ServicesHttpMetadata
Hummingbird.TestFramework.ServicesHttpRequestMetadata
Namespace: Hummingbird.TestFramework.Services
Assembly: Hummingbird.TestFramework (in Hummingbird.TestFramework.dll) Version: 1.2.0.0
SyntaxThe HttpRequestMetadata type exposes the following members.
Constructors| Name | Description | |
|---|---|---|
 | HttpRequestMetadata |
Initializes a new instance of the HttpRequestMetadata class.
|
Properties| Name | Description | |
|---|---|---|
 | ApplicationName |
Level 1 description of a service, in which the application/system it belongs
(Inherited from AbstractMetadata.) |
| BodySerializer |
This serializer is used to serialize HTTP Body content.
(Inherited from HttpMetadata.)For Restful Web Services, methods such as POST or PUT will sent data in HTTP Body in XML or JSON format. Hummingbird Test Framework defines these XML or JSON objects into C# classes and can be edited, shared, automated easily. This serializer converts C# object to HTTP Body Text or converts HTTP Body text back to C# objects. According to the type of Restful service, the serializer can be XMLSerializer for XML based WebServices or JSONSerializer for JSON based WebServices. |
| ContentType |
Gets or sets the Content-Type of the HTTP Request, Default value is "application/xml"
(Inherited from HttpMetadata.) |
| Description |
An description of the functionality of the current service. This description will be shown as Tool-tip on service selector user interface.
(Inherited from AbstractMetadata.) |
| ErrorTypes |
Type of the object which an error could be received from the server.
(Inherited from AbstractMetadata.) |
| FriendlyUriTemplate |
This is a friendly version of Uri displayed to the users, taken account the binding ip, parameters and variables. so the user can understand better where is service is.
(Inherited from AbstractMetadata.) |
| HttpMethod |
Gets or set the HTTP Method: GET, POST, PUT, ... The default value is POST
(Inherited from HttpMetadata.) |
| HttpVersion |
HttpVersion, Default value is HttpVersion11, that represents HTTP/1.1
(Inherited from HttpMetadata.) |
| Id |
This property must be initialized in the constructor of derived class and must be given a fixed GUID.
the GUID must be a constant in code, and should not equals to any other classes derived from AbstractService.
(Inherited from Identifier.) |
| IsUniqueMethodOfService | Obsolete.
If there are no different Method (MethodName) in the same Service (ServiceName) => true,
Else false;
(Inherited from AbstractMetadata.) |
| OperationName |
An additional Level 4 description of a service, for a subservice or a subworkflow.
Example: for a SOAP web service, it may contains more soap action for a single endpoint
(Inherited from AbstractMetadata.) |
| Path |
Gets or sets the Path based on UriTemplate as Base Url
|
| ReferencedService |
Gets or Sets referenced AbstractService (Client of Server) which the current request/response is used.
For services that based on HTTP Client, HTTP Server, SOAP Client and SOAP Server, this value can be assigned automatically,
When creating an extension that implements a new AbstractService, you must assign all request / responses with the service.
(Inherited from AbstractMetadata.) |
| RequestEditorType |
Type of a CustomObjectEditor to edit the request data (used as Driver). If the value is not provided, Hummingbird default editor will be used.
the request data is type of RequestType.
(Inherited from AbstractMetadata.) |
| RequestSerializer |
Gets or sets the serializer used to serialize and deserialize request objects.
(Inherited from AbstractMetadata.) |
| RequestType |
Type of the object which the request will be in .NET framework.
The injector service will convert this object to real request (such as Soap or HTTP request).
For a service stub, this is the type of object RECEIVED by the service stub.
(Inherited from AbstractMetadata.) |
| RequiredExtension |
Gets the required extension about this AbstractMetadata
(Inherited from AbstractMetadata.) |
| ResponseEditorType |
Type of a CustomObjectEditor to edit the response data (used as Stub). If the value is not provided, Hummingbird default editor will be used.
(Inherited from AbstractMetadata.) |
| ResponseSerializer |
Gets or sets the serializer used to serialize and deserialize response objects..
(Inherited from AbstractMetadata.) |
| ResponseType |
Type of the object which the reply will be received from the server.
For a mocking service, this is the type of object which will be sent to the caller.
(Inherited from AbstractMetadata.) |
| ServiceCategory |
Level 2 description of a service, in which the category/module it belongs
(Inherited from AbstractMetadata.) |
| ServiceName |
Level 3 description of a service, in which the service/workflow it belongs
(Inherited from AbstractMetadata.) |
 | UriTemplate | When used as Server to simulate responses, UriTemplate is the absolute path of the service, starts always by /. If the service is HTTP based, the HTTP service handler will route the received http message by it's URL. if the Uri matches the UriTemplate, then such handler is chosen. When used as drivers, The Uri template there the request will be send. UriTemplate supports variables and processing functions in order make the extension reusable to different test environments and configurations |
| VisualizerType |
The type of WPF control which shows the result of
the type must be derived from Hummingbird.TestFramework.DataVisualizer
(Inherited from AbstractMetadata.) |
Methods| Name | Description | |
|---|---|---|
| Equals | 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 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 |
the string presentation of the current service
(Inherited from AbstractMetadata.) |
Extension Methods| Name | Description | |
|---|---|---|
 | ToStringOrXml |
Converts any Object to string representation in String or XML format.
(Defined by ExtensionMethods.) |
| ToXmlString |
Converts any Object to string representation in XML format.
(Defined by ExtensionMethods.) |
Remarks
This metadata is used to describes a RESTful Web Service. Hummingbird Test Framework uses advanced reflection technology to create the real web request from an given object.
RequestType specifies a class which represents the request using different Attributes to tag there the value should be appear:
QueryFieldAttribute specifies a variable that appear in the Uri Template.
HttpHeaderAttribute specifies a variable that appear in HTTP Headers
HttpBodyAttribute specifies an object that represents the HTTP Body. In additional, when an property is tagged with HttpBodyAttribute, BodySerializer will be used to convert the Object to Text (XML or JSON)
See Also