Class TransformationComponentBase

Represents the base class for all message pipeline components performing transformation of a generic value. The original value is retrieved and the modified value is stored under the specified name in the specified location (message body, context property, etc.).

Inheritance
object
MessagePipelineComponentBase
TransformationComponentBase
LiquidTransformComponent
RegexReplaceComponent
StringReplaceComponent
XdtTransformComponent
XmlNamespaceReplaceComponent
XsltTransformComponent
Implements
Inherited Members
Namespace: Nevatech.Vsb.Repository.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
[DataContract(Namespace = "http://schemas.nevatech.com/sentinet/2011/02")]
public abstract class TransformationComponentBase : MessagePipelineComponentBase, IValidator, IEquatable<MessagePipelineComponentBase>, IExtensibleDataObject

Constructors

TransformationComponentBase()

Declaration
protected TransformationComponentBase()

Properties

SourceName

Gets or sets the name of the source of value to be transformed. This, for example, can be a context property name, HTTP header name, etc.

Declaration
[DataMember(EmitDefaultValue = false)]
public string SourceName { get; set; }
Property Value
Type Description
string

SourceType

Gets or sets the source of value to be transformed.

Declaration
[DataMember(EmitDefaultValue = false)]
public TransformationSource SourceType { get; set; }
Property Value
Type Description
TransformationSource

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
bool

True, if objects are equal. False, if objects are not equal.
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
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

GetSourceValue(MessagePipelineContext, bool)

Returns the value stored in the specified source corresponding to the specified name.

Declaration
[SuppressMessage("Microsoft.Design", "CA1026:DefaultParametersShouldNotBeUsed")]
protected string GetSourceValue(MessagePipelineContext context, bool preserveOriginalValue = true)
Parameters
Type Name Description
MessagePipelineContext context

Current message processing context.
bool preserveOriginalValue

Flag indicating that, if reading the value from the source causes the source to become invalid, the original value should be written back.
Returns
Type Description
string

Value stored in the specified source corresponding to the specified name.

SetSourceValue(MessagePipelineContext, string)

Writes the provided value to the specified source under the specified name.

Declaration
protected void SetSourceValue(MessagePipelineContext context, string value)
Parameters
Type Name Description
MessagePipelineContext context

Current message processing context.
string value

Value to be written.

SetSourceValue(MessagePipelineContext, XmlReader)

Writes the provided XML to the specified source under the specified name.

Declaration
protected void SetSourceValue(MessagePipelineContext context, XmlReader reader)
Parameters
Type Name Description
MessagePipelineContext context

Current message processing context.
XmlReader reader

XML reader providing the value to be written.

Validate()

Evaluates the state of this object.

Declaration
public override bool Validate()
Returns
Type Description
bool

True if state is valid; otherwise, false.
Overrides

Implements