\r\n

51Degrees Pipeline .NET  4.4

51Degrees Pipeline for .NET

FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration Class Reference

Detailed Description

This class contains the automatic update configuration parameters that can be supplied to an engine for a particular data file that the engine uses.

See the Specification

Inheritance diagram for FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration:

[legend]

Collaboration diagram for FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration:

[legend]

Public Member Functions

 DataFileConfiguration ()
Create DataFileConfiguration instance with all default values. More...

Properties

string  Identifier = Constants.DATA_FILE_DEFAULT_IDENTIFIER [get, set]
The identifier of the data file that this configuration information applies to. More...
string  DataFilePath [get, set]
The complete file path to the location of the data file. More...
bool  CreateTempCopy [get, set]
Set to true if the engine should create a temporary copy of the data file rather than using the one at the location provided directly. More...
bool  MemoryOnly [get, set]
True if data for this file should only exist in memory. More...
Stream  DataStream [get, set]
The Stream containing the data. More...
string  DataUpdateUrl [get, set]
The URL to check when looking for updates to the data file. More...
bool  AutomaticUpdatesEnabled [get, set]
Flag that indicates if updates to the data file will be checked for and applied to the engine automatically or not. More...
IReadOnlyList< string >  DataUpdateLicenseKeys = new List<string>() [get, set]
A list of license keys to use when checking for updates using the DataUpdateUrl. More...
bool  FileSystemWatcherEnabled [get, set]
If true, a FileSystemWatcher will be created to watch the file at DataFilePath. More...
int  PollingIntervalSeconds [get, set]
The interval between checks for updates for this data file using the specified DataUpdateUrl. More...
int  MaxRandomisationSeconds [get, set]
The maximum time in seconds that the polling interval may be randomized by. More...
IDataUpdateUrlFormatter  UrlFormatter = null [get, set]
The formatter to use when getting the data update URL with query string parameters set. More...
bool  DecompressContent = Constants.DATA_FILE_DEFAULT_DECOMPRESS [get, set]
Must return true if the data downloaded from the DataUpdateUrl is compressed and false otherwise. More...
bool  VerifyMd5 = Constants.DATA_FILE_DEFAULT_VERIFY_MD5 [get, set]
Must return true if the response from the DataUpdateUrl is expected to include a 'Content-Md5' HTTP header that contains an Md5 hash that can be used to check the integrity of the downloaded content. More...
bool  VerifyModifiedSince [get, set]
Must return true if the request to the DataUpdateUrl supports the 'If-Modified-Since' header and false if it does not. More...
bool  UpdateOnStartup = Constants.DATA_FILE_DEFAULT_UPDATE_ON_STARTUP [get, set]
If true then when this file is registered with the data update service, it will immediately try to download the latest copy of the file. More...
bool  LicenseKeyRequiredForUpdates [get, set]
If true then, if updates are enabled, the software will check that a license key is present when the associated engine is built. More...

Properties inherited from FiftyOne.Pipeline.Engines.Configuration.IDataFileConfiguration

string  Identifier [get, set]
The identifier of the data file that this configuration information applies to. More...
string  DataFilePath [get, set]
The complete file path to the location of the data file. More...
bool  CreateTempCopy [get, set]
Set to true if the engine should create a temporary copy of the data file rather than using the one at the location provided directly. More...
bool  MemoryOnly [get, set]
True if data for this file should only exist in memory. More...
Stream  DataStream [get, set]
The Stream containing the data. More...
string  DataUpdateUrl [get, set]
The URL to check when looking for updates to the data file. More...
bool  AutomaticUpdatesEnabled [get, set]
Flag that indicates if updates to the data file will be checked for and applied to the engine automatically or not. More...
IReadOnlyList< string >  DataUpdateLicenseKeys [get, set]
A list of license keys to use when checking for updates using the DataUpdateUrl. More...
bool  FileSystemWatcherEnabled [get, set]
If true, a FileSystemWatcher will be created to watch the file at DataFilePath. More...
int  PollingIntervalSeconds [get, set]
The interval between checks for updates for this data file using the specified DataUpdateUrl. More...
int  MaxRandomisationSeconds [get, set]
The maximum time in seconds that the polling interval may be randomized by. More...
IDataUpdateUrlFormatter  UrlFormatter [get, set]
The formatter to use when getting the data update URL with query string parameters set. More...
bool  DecompressContent [get, set]
Must return true if the data downloaded from the DataUpdateUrl is compressed and false otherwise. More...
bool  VerifyMd5 [get, set]
Must return true if the response from the DataUpdateUrl is expected to include a 'Content-Md5' HTTP header that contains an Md5 hash that can be used to check the integrity of the downloaded content. More...
bool  VerifyModifiedSince [get, set]
Must return true if the request to the DataUpdateUrl supports the 'If-Modified-Since' header and false if it does not. More...
bool  UpdateOnStartup [get, set]
If true then when this file is registered with the data update service, it will immediately try to download the latest copy of the file. More...
bool  LicenseKeyRequiredForUpdates [get]
If true then, if updates are enabled, the software will check that a license key is present when the associated engine is built. More...

Constructor & Destructor Documentation

◆ DataFileConfiguration()

FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.DataFileConfiguration ( )

Create DataFileConfiguration instance with all default values.

Property Documentation

◆ AutomaticUpdatesEnabled

bool FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.AutomaticUpdatesEnabled
get set
Initial value:
=
Constants.DATA_FILE_DEFAULT_AUTO_UPDATES_ENABLED

Flag that indicates if updates to the data file will be checked for and applied to the engine automatically or not.

◆ CreateTempCopy

bool FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.CreateTempCopy
get set

Set to true if the engine should create a temporary copy of the data file rather than using the one at the location provided directly.

This setting must be set to true if automatic updates are required.

◆ DataFilePath

string FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.DataFilePath
get set

The complete file path to the location of the data file.

This value will be null if the instance has the MemoryOnly flag set.

◆ DataStream

Stream FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.DataStream
get set

The Stream containing the data.

Note that this will be set to null after being read by the engine in order to reduce memory usage.

◆ DataUpdateLicenseKeys

IReadOnlyList<string> FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.DataUpdateLicenseKeys = new List<string>()
get set

A list of license keys to use when checking for updates using the DataUpdateUrl.

Note that the exact formatting of the query string is controlled by the configured UrlFormatter.

◆ DataUpdateUrl

string FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.DataUpdateUrl
get set

The URL to check when looking for updates to the data file.

◆ DecompressContent

bool FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.DecompressContent = Constants.DATA_FILE_DEFAULT_DECOMPRESS
get set

Must return true if the data downloaded from the DataUpdateUrl is compressed and false otherwise.

◆ FileSystemWatcherEnabled

bool FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.FileSystemWatcherEnabled
get set
Initial value:
=
Constants.DATA_FILE_DEFAULT_FILESYSTEMWATCHER_ENABLED

If true, a FileSystemWatcher will be created to watch the file at DataFilePath.

If the file is modified then the engine will automatically be notified so that it can refresh it's internal data structures.

◆ Identifier

string FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.Identifier = Constants.DATA_FILE_DEFAULT_IDENTIFIER
get set

The identifier of the data file that this configuration information applies to.

If the engine only supports a single data file then this value will be ignored.

◆ LicenseKeyRequiredForUpdates

bool FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.LicenseKeyRequiredForUpdates
get set
Initial value:
=
Constants.DATA_FILE_DEFAULT_LICENSE_KEY_REQUIRED

If true then, if updates are enabled, the software will check that a license key is present when the associated engine is built.

If a license key has not been supplied, an exception will be thrown.

◆ MaxRandomisationSeconds

int FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.MaxRandomisationSeconds
get set
Initial value:
=
Constants.DATA_FILE_DEFAULT_RANDOMISATION_SECONDS

The maximum time in seconds that the polling interval may be randomized by.

I.e. each polling interval will be the configured interval + or - a random amount between zero and this value.

This settings is intended to be used to allow multiple instances of a system stagger their update requests to reduce chance of conflict errors or slow update downloads.

◆ MemoryOnly

bool FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.MemoryOnly
get set

True if data for this file should only exist in memory.

I.e. Assume there is no file system.

◆ PollingIntervalSeconds

int FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.PollingIntervalSeconds
get set
Initial value:
=
Constants.DATA_FILE_DEFAULT_UPDATE_POLLING_SECONDS

The interval between checks for updates for this data file using the specified DataUpdateUrl.

◆ UpdateOnStartup

bool FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.UpdateOnStartup = Constants.DATA_FILE_DEFAULT_UPDATE_ON_STARTUP
get set

If true then when this file is registered with the data update service, it will immediately try to download the latest copy of the file.

This action will block execution until the download is complete and the engine has loaded the new file.

◆ UrlFormatter

IDataUpdateUrlFormatter FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.UrlFormatter = null
get set

The formatter to use when getting the data update URL with query string parameters set.

◆ VerifyMd5

bool FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.VerifyMd5 = Constants.DATA_FILE_DEFAULT_VERIFY_MD5
get set

Must return true if the response from the DataUpdateUrl is expected to include a 'Content-Md5' HTTP header that contains an Md5 hash that can be used to check the integrity of the downloaded content.

◆ VerifyModifiedSince

bool FiftyOne.Pipeline.Engines.Configuration.DataFileConfiguration.VerifyModifiedSince
get set
Initial value:
=
Constants.DATA_FILE_DEFAULT_VERIFY_MODIFIED_SINCE

Must return true if the request to the DataUpdateUrl supports the 'If-Modified-Since' header and false if it does not.