Class HttpHeaderComponent

Implements a message pipeline component that sets, replaces, or removes HTTP header(s) in an intercepted message.

Inheritance
Object
MessagePipelineComponentBase
HttpHeaderComponent
Inherited Members
Namespace: Nevatech.Vsb.Repository.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class HttpHeaderComponent : MessagePipelineComponentBase, IValidator, IEquatable<MessagePipelineComponentBase>, IExtensibleDataObject

Constructors

HttpHeaderComponent()

Declaration
public HttpHeaderComponent()

Fields

ElementName

Name of the root element when object is serialized to XML.

Declaration
public const string ElementName = "SET-HTTP-HEADER"
Field Value
Type Description
String

Properties

AllowedPositions

Gets the message processing pipeline position(s) supported by the component: outbound request or inbound response.

Declaration
public override MessagePipelinePositions AllowedPositions { get; }
Property Value
Type Description
MessagePipelinePositions
Overrides

Headers

Gets collection of HTTP headers to be set, replaced, or deleted.

Declaration
public Collection<HttpHeader> Headers { get; }
Property Value
Type Description
Collection<HttpHeader>

Methods

Equals(MessagePipelineComponentBase)

Determines whether the specified object is equal to the current object.

Declaration
public override bool Equals(MessagePipelineComponentBase other)
Parameters
Type Name Description
MessagePipelineComponentBase other

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

True, if objects are equal. False, if objects are not equal.
Overrides

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

ProcessMessage(MessagePipelineContext)

Sets, replaces, or removes HTTP header(s) in the provided message.

Declaration
public override MessagePipelineResult ProcessMessage(MessagePipelineContext context)
Parameters
Type Name Description
MessagePipelineContext context

Provides the message processing context.
Returns
Type Description
MessagePipelineResult

Value indicating if message should continue on its way to the recipient or must be stopped and returned to the sender.
Overrides

ToString()

Returns string representation of the object.

Declaration
public override string ToString()
Returns
Type Description
String

String representing the object's content.
Overrides

Validate()

Evaluates the state of this object.

Declaration
public override bool Validate()
Returns
Type Description
Boolean

True if state is valid; otherwise, false.
Overrides

Implements