MissingEnvironmentUrlVariableException¶
MissingEnvironmentUrlVariableException is thrown when a consumer attempts to use an environment service on a machine that lacks the required EnvironmentApiUrl OS environment variable (see BR-002).
Purpose¶
- Signal that the Environment API base URL cannot be resolved because the required OS environment variable is missing, causing environment service initialization/usage to fail fast.
Context¶
- Namespace:
SAIF.Framework.Security.EnvironmentApi.Exceptions - Assembly/package:
SAIF.Framework.Security.EnvironmentApi
Public members¶
| Member | Signature | Purpose |
|---|---|---|
| MissingEnvironmentUrlVariableException() | public MissingEnvironmentUrlVariableException() |
Constructs the exception with the fixed message "EnvironmentClient cannot initialize. Missing required OS system environment variable: EnvironmentApiUrl". |
Behavioral notes¶
- Thrown by
EnvironmentServiceBase.EnvironmentApiUrlwhen theEnvironmentApiUrlOS environment variable is absent, per BR-002. - Inherits standard
Exceptionbehavior (message, stack trace) from the .NET base class library; no additional custom properties are defined.
Constraints and usage notes¶
- Consumers should ensure the
EnvironmentApiUrlOS environment variable is set in every hosting environment before instantiating anyEnvironmentServiceBasesubclass.
Note: Statements marked with * were inferred from code structure, naming conventions, or contextual evidence where direct confirmation was not available in source artifacts. Statements marked with ** could not be confirmed; treat as unknown until verified.
Sources¶
- SAIF.Framework.Security.EnvironmentApi\Exceptions\MissingEnvironmentUrlVariableException.cs
- SAIF.Framework.Security.EnvironmentApi\Services.Common\EnvironmentServiceBase.cs