Class HttpStatusComponent

Implements a message pipeline component that sets HTTS status code to the specified value in an intercepted response message.

Inheritance
System.Object
MessagePipelineComponentBase
HttpStatusComponent
Implements
System.IEquatable<MessagePipelineComponentBase>
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.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class HttpStatusComponent : MessagePipelineComponentBase, IValidator, IEquatable<MessagePipelineComponentBase>, IExtensibleDataObject

Constructors

HttpStatusComponent()

Declaration
public HttpStatusComponent()

Fields

ElementName

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

Declaration
public const string ElementName = "SET-HTTP-STATUS"
Field Value
Type Description
System.String

Properties

AllowedPositions

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

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

Code

Gets or sets the status code to be set on HTTP message. Value may contain a specially formatted context property name. The code must resolve to a valid string or numeric System.Net.HttpStatusCode value.

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

Description

Gets or sets the description of the status code to be set on HTTP message. Value may contain a specially formatted context property name.

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

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
System.Boolean

True if the specified object is equal to the current object; otherwise, false.
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
System.Object obj

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

True if the specified object is equal to the current object; otherwise, false.
Overrides

GetHashCode()

Returns hash code for the value of this instance.

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

Hash code for the value of this instance.
Overrides

ProcessMessage(MessagePipelineContext)

Sets HTTS status code to the specified value in an intercepted response 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
System.String

String representing the object's content.
Overrides
System.Object.ToString()

Validate()

Evaluates the state of the object.

Declaration
public override bool Validate()
Returns
Type Description
System.Boolean

True if state is valid; otherwise, false.
Overrides

Implements

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