59 lines
2.5 KiB
Markdown
59 lines
2.5 KiB
Markdown
---
|
|
source_files:
|
|
- Common/DTS.Common.Licensing/Messages/ValidationFailure.cs
|
|
- Common/DTS.Common.Licensing/Messages/LicenseKey.cs
|
|
- Common/DTS.Common.Licensing/Messages/ValidationResult.cs
|
|
generated_at: "2026-04-17T16:36:18.677011+00:00"
|
|
model: "zai-org/GLM-5-FP8"
|
|
schema_version: 1
|
|
sha256: "ea10aa4d05a8b091"
|
|
---
|
|
|
|
# Documentation: DTS.Common.Licensing Messages
|
|
|
|
## 1. Purpose
|
|
|
|
This module defines data transfer objects (DTOs) used to communicate licensing validation results within the DTS licensing system. It provides three classes—`ValidationFailure`, `LicenseKey`, and `ValidationResult`—that encapsulate validation error details, license key identifiers, and comprehensive validation outcomes respectively. These message types serve as the contract between license validation logic and consumers that need to display or act upon licensing state.
|
|
|
|
---
|
|
|
|
## 2. Public Interface
|
|
|
|
### `ValidationFailure` (namespace: `DTS.Common.Licensing.Messages`)
|
|
|
|
A simple POCO representing a single validation failure.
|
|
|
|
| Property | Type | Description |
|
|
|----------|------|-------------|
|
|
| `Message` | `string` | Describes the validation failure. |
|
|
| `HowToResolve` | `string` | Provides guidance on resolving the failure. |
|
|
|
|
---
|
|
|
|
### `LicenseKey` (namespace: `DTS.Common.Licensing`)
|
|
|
|
A POCO containing license key identifiers.
|
|
|
|
| Property | Type | Description |
|
|
|----------|------|-------------|
|
|
| `KeyGuid` | `string` | A GUID identifier for the license key. |
|
|
| `PublicKey` | `string` | The public key associated with the license. |
|
|
|
|
---
|
|
|
|
### `ValidationResult` (namespace: `DTS.Common.Licensing.Messages`)
|
|
|
|
A comprehensive result object aggregating all aspects of license validation.
|
|
|
|
| Property | Type | Description |
|
|
|----------|------|-------------|
|
|
| `ValidationFailures` | `IEnumerable<ValidationFailure>` | Collection of validation failures encountered. |
|
|
| `IsLicenseExpired` | `bool` | Indicates whether the license has expired. |
|
|
| `IsLicenseVersionValid` | `bool` | Indicates whether the license version is valid for the product. |
|
|
| `ProductVersion` | `Version` | The version of the product being validated. |
|
|
| `LicenseVersion` | `string` | The version string from the license. |
|
|
| `LicenseExpiration` | `DateTime?` | The expiration date of the license, or `null` if not applicable. |
|
|
| `IsValid` | `bool` | Overall validity status of the license. |
|
|
| `IsLicensed` | `bool` | Indicates whether a license file exists. Defaults to `true`. |
|
|
| `LicensedTo` | `string` | The name of the licensee. |
|
|
| `LicenseType` | `DataProLicensingEnums.LicenseType` | The type of license (enum value). |