solid-instruments/src/RapidField.SolidInstruments.InversionOfControl/IDependencyPackage.cs at master · RapidField/solid-instruments · GitHub

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
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
// =================================================================================================================================
// Copyright (c) RapidField LLC. Licensed under the MIT License. See LICENSE.txt in the project root for license information.
// =================================================================================================================================

using Microsoft.Extensions.Configuration;
using Microsoft.Extensions.DependencyInjection;
using System;
using System.Collections.Generic;

namespace RapidField.SolidInstruments.InversionOfControl
{
    /// <summary>
    /// Encapsulates container configuration for an application.
    /// </summary>
    /// <typeparam name="TConfigurator">
    /// The type of the object that configures containers.
    /// </typeparam>
    /// <typeparam name="TEngine">
    /// The type of the dependency engine that is produced by the package.
    /// </typeparam>
    public interface IDependencyPackage<TConfigurator, TEngine> : IDependencyPackage<TConfigurator>
        where TConfigurator : class, new()
        where TEngine : class, IDependencyEngine
    {
        /// <summary>
        /// Creates a new dependency engine that is configured by the current
        /// <see cref="IDependencyPackage{TConfigurator, TEngine}" />.
        /// </summary>
        /// <param name="applicationConfiguration">
        /// Configuration information for the application.
        /// </param>
        /// <returns>
        /// The resulting dependency engine.
        /// </returns>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="applicationConfiguration" /> is <see langword="null" />.
        /// </exception>
        /// <exception cref="ContainerConfigurationException">
        /// An exception was raised while attempting to configure a container.
        /// </exception>
        public TEngine CreateEngine(IConfiguration applicationConfiguration);

        /// <summary>
        /// Creates a new dependency engine that is configured by the current
        /// <see cref="IDependencyPackage{TConfigurator, TEngine}" />.
        /// </summary>
        /// <param name="applicationConfiguration">
        /// Configuration information for the application.
        /// </param>
        /// <param name="serviceDescriptors">
        /// A collection of service descriptors to which the engine will supply dependencies.
        /// </param>
        /// <returns>
        /// The resulting dependency engine.
        /// </returns>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="applicationConfiguration" /> is <see langword="null" /> -or- <paramref name="serviceDescriptors" /> is
        /// <see langword="null" />.
        /// </exception>
        /// <exception cref="ContainerConfigurationException">
        /// An exception was raised while attempting to configure a container.
        /// </exception>
        public TEngine CreateEngine(IConfiguration applicationConfiguration, IServiceCollection serviceDescriptors);
    }

    /// <summary>
    /// Encapsulates container configuration for an application.
    /// </summary>
    /// <typeparam name="TConfigurator">
    /// The type of the object that configures containers.
    /// </typeparam>
    public interface IDependencyPackage<TConfigurator>
        where TConfigurator : class, new()
    {
        /// <summary>
        /// Gets a collection of dependency modules for the package.
        /// </summary>
        /// <param name="applicationConfiguration">
        /// Configuration information for the application.
        /// </param>
        /// <returns>
        /// A collection of dependency modules.
        /// </returns>
        /// <exception cref="ArgumentNullException">
        /// <paramref name="applicationConfiguration" /> is <see langword="null" />.
        /// </exception>
        /// <exception cref="ContainerConfigurationException">
        /// An exception was raised while attempting to create the modules for the package.
        /// </exception>
        public IEnumerable<IDependencyModule<TConfigurator>> GetModules(IConfiguration applicationConfiguration);
    }
}