Big changes

Source/TSRealLib/Common/Raytheon.Common/Configuration/ConfigurationContracts/ConfigurationException.cs

@@ -0,0 +1,65 @@
+// ******************************************************************************//
+//  RAYTHEON PROPRIETARY: THIS DOCUMENT CONTAINS DATA OR INFORMATION
+//  PROPRIETARY TO RAYTHEON COMPANY AND IS RESTRICTED TO USE ONLY BY PERSONS
+//  AUTHORIZED BY RAYTHEON COMPANY IN WRITING TO USE IT. DISCLOSURE TO
+//  UNAUTHORIZED PERSONS WOULD LIKELY CAUSE SUBSTANTIAL COMPETITIVE HARM TO
+//  RAYTHEON COMPANY''S BUSINESS POSITION. NEITHER SAID DOCUMENT NOR ITS
+//  CONTENTS SHALL BE FURNISHED OR DISCLOSED TO OR COPIED OR USED BY PERSONS
+//  OUTSIDE RAYTHEON COMPANY WITHOUT THE EXPRESS WRITTEN APPROVAL OF RAYTHEON
+//  COMPANY.
+//
+//  THIS PROPRIETARY NOTICE IS NOT APPLICABLE IF DELIVERED TO THE U.S. GOVERNMENT
+//
+//  UNPUBLISHED WORK - COPYRIGHT RAYTHEON COMPANY.
+//
+//  WARNING: THIS DOCUMENT CONTAINS TECHNICAL DATA AND / OR TECHNOLOGY WHOSE
+//  EXPORT OR DISCLOSURE TO NON-U.S. PERSONS, WHEREVER LOCATED, IS RESTRICTED
+//  BY THE INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) (22 C.F.R. SECTION
+//  120-130) OR THE EXPORT ADMINISTRATION REGULATIONS (EAR) (15 C.F.R. SECTION
+//  730-774). THIS DOCUMENT CANNOT BE EXPORTED (E.G., PROVIDED TO A SUPPLIER
+//  OUTSIDE OF THE UNITED STATES) OR DISCLOSED TO A NON-U.S. PERSON, WHEREVER
+//  LOCATED, UNTIL A FINAL JURISDICTION AND CLASSIFICATION DETERMINATION HAS
+//  BEEN COMPLETED AND APPROVED BY RAYTHEON, AND ANY REQUIRED U.S. GOVERNMENT
+//  APPROVALS HAVE BEEN OBTAINED. VIOLATIONS ARE SUBJECT TO SEVERE CRIMINAL
+//  PENALTIES.
+//
+//  DOD 5220.22-M, INDUSTRIAL SECURITY MANUAL, CHAPTER 5, SECTION 1 THROUGH 9 :
+//  FOR CLASSIFIED DOCUMENTS FOLLOW THE PROCEDURES IN OR DOD 5200.1-R,
+//  INFORMATION SECURITY PROGRAM, CHAPTER 6. FOR UNCLASSIFIED, LIMITED DOCUMENTS
+//  DESTROY BY ANY  METHOD THAT WILL PREVENT DISCLOSURE OF CONTENTS OR
+//  RECONSTRUCTION OF THE DOCUMENT.
+// ****************************************************************************//
+
+using System;
+using System.Runtime.Serialization;
+
+namespace Raytheon.Common
+{
+    [DataContract]
+    public class ConfigurationException : Exception
+    {
+        public ConfigurationException()
+            :base()
+        {
+            
+        }
+
+        public ConfigurationException(string message)
+            :base(message)
+        {
+
+        }
+
+        public ConfigurationException(string message, Exception innerException)
+            :base(message, innerException)
+        {
+
+        }
+
+        public ConfigurationException(SerializationInfo info, StreamingContext context)
+            :base(info, context)
+        {
+
+        }
+    }
+}

Source/TSRealLib/Common/Raytheon.Common/Configuration/ConfigurationContracts/IConfigurable.cs

@@ -0,0 +1,43 @@
+// ******************************************************************************//
+//  RAYTHEON PROPRIETARY: THIS DOCUMENT CONTAINS DATA OR INFORMATION
+//  PROPRIETARY TO RAYTHEON COMPANY AND IS RESTRICTED TO USE ONLY BY PERSONS
+//  AUTHORIZED BY RAYTHEON COMPANY IN WRITING TO USE IT. DISCLOSURE TO
+//  UNAUTHORIZED PERSONS WOULD LIKELY CAUSE SUBSTANTIAL COMPETITIVE HARM TO
+//  RAYTHEON COMPANY''S BUSINESS POSITION. NEITHER SAID DOCUMENT NOR ITS
+//  CONTENTS SHALL BE FURNISHED OR DISCLOSED TO OR COPIED OR USED BY PERSONS
+//  OUTSIDE RAYTHEON COMPANY WITHOUT THE EXPRESS WRITTEN APPROVAL OF RAYTHEON
+//  COMPANY.
+//
+//  THIS PROPRIETARY NOTICE IS NOT APPLICABLE IF DELIVERED TO THE U.S. GOVERNMENT
+//
+//  UNPUBLISHED WORK - COPYRIGHT RAYTHEON COMPANY.
+//
+//  WARNING: THIS DOCUMENT CONTAINS TECHNICAL DATA AND / OR TECHNOLOGY WHOSE
+//  EXPORT OR DISCLOSURE TO NON-U.S. PERSONS, WHEREVER LOCATED, IS RESTRICTED
+//  BY THE INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) (22 C.F.R. SECTION
+//  120-130) OR THE EXPORT ADMINISTRATION REGULATIONS (EAR) (15 C.F.R. SECTION
+//  730-774). THIS DOCUMENT CANNOT BE EXPORTED (E.G., PROVIDED TO A SUPPLIER
+//  OUTSIDE OF THE UNITED STATES) OR DISCLOSED TO A NON-U.S. PERSON, WHEREVER
+//  LOCATED, UNTIL A FINAL JURISDICTION AND CLASSIFICATION DETERMINATION HAS
+//  BEEN COMPLETED AND APPROVED BY RAYTHEON, AND ANY REQUIRED U.S. GOVERNMENT
+//  APPROVALS HAVE BEEN OBTAINED. VIOLATIONS ARE SUBJECT TO SEVERE CRIMINAL
+//  PENALTIES.
+//
+//  DOD 5220.22-M, INDUSTRIAL SECURITY MANUAL, CHAPTER 5, SECTION 1 THROUGH 9 :
+//  FOR CLASSIFIED DOCUMENTS FOLLOW THE PROCEDURES IN OR DOD 5200.1-R,
+//  INFORMATION SECURITY PROGRAM, CHAPTER 6. FOR UNCLASSIFIED, LIMITED DOCUMENTS
+//  DESTROY BY ANY  METHOD THAT WILL PREVENT DISCLOSURE OF CONTENTS OR
+//  RECONSTRUCTION OF THE DOCUMENT.
+// ****************************************************************************//
+
+namespace Raytheon.Common
+{
+    /// <summary>
+    /// interface for flaging the moment when configurable object is done with configuration 
+    /// restored from the previous version of Raytheon.Configuration package
+    /// </summary>
+    public interface IConfigurable
+    {
+        void OnConfigured();
+    }
+}

Source/TSRealLib/Common/Raytheon.Common/Configuration/ConfigurationContracts/IConfiguration.cs

@@ -0,0 +1,92 @@
+// ******************************************************************************//
+//  RAYTHEON PROPRIETARY: THIS DOCUMENT CONTAINS DATA OR INFORMATION
+//  PROPRIETARY TO RAYTHEON COMPANY AND IS RESTRICTED TO USE ONLY BY PERSONS
+//  AUTHORIZED BY RAYTHEON COMPANY IN WRITING TO USE IT. DISCLOSURE TO
+//  UNAUTHORIZED PERSONS WOULD LIKELY CAUSE SUBSTANTIAL COMPETITIVE HARM TO
+//  RAYTHEON COMPANY''S BUSINESS POSITION. NEITHER SAID DOCUMENT NOR ITS
+//  CONTENTS SHALL BE FURNISHED OR DISCLOSED TO OR COPIED OR USED BY PERSONS
+//  OUTSIDE RAYTHEON COMPANY WITHOUT THE EXPRESS WRITTEN APPROVAL OF RAYTHEON
+//  COMPANY.
+//
+//  THIS PROPRIETARY NOTICE IS NOT APPLICABLE IF DELIVERED TO THE U.S. GOVERNMENT
+//
+//  UNPUBLISHED WORK - COPYRIGHT RAYTHEON COMPANY.
+//
+//  WARNING: THIS DOCUMENT CONTAINS TECHNICAL DATA AND / OR TECHNOLOGY WHOSE
+//  EXPORT OR DISCLOSURE TO NON-U.S. PERSONS, WHEREVER LOCATED, IS RESTRICTED
+//  BY THE INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) (22 C.F.R. SECTION
+//  120-130) OR THE EXPORT ADMINISTRATION REGULATIONS (EAR) (15 C.F.R. SECTION
+//  730-774). THIS DOCUMENT CANNOT BE EXPORTED (E.G., PROVIDED TO A SUPPLIER
+//  OUTSIDE OF THE UNITED STATES) OR DISCLOSED TO A NON-U.S. PERSON, WHEREVER
+//  LOCATED, UNTIL A FINAL JURISDICTION AND CLASSIFICATION DETERMINATION HAS
+//  BEEN COMPLETED AND APPROVED BY RAYTHEON, AND ANY REQUIRED U.S. GOVERNMENT
+//  APPROVALS HAVE BEEN OBTAINED. VIOLATIONS ARE SUBJECT TO SEVERE CRIMINAL
+//  PENALTIES.
+//
+//  DOD 5220.22-M, INDUSTRIAL SECURITY MANUAL, CHAPTER 5, SECTION 1 THROUGH 9 :
+//  FOR CLASSIFIED DOCUMENTS FOLLOW THE PROCEDURES IN OR DOD 5200.1-R,
+//  INFORMATION SECURITY PROGRAM, CHAPTER 6. FOR UNCLASSIFIED, LIMITED DOCUMENTS
+//  DESTROY BY ANY  METHOD THAT WILL PREVENT DISCLOSURE OF CONTENTS OR
+//  RECONSTRUCTION OF THE DOCUMENT.
+// ****************************************************************************//
+
+namespace Raytheon.Common
+{
+   /// <summary>
+   /// Configuration interface
+   /// restored from the previous version of Raytheon.Configuration package
+   /// </summary>
+   public interface IConfiguration
+   {
+      /// <summary>
+      /// Sets the configuration value.
+      /// </summary>
+      /// <param name="section">The section.</param>
+      /// <param name="key">The key.</param>
+      /// <param name="value">The value.</param>
+      void SetConfigurationValue(string section, string key, string value);
+
+      /// <summary>
+      /// Gets the configuration value.
+      /// </summary>
+      /// <param name="section">The section.</param>
+      /// <param name="key">The key.</param>
+      /// <param name="defaultValue">The default value.</param>
+      /// <returns></returns>
+      string GetConfigurationValue(string section, string key, string defaultValue);
+
+      /// <summary>
+      /// Gets the configuration value.
+      /// </summary>
+      /// <param name="section">The section.</param>
+      /// <param name="key">The key.</param>
+      /// <returns></returns>
+      string GetConfigurationValue(string section, string key);
+
+      /// <summary>
+      /// Sets the XML configuration.
+      /// </summary>
+      /// <param name="name">The name.</param>
+      /// <param name="xml">The XML.</param>
+      void SetXmlConfiguration(string name, string xml);
+
+      /// <summary>
+      /// Gets the XML configuration.
+      /// </summary>
+      /// <param name="name">The name.</param>
+      /// <returns></returns>
+      string GetXmlConfiguration(string name);
+
+      /// <summary>
+      /// Attempts to get the enumerated configuration value.  
+      /// If it does not exist or cannot be parsed to a valid value, 
+      /// it will create a new section called Valid_{key} and list the valid enumeration values.
+      /// </summary>
+      /// <param name="section">The section.</param>
+      /// <param name="key">The key.</param>
+      /// <param name="defaultValue">The default value.</param>
+      /// <returns></returns>
+      bool TryGetEnumValue<T>(string section, string key, out T value) where T : struct;
+
+   }
+}

Source/TSRealLib/Common/Raytheon.Common/Configuration/ConfigurationContracts/IConfigurationFile.cs

@@ -0,0 +1,137 @@
+// ******************************************************************************//
+//  RAYTHEON PROPRIETARY: THIS DOCUMENT CONTAINS DATA OR INFORMATION
+//  PROPRIETARY TO RAYTHEON COMPANY AND IS RESTRICTED TO USE ONLY BY PERSONS
+//  AUTHORIZED BY RAYTHEON COMPANY IN WRITING TO USE IT. DISCLOSURE TO
+//  UNAUTHORIZED PERSONS WOULD LIKELY CAUSE SUBSTANTIAL COMPETITIVE HARM TO
+//  RAYTHEON COMPANY''S BUSINESS POSITION. NEITHER SAID DOCUMENT NOR ITS
+//  CONTENTS SHALL BE FURNISHED OR DISCLOSED TO OR COPIED OR USED BY PERSONS
+//  OUTSIDE RAYTHEON COMPANY WITHOUT THE EXPRESS WRITTEN APPROVAL OF RAYTHEON
+//  COMPANY.
+//
+//  THIS PROPRIETARY NOTICE IS NOT APPLICABLE IF DELIVERED TO THE U.S. GOVERNMENT
+//
+//  UNPUBLISHED WORK - COPYRIGHT RAYTHEON COMPANY.
+//
+//  WARNING: THIS DOCUMENT CONTAINS TECHNICAL DATA AND / OR TECHNOLOGY WHOSE
+//  EXPORT OR DISCLOSURE TO NON-U.S. PERSONS, WHEREVER LOCATED, IS RESTRICTED
+//  BY THE INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) (22 C.F.R. SECTION
+//  120-130) OR THE EXPORT ADMINISTRATION REGULATIONS (EAR) (15 C.F.R. SECTION
+//  730-774). THIS DOCUMENT CANNOT BE EXPORTED (E.G., PROVIDED TO A SUPPLIER
+//  OUTSIDE OF THE UNITED STATES) OR DISCLOSED TO A NON-U.S. PERSON, WHEREVER
+//  LOCATED, UNTIL A FINAL JURISDICTION AND CLASSIFICATION DETERMINATION HAS
+//  BEEN COMPLETED AND APPROVED BY RAYTHEON, AND ANY REQUIRED U.S. GOVERNMENT
+//  APPROVALS HAVE BEEN OBTAINED. VIOLATIONS ARE SUBJECT TO SEVERE CRIMINAL
+//  PENALTIES.
+//
+//  DOD 5220.22-M, INDUSTRIAL SECURITY MANUAL, CHAPTER 5, SECTION 1 THROUGH 9 :
+//  FOR CLASSIFIED DOCUMENTS FOLLOW THE PROCEDURES IN OR DOD 5200.1-R,
+//  INFORMATION SECURITY PROGRAM, CHAPTER 6. FOR UNCLASSIFIED, LIMITED DOCUMENTS
+//  DESTROY BY ANY  METHOD THAT WILL PREVENT DISCLOSURE OF CONTENTS OR
+//  RECONSTRUCTION OF THE DOCUMENT.
+// ****************************************************************************//
+
+using System.Collections.Generic;
+
+namespace Raytheon.Common
+{
+   /// <summary>
+   /// supported file types
+   /// </summary>
+   public enum ConfigurationFileType
+   {
+      INI,
+      XML,
+      TOML,
+      JSON,
+      YAML,
+      OTHER
+   }
+
+   /// <summary>
+   /// updated version of IConfiguration interface
+   /// allows reading and writing generic types as well as lists
+   /// </summary>
+   public interface IConfigurationFile
+   {
+      /// <summary>
+      /// reads a single generic type value from the file section
+      /// if value or section does not exist, will create one and will add the default value
+      /// </summary>
+      /// <typeparam name="T"></typeparam>
+      /// <param name="section"></param>
+      /// <param name="key"></param>
+      /// <param name="defValue"></param>
+      /// <returns></returns>
+      T ReadValue<T>(string section, string key, T defValue = default);
+
+      /// <summary>
+      /// reads a single generic type value from the file section
+      /// if value doesn't exist, throw exception
+      /// </summary>
+      /// <param name="section"></param>
+      /// <param name="key"></param>
+      /// <returns></returns>
+      string ReadValue(string section, string key);
+
+      /// <summary>
+      /// reads a list of generic type values from the file section
+      /// if list or section does not exist, will create one and will populate with the default list
+      /// </summary>
+      /// <typeparam name="T"></typeparam>
+      /// <param name="section"></param>
+      /// <param name="key"></param>
+      /// <param name="defList"></param>
+      /// <returns></returns>
+      List<T> ReadList<T>(string section, string key, IList<T> defList = null);
+
+      /// <summary>
+      /// reads all available keys from the given section of configuration file
+      /// </summary>
+      /// <param name="section"></param>
+      /// <returns></returns>
+      List<string> ReadAllKeys(string section);
+
+      /// <summary>
+      /// reads all available sections from configuration file
+      /// </summary>
+      /// <returns></returns>
+      List<string> ReadAllSections();
+
+      /// <summary>
+      /// writes a single value of a generic type
+      /// </summary>
+      /// <typeparam name="T"></typeparam>
+      /// <param name="section"></param>
+      /// <param name="key"></param>
+      /// <param name="lineToWrite"></param>
+      void WriteValue<T>(string section, string key, T lineToWrite);
+
+      /// <summary>
+      /// writes a list of generic values
+      /// </summary>
+      /// <typeparam name="T"></typeparam>
+      /// <param name="section"></param>
+      /// <param name="key"></param>
+      /// <param name="listToWrite"></param>
+      void WriteList<T>(string section, string key, IList<T> listToWrite);
+
+      /// <summary>
+      /// checks if the value exists in the given section and given key
+      /// </summary>
+      /// <param name="section"></param>
+      /// <param name="key"></param>
+      /// <returns></returns>
+      bool ValueExists(string section, string key);
+
+      /// <summary>
+      /// configuration file name
+      /// </summary>
+      string FileName { get; }
+
+      /// <summary>
+      /// configuration file type
+      /// </summary>
+      ConfigurationFileType ConfigurationFileType { get; }
+   }
+
+}

Source/TSRealLib/Common/Raytheon.Common/Configuration/ConfigurationContracts/IConfigurationManager.cs

@@ -0,0 +1,52 @@
+// ******************************************************************************//
+//  RAYTHEON PROPRIETARY: THIS DOCUMENT CONTAINS DATA OR INFORMATION
+//  PROPRIETARY TO RAYTHEON COMPANY AND IS RESTRICTED TO USE ONLY BY PERSONS
+//  AUTHORIZED BY RAYTHEON COMPANY IN WRITING TO USE IT. DISCLOSURE TO
+//  UNAUTHORIZED PERSONS WOULD LIKELY CAUSE SUBSTANTIAL COMPETITIVE HARM TO
+//  RAYTHEON COMPANY''S BUSINESS POSITION. NEITHER SAID DOCUMENT NOR ITS
+//  CONTENTS SHALL BE FURNISHED OR DISCLOSED TO OR COPIED OR USED BY PERSONS
+//  OUTSIDE RAYTHEON COMPANY WITHOUT THE EXPRESS WRITTEN APPROVAL OF RAYTHEON
+//  COMPANY.
+//
+//  THIS PROPRIETARY NOTICE IS NOT APPLICABLE IF DELIVERED TO THE U.S. GOVERNMENT
+//
+//  UNPUBLISHED WORK - COPYRIGHT RAYTHEON COMPANY.
+//
+//  WARNING: THIS DOCUMENT CONTAINS TECHNICAL DATA AND / OR TECHNOLOGY WHOSE
+//  EXPORT OR DISCLOSURE TO NON-U.S. PERSONS, WHEREVER LOCATED, IS RESTRICTED
+//  BY THE INTERNATIONAL TRAFFIC IN ARMS REGULATIONS (ITAR) (22 C.F.R. SECTION
+//  120-130) OR THE EXPORT ADMINISTRATION REGULATIONS (EAR) (15 C.F.R. SECTION
+//  730-774). THIS DOCUMENT CANNOT BE EXPORTED (E.G., PROVIDED TO A SUPPLIER
+//  OUTSIDE OF THE UNITED STATES) OR DISCLOSED TO A NON-U.S. PERSON, WHEREVER
+//  LOCATED, UNTIL A FINAL JURISDICTION AND CLASSIFICATION DETERMINATION HAS
+//  BEEN COMPLETED AND APPROVED BY RAYTHEON, AND ANY REQUIRED U.S. GOVERNMENT
+//  APPROVALS HAVE BEEN OBTAINED. VIOLATIONS ARE SUBJECT TO SEVERE CRIMINAL
+//  PENALTIES.
+//
+//  DOD 5220.22-M, INDUSTRIAL SECURITY MANUAL, CHAPTER 5, SECTION 1 THROUGH 9 :
+//  FOR CLASSIFIED DOCUMENTS FOLLOW THE PROCEDURES IN OR DOD 5200.1-R,
+//  INFORMATION SECURITY PROGRAM, CHAPTER 6. FOR UNCLASSIFIED, LIMITED DOCUMENTS
+//  DESTROY BY ANY  METHOD THAT WILL PREVENT DISCLOSURE OF CONTENTS OR
+//  RECONSTRUCTION OF THE DOCUMENT.
+// ****************************************************************************//
+
+namespace Raytheon.Common
+{
+   /// <summary>
+   /// Configuration Manager interface
+   /// </summary>
+   public interface IConfigurationManager
+    {
+        /// <summary>
+        /// Gets the configuration by name.
+        /// </summary>
+        /// <param name="configurationName">Name of the configuration.</param>
+        /// <returns></returns>
+        IConfiguration GetConfiguration(string configurationName);
+        
+        /// <summary>
+        /// Gets or sets the configuration storage path or the location of the configuration files
+        /// </summary>
+        string ConfigurationStoragePath { get; set; }
+    }
+}