SAIF.Framework.Security.EnvironmentApi API reference¶
This page lists all public types exposed by SAIF.Framework.Security.EnvironmentApi. Each type links to its full API reference page.
Types¶
| Type | Kind | Namespace | Purpose |
|---|---|---|---|
| IEnvironmentService | Interface | SAIF.Framework.Security |
Primary contract for environment/config/user-context access |
| IEnvironmentServiceExtensions | Class (static, extension methods) | SAIF.Framework.Security |
Extension methods for EnvironmentServiceBase (UserId()); documented within IEnvironmentService.md |
| EnvironmentServiceBase | Class | SAIF.Framework.Security |
Abstract base implementation of IEnvironmentService; performs HTTP calls to the Environment API, holds the in-memory settings cache, refresh logic, and developer-machine authorization logic |
| WebEnvironmentService | Class | SAIF.Framework.Security |
ASP.NET web-app environment service using HttpContext.Current |
| WindowsEnvironmentService | Class | SAIF.Framework.Security |
Console/Windows-service environment service; resolves host/track from the entry assembly |
| WcfEnvironmentService | Class | SAIF.Framework.Security |
WCF service-host environment service; resolves app id/host from RequestContext |
| CustomEnvironmentService | Class | SAIF.Framework.Security |
Environment service for hosting contexts where the host is explicitly supplied by the caller |
| OfficeAddinEnvironmentService | Class | SAIF.Framework.Security |
Environment service for Office add-in hosting contexts; host resolved from a fixed OfficeEnvironment enum |
| IWebEnvironmentService | Interface | SAIF.Framework.Security |
Narrower host/client-context contract implemented by WebEnvironmentService |
| EnvironmentConfigKeys | Class (static) | SAIF.Framework.Security |
Well-known configuration key name constants (databases, web services, APIs) |
| EnvironmentHost | Class | SAIF.Framework.Security |
Resolves a Uri's host into the naming convention expected by the Environment API |
| ApplicationEnvironment | Enum | SAIF.Framework.Security |
Deployment tier returned by IEnvironmentService.GetApplicationEnvironment() |
| Constants | Class | SAIF.Framework.Security |
Holds the GlobalSection constant identifying the global (non-custom) configuration section |
| MissingEnvironmentUrlVariableException | Class (exception) | SAIF.Framework.Security.EnvironmentApi.Exceptions |
Thrown when the required EnvironmentApiUrl OS environment variable is missing |
| MachineSecurityService | Class | SAIF.Framework.Security.Utilities |
Reusable AD group-membership authorization primitive for machine/service accounts |
| ADService | Class (internal) | SAIF.Framework.Security.Utilities |
Internal recursive AD group-membership lookup via System.DirectoryServices/AccountManagement; not part of this library's public API surface |
| SecurityServiceClient | Class | ClientProxies |
Thin WCF client wrapper calling the generated SecurityService.SecurityClient proxy's GetUsersByGroup |
| SystemHashUtil | Class | SAIF.Services.Common |
Static class generating/validating salted system hashes for secure config retrieval |
| SystemType | Enum | SAIF.Services.Common |
System-type classification used to add uniqueness to generated system hashes |
| ConfigurationSettings | Class | SAIF.Core.Contracts.Core |
In-memory container for a loaded/cached set of configuration settings and cache-freshness metadata |
| ConfigKey | Class | SAIF.Core.Contracts.Core |
Identifies a configuration setting by track, section, and key, with formatting/parsing helpers |
| ConfigValue | Class | SAIF.Core.Contracts.Core |
A single time-bounded value for a configuration setting |
| ConfigSetting | Class | SAIF.Core.Contracts.Core |
Pairs a ConfigKey with its current ConfigValue |
| ConfigSettingHistory | Class | SAIF.Core.Contracts.Core |
Full ordered value history for a single configuration key |
| ConfigSettingRequest | Class | SAIF.Core.Contracts.Core |
DTO representing a request to persist one or more configuration settings |
| Track | Class | SAIF.Core.Contracts.EnvironmentApi |
DTO describing a named deployment track and its associated hosts |
Sources¶
- SAIF.Framework.Security.EnvironmentApi\Core\Services\IEnvironmentService.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\EnvironmentServiceBase.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\WebEnvironmentService.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\WindowsEnvironmentService.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\WcfEnvironmentService.cs
- SAIF.Framework.Security.EnvironmentApi\Core\Services\MachineSecurityService.cs
- SAIF.Framework.Security.EnvironmentApi\Core\Services\ADService.cs
- SAIF.Framework.Security.EnvironmentApi\Core\Services\SecurityServiceClient.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\SystemHashUtil.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\CustomEnvironmentService.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\OfficeAddinEnvironmentService.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\IWebEnvironmentService.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\EnvironmentConfigKeys.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\EnvironmentHost.cs
- SAIF.Framework.Security.EnvironmentApi\Core\ApplicationEnvironment.cs
- SAIF.Framework.Security.EnvironmentApi\Exceptions\MissingEnvironmentUrlVariableException.cs
- SAIF.Framework.Security.EnvironmentApi\Core\Contracts\Core\Configurations\ConfigurationSettings.cs
- SAIF.Framework.Security.EnvironmentApi\Core\Contracts\Core\Configurations\ConfigSettingRequest.cs
- SAIF.Framework.Security.EnvironmentApi\Core\Contracts\EnvironmentApi\Track.cs