Class TransportHeader
Represents a transport (HTTP) header description used to match or construct HTTP message.
Inherited Members
Namespace: Nevatech.Vsb.Repository.Entities
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class TransportHeader : IValidator, IEquatable<TransportHeader>, IExtensibleDataObjectConstructors
TransportHeader()
Declaration
public TransportHeader()Properties
ErrorMessage
Gets the summary of validation errors.
Declaration
public string ErrorMessage { get; }Property Value
| Type | Description |
|---|---|
| String |
ExtensionData
Gets or sets ExtensionDataObject that enables serialization roundtrips.
Declaration
public ExtensionDataObject ExtensionData { get; set; }Property Value
| Type | Description |
|---|---|
| ExtensionDataObject |
IsRequired
Gets flag indicating that header must be explicitly provided by the service caller.
Declaration
public bool IsRequired { get; }Property Value
| Type | Description |
|---|---|
| Boolean |
Remarks
Header is required if it defines a constant value to be matched or it does NOT provide a default value for the header variable.
Name
Gets or sets the header name.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Value
Gets or sets the header matching value or default value that is used if header is not provided.
Declaration
public string Value { get; set; }Property Value
| Type | Description |
|---|---|
| String |
VariableName
Gets or sets the token (variable) name storing headers value. If variable name is not set than header actual value must match or be set to Value property.
Declaration
public string VariableName { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Methods
Equals(TransportHeader)
Determines whether the specified object is equal to the current object.
Declaration
public bool Equals(TransportHeader other)Parameters
| Type | Name | Description |
|---|---|---|
| TransportHeader | other | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| Boolean | True, if objects are equal. False, if objects are not equal. |
Equals(Object)
Determines whether the specified object is equal to the current object.
Declaration
public override bool Equals(object obj)Parameters
| Type | Name | Description |
|---|---|---|
| Object | obj | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| Boolean | True, if objects are equal. False, if objects are not equal. |
Overrides
GetHashCode()
Returns the hash code for this instance.
Declaration
public override int GetHashCode()Returns
| Type | Description |
|---|---|
| Int32 | Hash code of the current instance. |
Overrides
ToString()
Returns a string that represents the current object.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String | A string that represents the current object. |
Overrides
Validate()
Evaluates the state of this object.
Declaration
public bool Validate()Returns
| Type | Description |
|---|---|
| Boolean | True if state is valid; otherwise, false. |
Validate(Boolean)
Evaluates the state of this object.
Declaration
public bool Validate(bool requireVariableOrValue)Parameters
| Type | Name | Description |
|---|---|---|
| Boolean | requireVariableOrValue | Flag indicating that variable name or header value should be provided. |
Returns
| Type | Description |
|---|---|
| Boolean | True if state is valid; otherwise, false. |