Class MessagePipelineComponentBase

Represents the base class for all message processing pipeline components.

Inheritance

System.Object

MessagePipelineComponentBase

AbsoluteUriComponent

CachePropertyComponent

CacheRequestComponent

CacheResponseComponent

CodeComponent

CollectionComponent

ConditionComponent

ContentComponent

ContextPropertyComponent

CustomComponent

HttpHeaderComponent

HttpInvokeComponent

HttpMethodComponent

HttpStatusComponent

JsonTransformComponent

MonitoringPropertyComponent

QueryParameterComponent

RelativeUriComponent

ReturnComponent

SoapHeaderComponent

TransformationComponentBase

Implements

IValidator

System.IEquatable<MessagePipelineComponentBase>

System.Runtime.Serialization.IExtensibleDataObject

Inherited Members

System.Object.ToString()

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 abstract class MessagePipelineComponentBase : IValidator, IEquatable<MessagePipelineComponentBase>, IExtensibleDataObject

Constructors

MessagePipelineComponentBase()

Declaration

protected MessagePipelineComponentBase()

Properties

AllowedPositions

Gets the message processing pipeline position(s) supported by the component.

Declaration

public virtual MessagePipelinePositions AllowedPositions { get; }

Property Value

Type	Description
MessagePipelinePositions

ErrorMessage

Gets the summary of validation errors populated by the call to Validate() method.

Declaration

public string ErrorMessage { get; protected set; }

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

Methods

Equals(MessagePipelineComponentBase)

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

Declaration

public virtual 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 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()

ProcessMessage(MessagePipelineContext)

When implemented, inspects the message and optionally modifies its content.

Declaration

public abstract 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.

Validate()

Evaluates the state of this object.

Declaration

public virtual bool Validate()

Returns

Type	Description
System.Boolean	True if state is valid; otherwise, false.

Validate(MessagePipelinePositions)

Evaluates the state of this component and ensures that component can operate at the provided message pipeline position.

Declaration

public virtual bool Validate(MessagePipelinePositions position)

Parameters

Type	Name	Description
MessagePipelinePositions	position	Message pipeline position where component is intended to be used.

Returns

Type	Description
System.Boolean	True if state is valid; otherwise, false.

Implements

IValidator

System.IEquatable<T>

System.Runtime.Serialization.IExtensibleDataObject