Show / Hide Table of Contents

Class ScriptRunner

Executes configuration scripts which are embedded in configuration

Inheritance
System.Object
ScriptRunner
Implements
IConfigurable
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: NFX.Environment
Assembly: NFX.dll
Syntax
public class ScriptRunner : IConfigurable

Fields

CONFIG_SCRIPT_RUNNER_PATH

Declaration
public const string CONFIG_SCRIPT_RUNNER_PATH = "/script-runner"
Field Value
Type Description
System.String

CONFIG_SCRIPT_RUNNER_SECTION

Declaration
public const string CONFIG_SCRIPT_RUNNER_SECTION = "script-runner"
Field Value
Type Description
System.String

CONFIG_TIMEOUT_ATTR

Declaration
public const string CONFIG_TIMEOUT_ATTR = "timeout-ms"
Field Value
Type Description
System.String

DEFAULT_KEYWORD_BLOCK

Declaration
public const string DEFAULT_KEYWORD_BLOCK = "_BLOCK"
Field Value
Type Description
System.String

DEFAULT_KEYWORD_CALL

Declaration
public const string DEFAULT_KEYWORD_CALL = "_CALL"
Field Value
Type Description
System.String

DEFAULT_KEYWORD_ELSE

Declaration
public const string DEFAULT_KEYWORD_ELSE = "_ELSE"
Field Value
Type Description
System.String

DEFAULT_KEYWORD_IF

Declaration
public const string DEFAULT_KEYWORD_IF = "_IF"
Field Value
Type Description
System.String

DEFAULT_KEYWORD_LOOP

Declaration
public const string DEFAULT_KEYWORD_LOOP = "_LOOP"
Field Value
Type Description
System.String

DEFAULT_KEYWORD_SET

Declaration
public const string DEFAULT_KEYWORD_SET = "_SET"
Field Value
Type Description
System.String

DEFAULT_SCRIPT_ONLY_ATTR

Declaration
public const string DEFAULT_SCRIPT_ONLY_ATTR = "script-only"
Field Value
Type Description
System.String

DEFAULT_TIMEOUT_MS

Declaration
public const int DEFAULT_TIMEOUT_MS = 250
Field Value
Type Description
System.Int32

Properties

AttributeScriptOnly

Gets/sets attribute name that indicates that marked entity should not be brough over into script output target

Declaration
public string AttributeScriptOnly { get; set; }
Property Value
Type Description
System.String

KeywordBLOCK

Gets/sets BLOCK keyword - used for unconditional script evaluation block

Declaration
public string KeywordBLOCK { get; set; }
Property Value
Type Description
System.String

KeywordCALL

Gets/sets CALL keyword - used for sub-routine invocation

Declaration
public string KeywordCALL { get; set; }
Property Value
Type Description
System.String

KeywordELSE

Gets/sets ELSE keyword - used for IF-complementary conditional block

Declaration
public string KeywordELSE { get; set; }
Property Value
Type Description
System.String

KeywordIF

Gets/sets IF keyword - used for conditional block

Declaration
public string KeywordIF { get; set; }
Property Value
Type Description
System.String

KeywordLOOP

Gets/sets LOOP keyword - used for repetition block

Declaration
public string KeywordLOOP { get; set; }
Property Value
Type Description
System.String

KeywordSET

Gets/sets SET keyword - used for variable assignment statement

Declaration
public string KeywordSET { get; set; }
Property Value
Type Description
System.String

TimeoutMs

Gets/sets script execution timeout

Declaration
public int TimeoutMs { get; set; }
Property Value
Type Description
System.Int32

Methods

CloneAttributes(ConfigSectionNode, ConfigSectionNode, Boolean)

Declaration
protected virtual void CloneAttributes(ConfigSectionNode from, ConfigSectionNode to, bool evaluate = false)
Parameters
Type Name Description
ConfigSectionNode from
ConfigSectionNode to
System.Boolean evaluate

Configure(IConfigSectionNode)

Declaration
public virtual void Configure(IConfigSectionNode node)
Parameters
Type Name Description
IConfigSectionNode node

DoBLOCK(Stopwatch, ConfigSectionNode, ConfigSectionNode)

Declaration
protected virtual void DoBLOCK(Stopwatch sw, ConfigSectionNode blockStatement, ConfigSectionNode target)
Parameters
Type Name Description
System.Diagnostics.Stopwatch sw
ConfigSectionNode blockStatement
ConfigSectionNode target

DoCALL(Stopwatch, ConfigSectionNode, ConfigSectionNode)

Declaration
protected virtual void DoCALL(Stopwatch sw, ConfigSectionNode callStatement, ConfigSectionNode target)
Parameters
Type Name Description
System.Diagnostics.Stopwatch sw
ConfigSectionNode callStatement
ConfigSectionNode target

DoELSE(Stopwatch, ConfigSectionNode, ConfigSectionNode, ConfigSectionNode)

Declaration
protected virtual void DoELSE(Stopwatch sw, ConfigSectionNode elseStatement, ConfigSectionNode priorStatement, ConfigSectionNode target)
Parameters
Type Name Description
System.Diagnostics.Stopwatch sw
ConfigSectionNode elseStatement
ConfigSectionNode priorStatement
ConfigSectionNode target

DoIF(Stopwatch, ConfigSectionNode, ConfigSectionNode)

Declaration
protected virtual void DoIF(Stopwatch sw, ConfigSectionNode ifStatement, ConfigSectionNode target)
Parameters
Type Name Description
System.Diagnostics.Stopwatch sw
ConfigSectionNode ifStatement
ConfigSectionNode target

DoLOOP(Stopwatch, ConfigSectionNode, ConfigSectionNode)

Declaration
protected virtual void DoLOOP(Stopwatch sw, ConfigSectionNode loopStatement, ConfigSectionNode target)
Parameters
Type Name Description
System.Diagnostics.Stopwatch sw
ConfigSectionNode loopStatement
ConfigSectionNode target

DoNode(Stopwatch, ConfigSectionNode, ConfigSectionNode)

Declaration
protected virtual void DoNode(Stopwatch sw, ConfigSectionNode source, ConfigSectionNode target)
Parameters
Type Name Description
System.Diagnostics.Stopwatch sw
ConfigSectionNode source
ConfigSectionNode target

DoSET(Stopwatch, ConfigSectionNode)

Declaration
protected virtual void DoSET(Stopwatch sw, ConfigSectionNode setStatement)
Parameters
Type Name Description
System.Diagnostics.Stopwatch sw
ConfigSectionNode setStatement

EvaluateAnyExpression(ConfigSectionNode, String)

Declaration
protected virtual string EvaluateAnyExpression(ConfigSectionNode exprContainer, string expression)
Parameters
Type Name Description
ConfigSectionNode exprContainer
System.String expression
Returns
Type Description
System.String

EvaluateBooleanConditionExpression(ConfigSectionNode)

Declaration
protected virtual bool EvaluateBooleanConditionExpression(ConfigSectionNode exprContainer)
Parameters
Type Name Description
ConfigSectionNode exprContainer
Returns
Type Description
System.Boolean

Execute(Configuration, Configuration)

Runs script on the configuration

Declaration
public virtual void Execute(Configuration source, Configuration target)
Parameters
Type Name Description
Configuration source
Configuration target

InitStatement(ConfigSectionNode)

Declaration
protected virtual void InitStatement(ConfigSectionNode statement)
Parameters
Type Name Description
ConfigSectionNode statement

Implements

IConfigurable

Extension Methods

MiscUtils.NonNull<T>(T, Func<Exception>, String)
ObjectValueConversion.AsString(Object, String, ConvertErrorHandling)
ObjectValueConversion.AsNonNullOrEmptyString(Object)
ObjectValueConversion.AsLaconicConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsJSONConfig(Object, ConfigSectionNode, String, ConvertErrorHandling)
ObjectValueConversion.AsXMLConfig(Object, ConfigSectionNode, ConvertErrorHandling)
ObjectValueConversion.AsChar(Object, Char, ConvertErrorHandling)
ObjectValueConversion.AsNullableChar(Object, Nullable<Char>, ConvertErrorHandling)
ObjectValueConversion.AsByte(Object, Byte, ConvertErrorHandling)
ObjectValueConversion.AsNullableByte(Object, Nullable<Byte>, ConvertErrorHandling)
ObjectValueConversion.AsSByte(Object, SByte, ConvertErrorHandling)
ObjectValueConversion.AsNullableSByte(Object, Nullable<SByte>, ConvertErrorHandling)
ObjectValueConversion.AsShort(Object, Int16, ConvertErrorHandling)
ObjectValueConversion.AsNullableShort(Object, Nullable<Int16>, ConvertErrorHandling)
ObjectValueConversion.AsUShort(Object, UInt16, ConvertErrorHandling)
ObjectValueConversion.AsNullableUShort(Object, Nullable<UInt16>, ConvertErrorHandling)
ObjectValueConversion.AsInt(Object, Int32, ConvertErrorHandling)
ObjectValueConversion.AsNullableInt(Object, Nullable<Int32>, ConvertErrorHandling)
ObjectValueConversion.AsUInt(Object, UInt32, ConvertErrorHandling)
ObjectValueConversion.AsNullableUInt(Object, Nullable<UInt32>, ConvertErrorHandling)
ObjectValueConversion.AsLong(Object, Int64, ConvertErrorHandling)
ObjectValueConversion.AsNullableLong(Object, Nullable<Int64>, ConvertErrorHandling)
ObjectValueConversion.AsULong(Object, UInt64, ConvertErrorHandling)
ObjectValueConversion.AsNullableULong(Object, Nullable<UInt64>, ConvertErrorHandling)
ObjectValueConversion.AsDouble(Object, Double, ConvertErrorHandling)
ObjectValueConversion.AsNullableDouble(Object, Nullable<Double>, ConvertErrorHandling)
ObjectValueConversion.AsFloat(Object, Single, ConvertErrorHandling)
ObjectValueConversion.AsNullableFloat(Object, Nullable<Single>, ConvertErrorHandling)
ObjectValueConversion.AsDecimal(Object, Decimal, ConvertErrorHandling)
ObjectValueConversion.AsNullableDecimal(Object, Nullable<Decimal>, ConvertErrorHandling)
ObjectValueConversion.AsBool(Object, Boolean, ConvertErrorHandling)
ObjectValueConversion.AsNullableBool(Object, Nullable<Boolean>, ConvertErrorHandling)
ObjectValueConversion.AsGUID(Object, Guid, ConvertErrorHandling)
ObjectValueConversion.AsNullableGUID(Object, Nullable<Guid>, ConvertErrorHandling)
ObjectValueConversion.AsDateTime(Object)
ObjectValueConversion.AsDateTime(Object, DateTime, ConvertErrorHandling)
ObjectValueConversion.AsNullableDateTime(Object, Nullable<DateTime>, ConvertErrorHandling)
ObjectValueConversion.AsGDID(Object)
ObjectValueConversion.AsGDID(Object, GDID, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDID(Object, Nullable<GDID>, ConvertErrorHandling)
ObjectValueConversion.AsGDIDSymbol(Object)
ObjectValueConversion.AsGDIDSymbol(Object, GDIDSymbol, ConvertErrorHandling)
ObjectValueConversion.AsNullableGDIDSymbol(Object, Nullable<GDIDSymbol>, ConvertErrorHandling)
ObjectValueConversion.AsTimeSpan(Object)
ObjectValueConversion.AsTimeSpan(Object, TimeSpan, ConvertErrorHandling)
ObjectValueConversion.AsNullableTimeSpan(Object, Nullable<TimeSpan>, ConvertErrorHandling)
ObjectValueConversion.AsEnum<TEnum>(Object, TEnum, ConvertErrorHandling)
ObjectValueConversion.AsNullableEnum<TEnum>(Object, Nullable<TEnum>, ConvertErrorHandling)
ObjectValueConversion.AsUri(Object, Uri, ConvertErrorHandling)
JSONExtensions.ToJSON(Object, JSONWritingOptions)
JSONExtensions.ToJSON(Object, TextWriter, JSONWritingOptions)
JSONExtensions.ToJSON(Object, Stream, JSONWritingOptions, Encoding)
ErlObject.ToErlObject(Object)
ErlObject.ToErlObject(Object, ErlTypeOrder, Boolean)
Back to top Copyright © 2006-2018 Agnicore Inc
Generated by DocFX