Class MessagePipelineComponentBase
Represents the base class for all message processing pipeline components.
Inheritance
Inherited Members
Namespace: Nevatech.Vsb.Repository.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public abstract class MessagePipelineComponentBase : IValidator, IEquatable<MessagePipelineComponentBase>, IExtensibleDataObjectConstructors
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 |
|---|---|
| String |
ExtensionData
Gets or sets ExtensionDataObject that enables serialization roundtrips.
Declaration
public ExtensionDataObject ExtensionData { get; set; }Property Value
| Type | Description |
|---|---|
| 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 |
|---|---|
| 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
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 |
|---|---|
| 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 |
|---|---|
| Boolean | True if state is valid; otherwise, false. |