51Degrees Pipeline .NET  4.1

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.FiftyOneOnPremiseAspectEngineBase< T > Class Template Reference abstract

Detailed Description

51Degrees specific Engine base class.

This adds the concept of license keys to the standard Engine base class.

Template Parameters
T -
Type Constraints
T :IAspectData 

Inheritance diagram for FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.FiftyOneOnPremiseAspectEngineBase< T >:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.FiftyOneOnPremiseAspectEngineBase< T >:

[legend]

Public Member Functions

 FiftyOneOnPremiseAspectEngineBase (ILogger< FiftyOneOnPremiseAspectEngineBase< T >> logger, Func< IPipeline, FlowElementBase< T, IFiftyOneAspectPropertyMetaData >, T > aspectDataFactory, string tempDataFilePath)
Constructor More...
abstract string  GetDataDownloadType (string identifier)
The default value for the 'Type' parameter when checking for updates from the 51Degrees 'Distributor' web service. More...

Public Member Functions inherited from FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, IFiftyOneAspectPropertyMetaData >

 OnPremiseAspectEngineBase (ILogger< AspectEngineBase< T, TMeta >> logger, Func< IPipeline, FlowElementBase< T, TMeta >, T > aspectDataFactory, string tempDataFilePath)
Constructor More...
IAspectEngineDataFile  GetDataFileMetaData (string dataFileIdentifier=null)
Get the details of a specific data file used by this engine. More...
abstract void  RefreshData (string dataFileIdentifier)
Causes the engine to reload data from the file at IAspectEngineDataFile.DataFilePath for the data file matching the given identifier. More...
abstract void  RefreshData (string dataFileIdentifier, Stream data)
Causes the engine to reload data from the supplied Stream for the file matching the given identifier. More...
virtual void  AddDataFile (IAspectEngineDataFile dataFile)
Add the specified data file to the engine. More...

Public Member Functions inherited from FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine

void  RefreshData (string dataFileIdentifier)
Causes the engine to reload data from the file at IAspectEngineDataFile.DataFilePath for the data file matching the given identifier. More...
void  RefreshData (string dataFileIdentifier, Stream data)
Causes the engine to reload data from the supplied Stream for the file matching the given identifier. More...
IAspectEngineDataFile  GetDataFileMetaData (string dataFileIdentifier=null)
Get the details of a specific data file used by this engine. More...
void  AddDataFile (IAspectEngineDataFile dataFile)
Add the specified data file to the engine. More...

Properties

abstract IEnumerable< IProfileMetaData >  Profiles [get]
The profiles that are present in the data source for this engine. More...
abstract IEnumerable< IComponentMetaData >  Components [get]
The components that are present in the data source for this engine. More...
abstract IEnumerable< IValueMetaData >  Values [get]
The values that are present in the data source for this engine. More...

Properties inherited from FiftyOne.Pipeline.Engines.FlowElements.OnPremiseAspectEngineBase< T, IFiftyOneAspectPropertyMetaData >

string  TempDataDirPath [get, protected set]
Directory to use as a temporary file location when required. More...

Properties inherited from FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.IFiftyOneAspectEngine

IEnumerable< IProfileMetaData >  Profiles [get]
All profiles contained in the data set which the Engine is using. More...
IEnumerable< IComponentMetaData >  Components [get]
All data components contained in the data set which the Engine is using e.g. More...
IEnumerable< IValueMetaData >  Values [get]
All property values contained in the data set which the Engine is using. More...

Properties inherited from FiftyOne.Pipeline.Engines.FlowElements.IOnPremiseAspectEngine

IReadOnlyList< IAspectEngineDataFile >  DataFiles [get]
Details of the data files used by this engine. More...
string  TempDataDirPath [get]
The complete file path to the directory that is used by the engine to store temporary copies of any data files that it uses. More...

Constructor & Destructor Documentation

◆ FiftyOneOnPremiseAspectEngineBase()

Constructor

Parameters
logger - The logger to use
aspectDataFactory - The factory function to use when the engine creates an AspectDataBase instance.
tempDataFilePath - The directory to use when storing temporary copies of the data file(s) used by this engine.

Member Function Documentation

◆ GetDataDownloadType()

abstract string FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.FiftyOneOnPremiseAspectEngineBase< T >.GetDataDownloadType ( string   identifier )
pure virtual

The default value for the 'Type' parameter when checking for updates from the 51Degrees 'Distributor' web service.

Parameters
identifier - The identifier for the data file that we want to get the download type for.
Returns
The string value to use for the 'Type' parameter when making a request to the 51Degrees Distributor.

Implements FiftyOne.Pipeline.Engines.FiftyOne.FlowElements.IFiftyOneAspectEngine.

Property Documentation

◆ Components

The components that are present in the data source for this engine.

A 'component' refers to a logical sub-set of the collection of properties related to an event (usually an HTTP request). For example, the 'hardwareProfile' component groups all properties related to the hardware device that is being used to make the request. Examples of other components would be: the operating system, the browser software, the physical location the request is being made from, the ISP serving the request, etc.

◆ Values

The values that are present in the data source for this engine.

A 'value' is uniquely identified by the combination of a property and a value that property can have. For example, 'HardwareModel' is a property and a possible value could be 'A1234'. If another property 'HardwareVariants' had the same value of 'A1234', that would be a separate IValueMetaData instance.