Class ReturnComponent

Implements a message pipeline component that stops processing and returns the message to the sender.

Inheritance

System.Object

MessagePipelineComponentBase

ReturnComponent

Implements

IValidator

System.IEquatable<MessagePipelineComponentBase>

System.Runtime.Serialization.IExtensibleDataObject

Inherited Members

MessagePipelineComponentBase.Validate()

MessagePipelineComponentBase.Validate(MessagePipelinePositions)

MessagePipelineComponentBase.ErrorMessage

MessagePipelineComponentBase.ExtensionData

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

Constructors

ReturnComponent()

Declaration

public ReturnComponent()

Fields

ElementName

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

Declaration

public const string ElementName = "RETURN"

Field Value

Type	Description
System.String

Properties

AllowedPositions

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

Declaration

public override MessagePipelinePositions AllowedPositions { get; }

Property Value

Type	Description
MessagePipelinePositions

Overrides

MessagePipelineComponentBase.AllowedPositions

BodyContent

Gets or sets the message body content. Value may contain a specially formatted context property name which value must be used as the message body content.

Declaration

public string BodyContent { get; set; }

Property Value

Type	Description
System.String

BypassResponsePipeline

Gets or sets the flag indicating that response message shall NOT be sent to inbound response pipeline where it can be processed and fine-tuned. If property is set to True then cached response message is returned directly to the client.

Declaration

public bool BypassResponsePipeline { get; set; }

Property Value

Type	Description
System.Boolean

ContentType

Gets or sets the Content-Type response header value to be set on HTTP message.

Declaration

public string ContentType { get; set; }

Property Value

Type	Description
System.String

StatusCode

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 StatusCode { get; set; }

Property Value

Type	Description
System.String

StatusDescription

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 StatusDescription { 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

MessagePipelineComponentBase.Equals(MessagePipelineComponentBase)

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

MessagePipelineComponentBase.Equals(Object)

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

MessagePipelineComponentBase.GetHashCode()

ProcessMessage(MessagePipelineContext)

Sets the message body content to the specific value.

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

MessagePipelineComponentBase.ProcessMessage(MessagePipelineContext)

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

Implements

IValidator

System.IEquatable<T>

System.Runtime.Serialization.IExtensibleDataObject