Stores username & date of to AE create/update API calls

Signed-off-by: Victor Chang <[email protected]>

Author: mocsharp

src/Api/BaseApplicationEntity.cs

@@ -15,6 +15,9 @@
  * limitations under the License.
  */
 
+using System;
+using System.Security.Claims;
+
 namespace Monai.Deploy.InformaticsGateway.Api
 {
     /// <summary>
@@ -29,17 +32,32 @@ public class BaseApplicationEntity : MongoDBEntityBase
         /// Gets or sets the unique name used to identify a DICOM application entity.
         /// This value must be unique.
         /// </summary>
-        public string Name { get; set; }
+        public string Name { get; set; } = default!;
 
         /// <summary>
         ///  Gets or sets the AE Title (AET) used to identify itself in a DICOM association.
         /// </summary>
-        public string AeTitle { get; set; }
+        public string AeTitle { get; set; } = default!;
 
         /// <summary>
         /// Gets or set the host name or IP address of the AE Title.
         /// </summary>
-        public string HostIp { get; set; }
+        public string HostIp { get; set; } = default!;
+
+        /// <summary>
+        /// Gets or set the user who created the DICOM entity.
+        /// </summary>
+        public string? CreatedBy { get; set; }
+
+        /// <summary>
+        /// Gets or set the most recent user who updated the DICOM entity.
+        /// </summary>
+        public string? UpdatedBy { get; set; }
+
+        /// <summary>
+        /// Gets or set the most recent date time the DICOM entity was updated.
+        /// </summary>
+        public DateTime? DateTimeUpdated { get; set; }
 
         public BaseApplicationEntity()
         {
@@ -52,6 +70,23 @@ public void SetDefaultValues()
                 Name = AeTitle;
         }
 
+        public void SetAuthor(ClaimsPrincipal user, EditMode editMode)
+        {
+            if (editMode == EditMode.Update)
+            {
+                DateTimeUpdated = DateTime.UtcNow;
+            }
+
+            if (editMode == EditMode.Create)
+            {
+                CreatedBy = user.Identity?.Name;
+            }
+            else if (editMode == EditMode.Update)
+            {
+                UpdatedBy = user.Identity?.Name;
+            }
+        }
+
         public override string ToString()
         {
             return $"Name: {Name}/AET: {AeTitle}/Host: {HostIp}";

src/Api/DicomAssociationInfo.cs

@@ -20,15 +20,15 @@ namespace Monai.Deploy.InformaticsGateway.Api
 {
     public class DicomAssociationInfo : MongoDBEntityBase
     {
-        public DateTime DateTimeDisconnected { get; set; }
-        public string CorrelationId { get; set; }
+        public DateTime DateTimeDisconnected { get; set; } = default!;
+        public string CorrelationId { get; set; } = default!;
         public int FileCount { get; private set; }
-        public string CallingAeTitle { get; set; }
-        public string CalledAeTitle { get; set; }
-        public string RemoteHost { get; set; }
-        public int RemotePort { get; set; }
-        public string Errors { get; set; }
-        public TimeSpan Duration { get; private set; }
+        public string CallingAeTitle { get; set; } = default!;
+        public string CalledAeTitle { get; set; } = default!;
+        public string RemoteHost { get; set; } = default!;
+        public int RemotePort { get; set; } = default!;
+        public string Errors { get; set; } = string.Empty;
+        public TimeSpan Duration { get; private set; } = default!;
 
         public DicomAssociationInfo()
         {

src/Api/EditMode.cs

@@ -0,0 +1,25 @@
+/*
+ * Copyright 2021-2022 MONAI Consortium
+ * Copyright 2019-2020 NVIDIA Corporation
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+namespace Monai.Deploy.InformaticsGateway.Api
+{
+    public enum EditMode
+    {
+        Create,
+        Update,
+    }
+}

src/Api/LoggingDataDictionary.cs

@@ -24,7 +24,7 @@
 namespace Monai.Deploy.InformaticsGateway.Api
 {
     [Serializable]
-    public class LoggingDataDictionary<K, V> : Dictionary<K, V>
+    public class LoggingDataDictionary<TKey, TValue> : Dictionary<TKey, TValue> where TKey : notnull
     {
         public LoggingDataDictionary()
         {

src/Api/Monai.Deploy.InformaticsGateway.Api.csproj

@@ -23,6 +23,7 @@
     <IsTrimmable>true</IsTrimmable>
     <CodeAnalysisRuleSet>..\.sonarlint\project-monai_monai-deploy-informatics-gatewaycsharp.ruleset</CodeAnalysisRuleSet>
     <RestorePackagesWithLockFile>true</RestorePackagesWithLockFile>
+    <Nullable>enable</Nullable>
   </PropertyGroup>
 
   <ItemGroup>

src/Api/MonaiApplicationEntity.cs

@@ -19,6 +19,7 @@
 using System.Collections.Generic;
 using System.ComponentModel.DataAnnotations;
 using System.ComponentModel.DataAnnotations.Schema;
+using System.Security.Claims;
 
 namespace Monai.Deploy.InformaticsGateway.Api
 {
@@ -52,36 +53,36 @@ public class MonaiApplicationEntity : MongoDBEntityBase
         /// This value must be unique.
         /// </summary>
         [Key, Column(Order = 0)]
-        public string Name { get; set; }
+        public string Name { get; set; } = default!;
 
         /// <summary>
         /// Gets or sets the AE TItle.
         /// </summary>
-        public string AeTitle { get; set; }
+        public string AeTitle { get; set; } = default!;
 
         /// <summary>
         /// Gets or sets the DICOM tag used to group the instances.
         /// Defaults to 0020,000D (Study Instance UID).
         /// Valid DICOM Tags: > Study Instance UID (0020,000D) and Series Instance UID (0020,000E).
         /// </summary>
-        public string Grouping { get; set; }
+        public string Grouping { get; set; } = default!;
 
         /// <summary>
         /// Optional field to map AE to one or more workflows.
         /// </summary>
-        public List<string> Workflows { get; set; }
+        public List<string> Workflows { get; set; } = default!;
 
         /// <summary>
         /// Optional field to specify SOP Class UIDs to ignore.
         /// <see cref="IgnoredSopClasses"/> and <see cref="AllowedSopClasses"/> are mutually exclusive.
         /// </summary>
-        public List<string> IgnoredSopClasses { get; set; }
+        public List<string> IgnoredSopClasses { get; set; } = default!;
 
         /// <summary>
         /// Optional field to specify accepted SOP Class UIDs.
         /// <see cref="IgnoredSopClasses"/> and <see cref="AllowedSopClasses"/> are mutually exclusive.
         /// </summary>
-        public List<string> AllowedSopClasses { get; set; }
+        public List<string> AllowedSopClasses { get; set; } = default!;
 
         /// <summary>
         /// Timeout, in seconds, to wait for instances before notifying other subsystems of data arrival
@@ -90,6 +91,11 @@ public class MonaiApplicationEntity : MongoDBEntityBase
         /// </summary>
         public uint Timeout { get; set; } = 5;
 
+        /// <summary>
+        /// Gets or set the user who created the DICOM entity.
+        /// </summary>
+        public string? CreatedBy { get; set; }
+
         public MonaiApplicationEntity()
         {
             SetDefaultValues();
@@ -118,5 +124,10 @@ public override string ToString()
         {
             return $"Name: {Name}/AET: {AeTitle}";
         }
+
+        public void SetAuthor(ClaimsPrincipal user)
+        {
+            CreatedBy = user.Identity?.Name;
+        }
     }
 }

src/Api/Rest/DicomWebConnectionDetails.cs

@@ -29,20 +29,20 @@ public class DicomWebConnectionDetails
         /// Gets or sets a list of permitted operations for the connection.
         /// </summary>
         [JsonPropertyName("operations")]
-        public IList<InputInterfaceOperations> Operations { get; set; }
+        public IList<InputInterfaceOperations>? Operations { get; set; }
 
         /// <summary>
         /// Gets or sets the resource URI (Uniform Resource Identifier) of the connection.
         /// </summary>
         [JsonPropertyName("uri")]
-        public string Uri { get; set; }
+        public string? Uri { get; set; }
 
         /// <summary>
         /// Gets or sets the authentication/authorization token of the connection.
         /// For HTTP basic access authentication, the value must be encoded in based 64 using "{username}:{password}" format.
         /// </summary>
         [JsonPropertyName("authID")]
-        public string AuthId { get; set; }
+        public string? AuthId { get; set; }
 
         /// <summary>
         /// Gets or sets the type of the authentication token used for the connection.

src/Api/Rest/Enums.cs

@@ -15,6 +15,7 @@
  * limitations under the License.
  */
 
+using System;
 using System.Runtime.Serialization;
 using System.Text.Json.Serialization;
 

src/Api/Rest/FhirResources.cs

@@ -81,21 +81,21 @@ public class FhirResource
         /// E.g. Pateitn, Observation.
         /// </summary>
         [JsonPropertyName("resourceType")]
-        public string Type { get; set; }
+        public string Type { get; set; } = default!;
 
         /// <summary>
         /// Gets or sets the ID of the resource to be retrieved.
         /// </summary>
         /// <value></value>
         [JsonPropertyName("id")]
-        public string Id { get; set; }
+        public string Id { get; set; } = default!;
 
         /// <summary>
         /// Internal use only!
         /// Gets or sets whether or not resource has been retrieved or not.
         /// </summary>
         /// <value></value>
         [JsonPropertyName("isRetrieved")]
-        public bool IsRetrieved { get; set; }
+        public bool IsRetrieved { get; set; } = default!;
     }
 }

src/Api/Rest/InferenceRequest.cs

@@ -19,7 +19,6 @@
 using System.Collections.Generic;
 using System.Linq;
 using System.Text.Json.Serialization;
-using System.Xml.Linq;
 using Ardalis.GuardClauses;
 using Monai.Deploy.InformaticsGateway.Common;
 
@@ -83,7 +82,7 @@ public class InferenceRequest
         /// Gets or set the transaction ID of a request.
         /// </summary>
         [JsonPropertyName("transactionID")]
-        public string TransactionId { get; set; }
+        public string TransactionId { get; set; } = default!;
 
         /// <summary>
         /// Gets or sets the priority of a request.
@@ -101,15 +100,15 @@ public class InferenceRequest
         /// Gets or sets the details of the data associated with the inference request.
         /// </summary>
         [JsonPropertyName("inputMetadata")]
-        public InferenceRequestMetadata InputMetadata { get; set; }
+        public InferenceRequestMetadata? InputMetadata { get; set; }
 
         /// <summary>
         /// Gets or set a list of data sources to query/retrieve data from.
         /// When multiple data sources are specified, the system will query based on
         /// the order the list was received.
         /// </summary>
         [JsonPropertyName("inputResources")]
-        public IList<RequestInputDataResource> InputResources { get; set; }
+        public IList<RequestInputDataResource>? InputResources { get; set; }
 
         /// <summary>
         /// Gets or set a list of data sources to export results to.
@@ -118,7 +117,17 @@ public class InferenceRequest
         /// Followed by registering the results using the MONAI App SDK.
         /// </summary>
         [JsonPropertyName("outputResources")]
-        public IList<RequestOutputDataResource> OutputResources { get; set; }
+        public IList<RequestOutputDataResource>? OutputResources { get; set; }
+
+        /// <summary>
+        /// Gets or set the user who created the DICOM entity.
+        /// </summary>
+        public string? CreatedBy { get; set; }
+
+        /// <summary>
+        /// Gets or set the date and time the objects first created.
+        /// </summary>
+        public DateTime? DateTimeCreated { get; set; }
 
         #region Internal Use Only
 
@@ -155,7 +164,7 @@ public class InferenceRequest
         public int TryCount { get; set; } = 0;
 
         [JsonIgnore]
-        public InputConnectionDetails Application
+        public InputConnectionDetails? Application
         {
             get
             {
@@ -169,6 +178,7 @@ public InferenceRequest()
         {
             InputResources = new List<RequestInputDataResource>();
             OutputResources = new List<RequestOutputDataResource>();
+            DateTimeCreated = DateTime.UtcNow;
         }
 
         public bool IsValid(out string details)
@@ -192,7 +202,7 @@ private void Preprocess()
             if (InputMetadata.Details is not null)
             {
                 InputMetadata.Inputs.Add(InputMetadata.Details);
-                InputMetadata.Details = null;
+                InputMetadata.Details = default!;
             }
         }
 

src/Api/Rest/InferenceRequestDetails.cs

@@ -71,12 +71,12 @@ namespace Monai.Deploy.InformaticsGateway.Api.Rest
     /// </remarks>
     public class InferenceRequestDetails
     {
-        private string _fhirAcceptHeader;
+        private string _fhirAcceptHeader = default!;
 
         /// <summary>
         /// Gets or sets the type of the inference request.
         /// </summary>
-        [JsonConverter(typeof(JsonStringEnumConverter))]
+        [JsonConverter(typeof(JsonStringEnumMemberConverter))]
         [JsonPropertyName("type")]
         public InferenceRequestType Type { get; set; }
 
@@ -85,27 +85,27 @@ public class InferenceRequestDetails
         /// Used when <c>Type</c> is <see cref="T:Monai.Deploy.InformaticsGateway.Api.Rest.InferenceRequestType.DicomUid" />.
         /// </summary>
         [JsonPropertyName("studies")]
-        public IList<RequestedStudy> Studies { get; set; }
+        public IList<RequestedStudy>? Studies { get; set; }
 
         /// <summary>
         /// Gets or sets Patient ID that is used to query the data source.
         /// Used when <c>Type</c> is <see cref="T:Monai.Deploy.InformaticsGateway.Api.Rest.InferenceRequestType.DicomPatientId" />.
         /// </summary>
         [JsonPropertyName("PatientID")]
-        public string PatientId { get; set; }
+        public string? PatientId { get; set; }
 
         /// <summary>
         /// Gets or sets Access Number that is used to query the data source.
         /// Used when <c>Type</c> is <see cref="T:Monai.Deploy.InformaticsGateway.Api.Rest.InferenceRequestType.AccessionNumber" />.
         /// </summary>
         [JsonPropertyName("accessionNumber")]
-        public IList<string> AccessionNumber { get; set; }
+        public IList<string>? AccessionNumber { get; set; }
 
         /// <summary>
         /// Gets or sets a list of FHIR resources to be retrived.
         /// </summary>
         [JsonPropertyName("resources")]
-        public IList<FhirResource> Resources { get; set; }
+        public IList<FhirResource>? Resources { get; set; }
 
         /// <summary>
         /// Gets or set the data format used when storing FHIR resources.