MediaBrowser.Common/Configuration/IConfigurationFactory.cs


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47

using System;
using System.Collections.Generic;

namespace MediaBrowser.Common.Configuration
{
    /// <summary>
    /// Provides an interface to retrieve a configuration store. Classes with this interface are scanned for at
    /// application start to dynamically register configuration for various modules/plugins.
    /// </summary>
    public interface IConfigurationFactory
    {
        /// <summary>
        /// Get the configuration store for this module.
        /// </summary>
        /// <returns>The configuration store.</returns>
        IEnumerable<ConfigurationStore> GetConfigurations();
    }

    /// <summary>
    /// Describes a single entry in the application configuration.
    /// </summary>
    public class ConfigurationStore
    {
        /// <summary>
        /// Gets or sets the unique identifier for the configuration.
        /// </summary>
        public string Key { get; set; }

        /// <summary>
        /// Gets or sets the type used to store the data for this configuration entry.
        /// </summary>
        public Type ConfigurationType { get; set; }
    }

    /// <summary>
    /// A configuration store that can be validated.
    /// </summary>
    public interface IValidatingConfiguration
    {
        /// <summary>
        /// Validation method to be invoked before saving the configuration.
        /// </summary>
        /// <param name="oldConfig">The old configuration.</param>
        /// <param name="newConfig">The new configuration.</param>
        void Validate(object oldConfig, object newConfig);
    }
}