Class ReturnComponent

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

Inheritance
Object
MessagePipelineComponentBase
ReturnComponent
Inherited Members
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
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

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
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
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
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 HttpStatusCode value.

Declaration
public string StatusCode { get; set; }
Property Value
Type Description
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
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
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
Object obj

The object to compare with the current object.
Returns
Type Description
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
Int32

Hash code for the value of this instance.
Overrides

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

ToString()

Returns string representation of the object.

Declaration
public override string ToString()
Returns
Type Description
String

String representing the object's content.
Overrides

Implements