SAIF.NetCore.EnvironmentClient API reference¶
This library exposes 16 public types. Two internal configuration-reader types (ClientConfigBase, GetHostsByTrackConfig) are not part of the public API and are not documented here.
Types¶
| Type | Kind | Namespace | Purpose |
|---|---|---|---|
BaseEnvironmentClient |
class | SAIF.NetCore.Services.EnvironmentClient |
Default IEnvironmentClient implementation: resolves host/track, loads non-secure settings, always denies secure-setting retrieval |
SecureEnvironmentClient |
class | SAIF.NetCore.Services.EnvironmentClient |
BaseEnvironmentClient subclass that is actually able to retrieve secure (crypto) settings, subject to an authorization gate |
SecureSettingCache |
class | SAIF.NetCore.EnvironmentClient |
Time-based cache of secure-setting values, keyed by section+key |
SecureSettingCacheItem |
class | SAIF.NetCore.EnvironmentClient |
A single cached secure-setting entry |
IHostResolver |
interface | SAIF.NetCore.Services.EnvironmentClient |
Contract for resolving the running host and whether it is a developer-machine override |
HostResolver |
class | SAIF.NetCore.Services.EnvironmentClient |
Default IHostResolver implementation; performs the AD Developer_Machine_Users check |
ISystemWrapper |
interface | SAIF.NetCore.Services.EnvironmentClient |
Testability seam over Environment.MachineName |
SystemWrapper |
class | SAIF.NetCore.Services.EnvironmentClient |
Default ISystemWrapper implementation |
ConfigKey |
DTO | SAIF.NetCore.Services.EnvironmentClient.Data |
Identifies a configuration setting by track/section/key |
ConfigValue |
DTO | SAIF.NetCore.Services.EnvironmentClient.Data |
Wraps a setting's raw string value |
ConfigSetting |
DTO | SAIF.NetCore.Services.EnvironmentClient.Data |
Pairs a ConfigKey with a ConfigValue |
ConfigurationSettings |
DTO | SAIF.NetCore.Services.EnvironmentClient.Data |
A track's full collection of ConfigSetting values |
Track |
DTO | SAIF.NetCore.Services.EnvironmentClient.Data |
An environment track and its member hosts |
EnvironmentClientException |
exception | SAIF.NetCore.Services.EnvironmentClient.Exceptions |
General-purpose exception raised for client/API failures |
MissingEnvironmentUrlVariableException |
exception | SAIF.NetCore.Exceptions |
Raised when the EnvironmentApiUrl environment variable is missing at construction |
ConfigSettingExtensions |
static class | SAIF.NetCore.Services.EnvironmentClient.Extensions |
Typed-value conversion helpers for ConfigSetting |
Related documentation¶
- Index
- Overview
- Architecture
- Dependencies
- Configuration
- Operations and processes
- Business rules
- Security and authorization
Sources¶
src/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/BaseEnvironmentClient.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SecureEnvironmentClient.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SecureSettingCache.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/HostResolver.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/IHostResolver.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/ISystemWrapper.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SystemWrapper.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/Data/ConfigKey.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/Data/ConfigValue.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/Data/ConfigSetting.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/Data/ConfigurationSettings.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/Data/Track.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/Exceptions/EnvironmentClientException.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/Exceptions/MissingEnvironmentUrlVariableException.cssrc/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/SAIF.NetCore.EnvironmentClient/Extensions/ConfigSettingExtensions.cs