| | | 1 | | namespace AsiBackbone.Core.CapabilityGrants; |
| | | 2 | | |
| | | 3 | | /// <summary> |
| | | 4 | | /// Represents the outcome returned by a capability grant use-control store. |
| | | 5 | | /// </summary> |
| | | 6 | | public sealed class CapabilityGrantUseResult |
| | | 7 | | { |
| | 78 | 8 | | private CapabilityGrantUseResult(GrantUseState state, int useCount, string? failureCode, string? failureMessage) |
| | | 9 | | { |
| | 78 | 10 | | if (!Enum.IsDefined(state)) |
| | | 11 | | { |
| | 0 | 12 | | throw new ArgumentOutOfRangeException(nameof(state), state, "Use state must be defined."); |
| | | 13 | | } |
| | | 14 | | |
| | 78 | 15 | | State = state; |
| | 78 | 16 | | UseCount = useCount < 0 |
| | 78 | 17 | | ? throw new ArgumentOutOfRangeException(nameof(useCount), useCount, "Use count must be greater than or equal |
| | 78 | 18 | | : useCount; |
| | 76 | 19 | | FailureCode = NormalizeOptional(failureCode); |
| | 76 | 20 | | FailureMessage = NormalizeOptional(failureMessage); |
| | 76 | 21 | | } |
| | | 22 | | |
| | | 23 | | /// <summary> |
| | | 24 | | /// Gets the use-control state. |
| | | 25 | | /// </summary> |
| | | 26 | | public GrantUseState State { get; } |
| | | 27 | | |
| | | 28 | | /// <summary> |
| | | 29 | | /// Gets the observed use count after the store checked or consumed the grant. |
| | | 30 | | /// </summary> |
| | | 31 | | public int UseCount { get; } |
| | | 32 | | |
| | | 33 | | /// <summary> |
| | | 34 | | /// Gets the provider-neutral failure code when the use-control check did not accept the grant. |
| | | 35 | | /// </summary> |
| | | 36 | | public string? FailureCode { get; } |
| | | 37 | | |
| | | 38 | | /// <summary> |
| | | 39 | | /// Gets the provider-neutral failure message when the use-control check did not accept the grant. |
| | | 40 | | /// </summary> |
| | | 41 | | public string? FailureMessage { get; } |
| | | 42 | | |
| | | 43 | | /// <summary> |
| | | 44 | | /// Gets a value indicating whether the grant was accepted for use. |
| | | 45 | | /// </summary> |
| | 5 | 46 | | public bool IsAccepted => State is GrantUseState.Accepted; |
| | | 47 | | |
| | | 48 | | /// <summary> |
| | | 49 | | /// Creates an accepted use result. |
| | | 50 | | /// </summary> |
| | | 51 | | public static CapabilityGrantUseResult Accepted(int useCount) |
| | | 52 | | { |
| | 25 | 53 | | return new CapabilityGrantUseResult(GrantUseState.Accepted, useCount, null, null); |
| | | 54 | | } |
| | | 55 | | |
| | | 56 | | /// <summary> |
| | | 57 | | /// Creates a result indicating the configured use limit was exceeded. |
| | | 58 | | /// </summary> |
| | | 59 | | public static CapabilityGrantUseResult UseLimitExceeded(int useCount, string? failureMessage = null) |
| | | 60 | | { |
| | 37 | 61 | | return new CapabilityGrantUseResult(GrantUseState.UseLimitExceeded, useCount, "capability.use-limit-exceeded", f |
| | | 62 | | } |
| | | 63 | | |
| | | 64 | | /// <summary> |
| | | 65 | | /// Creates a result indicating the store can no longer prove the grant is within its use limit, because the grant i |
| | | 66 | | /// past the store's use-record retention horizon and its record may already have been evicted. |
| | | 67 | | /// </summary> |
| | | 68 | | /// <remarks> |
| | | 69 | | /// The state is <see cref="GrantUseState.UseLimitExceeded" />, so validation denies. Accepting the use instead woul |
| | | 70 | | /// start a fresh count for a grant whose earlier uses the store has discarded, which is a replay. |
| | | 71 | | /// </remarks> |
| | | 72 | | public static CapabilityGrantUseResult RetentionElapsed(string? failureMessage = null) |
| | | 73 | | { |
| | 3 | 74 | | return new CapabilityGrantUseResult(GrantUseState.UseLimitExceeded, 0, "capability.use-retention-elapsed", failu |
| | | 75 | | } |
| | | 76 | | |
| | | 77 | | /// <summary> |
| | | 78 | | /// Creates a result indicating the grant was administratively stopped. |
| | | 79 | | /// </summary> |
| | | 80 | | public static CapabilityGrantUseResult Stopped(string? failureMessage = null) |
| | | 81 | | { |
| | 6 | 82 | | return new CapabilityGrantUseResult(GrantUseState.Stopped, 0, "capability.grant-stopped", failureMessage); |
| | | 83 | | } |
| | | 84 | | |
| | | 85 | | /// <summary> |
| | | 86 | | /// Creates a result indicating the grant was cancelled. |
| | | 87 | | /// </summary> |
| | | 88 | | public static CapabilityGrantUseResult Cancelled(string? failureMessage = null) |
| | | 89 | | { |
| | 5 | 90 | | return new CapabilityGrantUseResult(GrantUseState.Cancelled, 0, "capability.grant-cancelled", failureMessage); |
| | | 91 | | } |
| | | 92 | | |
| | | 93 | | /// <summary> |
| | | 94 | | /// Creates a result indicating the use-control store was unavailable. |
| | | 95 | | /// </summary> |
| | | 96 | | public static CapabilityGrantUseResult Unavailable(string? failureMessage = null) |
| | | 97 | | { |
| | 2 | 98 | | return new CapabilityGrantUseResult(GrantUseState.Unavailable, 0, "capability.use-store-unavailable", failureMes |
| | | 99 | | } |
| | | 100 | | |
| | | 101 | | private static string? NormalizeOptional(string? value) |
| | | 102 | | { |
| | 152 | 103 | | return string.IsNullOrWhiteSpace(value) |
| | 152 | 104 | | ? null |
| | 152 | 105 | | : value.Trim(); |
| | | 106 | | } |
| | | 107 | | } |