Class ContextProperty
Represents a message processing context property that needs to be set, replaced, or removed for an intercepted message.
Inherited Members
Namespace: Nevatech.Vsb.Repository.Processing
Assembly: Nevatech.Vsb.Repository.dll
Syntax
public sealed class ContextProperty : IValidator, IEquatable<ContextProperty>Constructors
ContextProperty()
Declaration
public ContextProperty()Fields
ContextPropertyNameFormat
Regular expression used for validating a context property name.
Declaration
public static readonly Regex ContextPropertyNameFormatField Value
| Type | Description |
|---|---|
| Regex |
ElementName
Name of the root element when object is serialized to XML.
Declaration
public const string ElementName = "PROPERTY"Field Value
| Type | Description |
|---|---|
| String |
Properties
Action
Gets or sets the action to take if a property is already present. Note that appending to an existing value is only supported for string values and uses ";" as separator.
Declaration
public ExistingValueAction Action { get; set; }Property Value
| Type | Description |
|---|---|
| ExistingValueAction |
ErrorMessage
Gets the summary of validation errors populated by the call to Validate() method.
Declaration
public string ErrorMessage { get; }Property Value
| Type | Description |
|---|---|
| String |
Name
Gets or sets the property name.
Declaration
public string Name { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Source
Gets or sets the source of the value to be taken from.
Declaration
public ContextPropertySource Source { get; set; }Property Value
| Type | Description |
|---|---|
| ContextPropertySource |
Value
Gets or sets the static property value or parameter specifying how that value needs to be retrieved which is specific to the property source. If set to Null then existing property will be deleted.
Declaration
public string Value { get; set; }Property Value
| Type | Description |
|---|---|
| String |
Remarks
Property must be populated with the following depending on the Source property value:
ValueExtractor
Gets or sets the value extractor instance that allows to further limit or format the value retrieved from the source. For example, it can be used to select a specific element's value by XPATH from the message body, convert an object stored in the message property to a string, etc. If property is not set then value is stored as-is.
Declaration
public ValueExtractorBase ValueExtractor { get; set; }Property Value
| Type | Description |
|---|---|
| ValueExtractorBase |
Methods
Equals(ContextProperty)
Determines whether the specified object is equal to the current object.
Declaration
public bool Equals(ContextProperty other)Parameters
| Type | Name | Description |
|---|---|---|
| ContextProperty | other | The object to compare with the current object. |
Returns
| Type | Description |
|---|---|
| Boolean | 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 |
|---|---|
| Boolean | 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 |
|---|---|
| Int32 | Hash code of the current instance. |
Overrides
ToString()
Returns string representation of the object.
Declaration
public override string ToString()Returns
| Type | Description |
|---|---|
| String | String representing the object's content. |
Overrides
Validate()
Evaluates the state of this object.
Declaration
public bool Validate()Returns
| Type | Description |
|---|---|
| Boolean | True if state is valid; otherwise, false. |