diff options
Diffstat (limited to 'lib/VNLib.Plugins.Extensions.Loading/src/Configuration')
4 files changed, 210 insertions, 0 deletions
diff --git a/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/ConfigScope.cs b/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/ConfigScope.cs new file mode 100644 index 0000000..7f5c09c --- /dev/null +++ b/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/ConfigScope.cs @@ -0,0 +1,83 @@ +/* +* Copyright (c) 2023 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins.Extensions.Loading +* File: ConfigScope.cs +* +* ConfigScope.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 3 of the +* License, or (at your option) any later version. +* +* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +using System; +using System.Linq; +using System.Text.Json; +using System.Collections; +using System.Collections.Generic; +using System.Diagnostics.CodeAnalysis; + + +namespace VNLib.Plugins.Extensions.Loading +{ + internal sealed class ConfigScope: IConfigScope + { + + private readonly Lazy<IReadOnlyDictionary<string, JsonElement>> _config; + + private readonly JsonElement _element; + + internal ConfigScope(JsonElement element, string scopeName) + { + _element = element; + ScopeName = scopeName; + _config = new(LoadTable); + } + + private IReadOnlyDictionary<string, JsonElement> LoadTable() + { + return _element.EnumerateObject().ToDictionary(static k => k.Name, static k => k.Value); + } + + ///<inheritdoc/> + public JsonElement this[string key] => _config.Value[key]; + + ///<inheritdoc/> + public IEnumerable<string> Keys => _config.Value.Keys; + + ///<inheritdoc/> + public IEnumerable<JsonElement> Values => _config.Value.Values; + + ///<inheritdoc/> + public int Count => _config.Value.Count; + + ///<inheritdoc/> + public string ScopeName { get; } + + ///<inheritdoc/> + public bool ContainsKey(string key) => _config.Value.ContainsKey(key); + + ///<inheritdoc/> + public T Deserialze<T>() => _element.Deserialize<T>()!; + + ///<inheritdoc/> + public IEnumerator<KeyValuePair<string, JsonElement>> GetEnumerator() => _config.Value.GetEnumerator(); + + ///<inheritdoc/> + public bool TryGetValue(string key, [MaybeNullWhen(false)] out JsonElement value) => _config.Value.TryGetValue(key, out value); + + IEnumerator IEnumerable.GetEnumerator() => _config.Value.GetEnumerator(); + } +} diff --git a/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IAsyncConfigurable.cs b/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IAsyncConfigurable.cs new file mode 100644 index 0000000..2c51da2 --- /dev/null +++ b/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IAsyncConfigurable.cs @@ -0,0 +1,42 @@ +/* +* Copyright (c) 2023 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins.Extensions.Loading +* File: IAsyncConfigurable.cs +* +* IAsyncConfigurable.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 3 of the +* License, or (at your option) any later version. +* +* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +using System.Threading.Tasks; + +namespace VNLib.Plugins.Extensions.Loading +{ + /// <summary> + /// Allows for asynchronous service configuration during service creation, that + /// will be observed on the plugin + /// </summary> + public interface IAsyncConfigurable + { + /// <summary> + /// Configures the service for use. Exceptions will be written to the + /// plugin's default log provider + /// </summary> + /// <returns>A task that completes when the service has been loaded successfully</returns> + Task ConfigureServiceAsync(PluginBase plugin); + } +} diff --git a/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IConfigScope.cs b/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IConfigScope.cs new file mode 100644 index 0000000..af6f181 --- /dev/null +++ b/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IConfigScope.cs @@ -0,0 +1,47 @@ +/* +* Copyright (c) 2023 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins.Extensions.Loading +* File: IConfigScope.cs +* +* IConfigScope.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 3 of the +* License, or (at your option) any later version. +* +* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +using System.Text.Json; +using System.Collections.Generic; + +namespace VNLib.Plugins.Extensions.Loading +{ + /// <summary> + /// A top-level scoped configuration element + /// </summary> + public interface IConfigScope : IReadOnlyDictionary<string, JsonElement> + { + /// <summary> + /// The root level name of the configuration element + /// </summary> + string ScopeName { get; } + + /// <summary> + /// Json deserialzes the current config scope to the desired type + /// </summary> + /// <typeparam name="T">The type to deserialze the current config to</typeparam> + /// <returns>The instance created from the current scope</returns> + T Deserialze<T>(); + } +} diff --git a/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IOnConfigValidation.cs b/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IOnConfigValidation.cs new file mode 100644 index 0000000..6d4641b --- /dev/null +++ b/lib/VNLib.Plugins.Extensions.Loading/src/Configuration/IOnConfigValidation.cs @@ -0,0 +1,38 @@ +/* +* Copyright (c) 2023 Vaughn Nugent +* +* Library: VNLib +* Package: VNLib.Plugins.Extensions.Loading +* File: IOnConfigValidation.cs +* +* IOnConfigValidation.cs is part of VNLib.Plugins.Extensions.Loading which is part of the larger +* VNLib collection of libraries and utilities. +* +* VNLib.Plugins.Extensions.Loading is free software: you can redistribute it and/or modify +* it under the terms of the GNU Affero General Public License as +* published by the Free Software Foundation, either version 3 of the +* License, or (at your option) any later version. +* +* VNLib.Plugins.Extensions.Loading is distributed in the hope that it will be useful, +* but WITHOUT ANY WARRANTY; without even the implied warranty of +* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +* GNU Affero General Public License for more details. +* +* You should have received a copy of the GNU Affero General Public License +* along with this program. If not, see https://www.gnu.org/licenses/. +*/ + +namespace VNLib.Plugins.Extensions.Loading +{ + /// <summary> + /// Called when a configuration deserialzation occurs, to validate + /// the configuration. + /// </summary> + public interface IOnConfigValidation + { + /// <summary> + /// Validates a json configuration during deserialzation + /// </summary> + void Validate(); + } +} |