51Degrees Pipeline .NET  4.1Newer Version 4.2

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.

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 [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 = true [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 = true [get, set]
If true, a FileSystemWatcher will be created to watch the file at DataFilePath. More...
int  PollingIntervalSeconds = Constants.DATA_UPDATE_POLLING_DEFAULT [get, set]
The interval between checks for updates for this data file using the specified DataUpdateUrl. More...
int  MaxRandomisationSeconds = Constants.DATA_UPDATE_RANDOMISATION_DEFAULT [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 = true [get, set]
Must return true if the data downloaded from the DataUpdateUrl is compressed and false otherwise. More...
bool  VerifyMd5 = true [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 = true [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 = false [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 = false [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.