Class TransportHeader

Represents a transport (HTTP) header description used to match or construct HTTP message.

Inheritance
System.Object
TransportHeader
Implements
System.IEquatable<TransportHeader>
System.Runtime.Serialization.IExtensibleDataObject
Inherited Members
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Nevatech.Vsb.Repository.Entities
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class TransportHeader : IValidator, IEquatable<TransportHeader>, IExtensibleDataObject

Constructors

TransportHeader()

Declaration
public TransportHeader()

Properties

ErrorMessage

Gets the summary of validation errors.

Declaration
public string ErrorMessage { get; }
Property Value
Type Description
System.String

ExtensionData

Gets or sets System.Runtime.Serialization.ExtensionDataObject that enables serialization roundtrips.

Declaration
public ExtensionDataObject ExtensionData { get; set; }
Property Value
Type Description
System.Runtime.Serialization.ExtensionDataObject

IsRequired

Gets flag indicating that header must be explicitly provided by the service caller.

Declaration
public bool IsRequired { get; }
Property Value
Type Description
System.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
System.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
System.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
System.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
System.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
System.Object obj

The object to compare with the current object.
Returns
Type Description
System.Boolean

True, if objects are equal. False, if objects are not equal.
Overrides
System.Object.Equals(System.Object)

GetHashCode()

Returns the hash code for this instance.

Declaration
public override int GetHashCode()
Returns
Type Description
System.Int32

Hash code of the current instance.
Overrides
System.Object.GetHashCode()

ToString()

Returns a string that represents the current object.

Declaration
public override string ToString()
Returns
Type Description
System.String

A string that represents the current object.
Overrides
System.Object.ToString()

Validate()

Evaluates the state of this object.

Declaration
public bool Validate()
Returns
Type Description
System.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
System.Boolean requireVariableOrValue

Flag indicating that variable name or header value should be provided.
Returns
Type Description
System.Boolean

True if state is valid; otherwise, false.

Implements

System.IEquatable<T>
System.Runtime.Serialization.IExtensibleDataObject