Configuration Provider interface that provides read and write services to various configuration storage mechanisms.
Used in conjunction with the Westwind.Utilities.Configuration.AppConfiguration class. A base implementation from which to inherit is provided in the Westwind.Utilities.Configuration.ConfigurationProviderBase`1 class.
public interface IConfigurationProvider
Interface Members
Member | Description | |
---|---|---|
DecryptFields |
Decryptes the encyrpted fields in a config object a public void DecryptFields(AppConfiguration config) |
|
EncryptFields |
Encrypts fields in a config object as specified in the cref="PropertiesToEncrypt" property. public void EncryptFields(AppConfiguration config) |
|
Read |
Reads configuration information into a provided config object instance public bool Read(AppConfiguration config) public bool Read(AppConfiguration config, string xml) |
|
Read |
Reads configuration information into new configuration object instance public T Read public T Read |
|
Write |
Writes configuration information into a provided object instance public bool Write(AppConfiguration config) |
|
WriteAsString |
Writes configuration for a provided config object and returns the serialized data as a string. public string WriteAsString(AppConfiguration config) |
|
ConfigurationSection |
Optional Section name that can be used to sub-segment in multi-config files | |
EncryptionKey |
The encryption key used to encrypt fields in config objects | |
ErrorMessage |
Holds an error message after a read or write operation failed. | |
PropertiesToEncrypt |
A comma delimited list of fields that are to be encrypted |
Requirements
Namespace: Westwind.Utilities.ConfigurationAssembly: westwind.utilities.dll
See also:
Westwind.Utilities.Configuration.AppConfiguration | Westwind.Utilities.Configuration.ConfigurationProviderBase`1© West Wind Technologies, 1996-2024 • Updated: 06/29/24
Comment or report problem with topic