Show / Hide Table of Contents

    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
    IValidator
    IEquatable<MessagePipelineComponentBase>
    IExtensibleDataObject
    Inherited Members
    MessagePipelineComponentBase.ProcessMessage(MessagePipelineContext)
    MessagePipelineComponentBase.Validate(MessagePipelinePositions)
    MessagePipelineComponentBase.AllowedPositions
    MessagePipelineComponentBase.ErrorMessage
    MessagePipelineComponentBase.ExtensionData
    Object.ToString()
    Object.Equals(Object, Object)
    Object.ReferenceEquals(Object, Object)
    Object.GetType()
    Object.MemberwiseClone()
    Namespace: Nevatech.Vsb.Repository.Processing
    Assembly: Nevatech.Vsb.Repository.dll
    Syntax
    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
    public string SourceName { get; set; }
    Property Value
    Type Description
    String

    SourceType

    Gets or sets the source of value to be transformed.

    Declaration
    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
    Boolean

    True, if objects are equal. False, if objects are not equal.

    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
    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
    MessagePipelineComponentBase.Equals(Object)

    GetHashCode()

    Returns the hash code for this instance.

    Declaration
    public override int GetHashCode()
    Returns
    Type Description
    Int32

    Hash code of the current instance.

    Overrides
    MessagePipelineComponentBase.GetHashCode()

    GetSourceValue(MessagePipelineContext, Boolean)

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

    Declaration
    protected string GetSourceValue(MessagePipelineContext context, bool preserveOriginalValue = true)
    Parameters
    Type Name Description
    MessagePipelineContext context

    Current message processing context.

    Boolean 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
    Boolean

    True if state is valid; otherwise, false.

    Overrides
    MessagePipelineComponentBase.Validate()

    Implements

    IValidator
    System.IEquatable<T>
    System.Runtime.Serialization.IExtensibleDataObject
    Back to top Nevatech Sentinet 6.5 Online Documentation