Class MessagePipeline
Represents a message processing pipeline with the chains of components placed into the pre-defined interception points that will be allowed to inspect and modify the request and response messages.
Inherited Members
Namespace: Nevatech.Vsb.Repository.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
[DataContract(Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
public sealed class MessagePipeline : IValidator, IEquatable<MessagePipeline>, IExtensibleDataObject
Constructors
MessagePipeline()
Declaration
public MessagePipeline()
Fields
ElementName
Name of the root element when object is serialized to XML.
Declaration
public const string ElementName = "MESSAGE-PIPELINE"
Field Value
| Type | Description |
|---|---|
| string |
Properties
ErrorMessage
Gets the summary of validation errors.
Declaration
public string ErrorMessage { get; }
Property Value
| Type | Description |
|---|---|
| string |
ExtensionData
Gets or sets ExtensionDataObject that enables serialization round-trips.
Declaration
public ExtensionDataObject ExtensionData { get; set; }
Property Value
| Type | Description |
|---|---|
| ExtensionDataObject |
InboundRequest
Gets or sets the component or the chain of components that will be invoked to process request messages received on inbound endpoints.
Declaration
[DataMember(EmitDefaultValue = false)]
public MessagePipelineComponentBase InboundRequest { get; set; }
Property Value
| Type | Description |
|---|---|
| MessagePipelineComponentBase |
InboundResponse
Gets or sets the component or the chain of components that will be invoked to process response messages that are about to be sent through inbound endpoints.
Declaration
[DataMember(EmitDefaultValue = false)]
public MessagePipelineComponentBase InboundResponse { get; set; }
Property Value
| Type | Description |
|---|---|
| MessagePipelineComponentBase |
IsEmpty
Gets flag indicating that all pipeline components are empty.
Declaration
public bool IsEmpty { get; }
Property Value
| Type | Description |
|---|---|
| bool |
OutboundRequest
Gets or sets the component or the chain of components that will be invoked to process request messages before they are sent through outbound endpoints.
Declaration
[DataMember(EmitDefaultValue = false)]
public MessagePipelineComponentBase OutboundRequest { get; set; }
Property Value
| Type | Description |
|---|---|
| MessagePipelineComponentBase |
OutboundResponse
Gets or sets the component or the chain of components that will be invoked to process response messages received on outbound endpoints.
Declaration
[DataMember(EmitDefaultValue = false)]
public MessagePipelineComponentBase OutboundResponse { get; set; }
Property Value
| Type | Description |
|---|---|
| MessagePipelineComponentBase |
Methods
Equals(MessagePipeline)
Determines whether the specified object is equal to the current object.
Declaration
public bool Equals(MessagePipeline other)
Parameters
| Type | Name | Description |
|---|---|---|
| MessagePipeline | other | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| bool | 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 |
|---|---|
| bool | 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 |
|---|---|
| int | Hash code of the current instance. |
Overrides
ProcessMessage(MessagePipeline, MessagePipelineContext)
Executes message processing pipeline and/or message processing component configured for the current message.
Declaration
[SuppressMessage("Microsoft.Maintainability", "CA1502:AvoidExcessiveComplexity")]
public static void ProcessMessage(MessagePipeline pipeline, MessagePipelineContext context)
Parameters
| Type | Name | Description |
|---|---|---|
| MessagePipeline | pipeline | The message pipeline. |
| MessagePipelineContext | context | Context providing data and parameters of the currently executing operation. |
Validate()
Evaluates the state of this object.
Declaration
[SuppressMessage("Microsoft.Design", "CA1031:DoNotCatchGeneralExceptionTypes")]
public bool Validate()
Returns
| Type | Description |
|---|---|
| bool | True if state is valid; otherwise, false. |