Base Configuration Provider Implementation. This implementation provides for the basic layout of a provider and fields that implement the IConfigurationProvider interface.
The Read and Write methods must be overridden - all other methods and fields are optional
Westwind.Utilities.Configuration.ConfigurationProviderBase<TAppConfiguration>
public abstract class ConfigurationProviderBase<TAppConfiguration> : object, IConfigurationProvider
Class Members
Member | Description | |
---|---|---|
DecryptFields |
Internally decryptes all the fields in the current object based on the EncryptFieldList public virtual void DecryptFields(AppConfiguration config) |
|
EncryptFields |
Encrypts all the fields in the current object based on the EncryptFieldList public virtual void EncryptFields(AppConfiguration config) |
|
Read |
Reads configuration settings from the store into a passed instance of the configuration instance. public abstract bool Read(AppConfiguration config) public virtual bool Read(AppConfiguration config, string xml) |
|
Read |
Reads a configurations settings from the configuration store into a new existing instance. public abstract T Read public virtual T Read |
|
Write |
Writes the configuration settings from a specific instance into the configuration store. public abstract bool Write(AppConfiguration config) |
|
WriteAsString |
Writes the current configuration information to an XML string. String is XML Serialization format. public virtual string WriteAsString(AppConfiguration config) |
|
ConfigurationSection |
Optional Section name that can differentiate groups of config values in multi-section files like Config files. | |
EncryptionKey |
The encryption key to encrypt the fields set with FieldsToEncrypt | |
ErrorMessage |
Displays error information when results fail. | |
PropertiesToEncrypt |
A comma delimiter list of property names that are to be encrypted when persisted to the store |
Requirements
Namespace: Westwind.Utilities.ConfigurationAssembly: westwind.utilities.dll
© West Wind Technologies, 1996-2024 • Updated: 06/29/24
Comment or report problem with topic