Implement dependency injection for application instance, server and node managers

Author: wbtoms

Applications/Quickstarts.Servers/ReferenceServer/IReferenceServer.cs

@@ -0,0 +1,44 @@
+/* ========================================================================
+ * Copyright (c) 2005-2020 The OPC Foundation, Inc. All rights reserved.
+ *
+ * OPC Foundation MIT License 1.00
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * The complete license agreement can be found here:
+ * http://opcfoundation.org/License/MIT/1.00/
+ * ======================================================================*/
+using System;
+using Opc.Ua;
+using Opc.Ua.Server;
+
+namespace Quickstarts.ReferenceServer
+{
+    public interface IReferenceServer : IReverseConnectServer
+    {
+        ITokenValidator TokenValidator { get; set; }
+
+        /// <summary>
+        /// Creates an instance of the service host.
+        /// </summary>
+        ServiceHost CreateServiceHost(ServerBase server, params Uri[] addresses);
+    }
+}

Applications/Quickstarts.Servers/ReferenceServer/ReferenceServer.cs

@@ -2,7 +2,7 @@
  * Copyright (c) 2005-2020 The OPC Foundation, Inc. All rights reserved.
  *
  * OPC Foundation MIT License 1.00
- * 
+ *
  * Permission is hereby granted, free of charge, to any person
  * obtaining a copy of this software and associated documentation
  * files (the "Software"), to deal in the Software without
@@ -11,7 +11,7 @@
  * copies of the Software, and to permit persons to whom the
  * Software is furnished to do so, subject to the following
  * conditions:
- * 
+ *
  * The above copyright notice and this permission notice shall be
  * included in all copies or substantial portions of the Software.
  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
@@ -32,7 +32,9 @@
 using System.Linq;
 using System.Security.Cryptography.X509Certificates;
 using Opc.Ua;
+using Opc.Ua.Configuration;
 using Opc.Ua.Server;
+using Opc.Ua.Server.NodeManager;
 
 namespace Quickstarts.ReferenceServer
 {
@@ -43,12 +45,23 @@ namespace Quickstarts.ReferenceServer
     /// Each server instance must have one instance of a StandardServer object which is
     /// responsible for reading the configuration file, creating the endpoints and dispatching
     /// incoming requests to the appropriate handler.
-    /// 
+    ///
     /// This sub-class specifies non-configurable metadata such as Product Name and initializes
     /// the EmptyNodeManager which provides access to the data exposed by the Server.
     /// </remarks>
-    public partial class ReferenceServer : ReverseConnectServer
+    public partial class ReferenceServer : ReverseConnectServer, IReferenceServer
     {
+        public ReferenceServer(
+            IApplicationInstance applicationInstance,
+            IServerInternal serverInternal,
+            IMainNodeManagerFactory mainNodeManagerFactory)
+            : base(applicationInstance, serverInternal, mainNodeManagerFactory)
+        {
+            m_applicationInstance = applicationInstance;
+            m_serverInternal = serverInternal;
+            m_mainNodeManagerFactory = mainNodeManagerFactory;
+        }
+
         #region Properties
         public ITokenValidator TokenValidator { get; set; }
 
@@ -63,7 +76,9 @@ public partial class ReferenceServer : ReverseConnectServer
         /// always creates a CoreNodeManager which handles the built-in nodes defined by the specification.
         /// Any additional NodeManagers are expected to handle application specific nodes.
         /// </remarks>
-        protected override MasterNodeManager CreateMasterNodeManager(IServerInternal server, ApplicationConfiguration configuration)
+        protected override IMasterNodeManager CreateMasterNodeManager(
+            IServerInternal server,
+            ApplicationConfiguration configuration)
         {
             Utils.LogInfo(Utils.TraceMasks.StartStop, "Creating the Reference Server Node Manager.");
 
@@ -78,7 +93,7 @@ protected override MasterNodeManager CreateMasterNodeManager(IServerInternal ser
             }
 
             // create master node manager.
-            return new MasterNodeManager(server, configuration, null, nodeManagers.ToArray());
+            return m_mainNodeManagerFactory.CreateMasterNodeManager(null, nodeManagers.ToArray());
         }
 
         protected override IMonitoredItemQueueFactory CreateMonitoredItemQueueFactory(IServerInternal server, ApplicationConfiguration configuration)
@@ -136,7 +151,7 @@ protected override ResourceManager CreateResourceManager(IServerInternal server,
         /// Initializes the server before it starts up.
         /// </summary>
         /// <remarks>
-        /// This method is called before any startup processing occurs. The sub-class may update the 
+        /// This method is called before any startup processing occurs. The sub-class may update the
         /// configuration object or do any other application specific startup tasks.
         /// </remarks>
         protected override void OnServerStarting(ApplicationConfiguration configuration)
@@ -162,11 +177,10 @@ protected override void OnServerStarted(IServerInternal server)
 
             try
             {
-                lock (ServerInternal.Status.Lock)
-                {
-                    // allow a faster sampling interval for CurrentTime node.
-                    ServerInternal.Status.Variable.CurrentTime.MinimumSamplingInterval = 250;
-                }
+                ServerInternal.UpdateServerStatus(
+                    (serverStatus) => {
+                        serverStatus.Variable.CurrentTime.MinimumSamplingInterval = 250;
+                    });
             }
             catch
             { }
@@ -416,7 +430,7 @@ private IUserIdentity VerifyIssuedToken(IssuedIdentityToken issuedToken)
                     info = new TranslationInfo("IssuedTokenInvalid", "en-US", "token is an invalid issued token.");
                     result = StatusCodes.BadIdentityTokenInvalid;
                 }
-                else // Rejected                
+                else // Rejected
                 {
                     // construct translation object with default text.
                     info = new TranslationInfo("IssuedTokenRejected", "en-US", "token is rejected.");
@@ -434,6 +448,10 @@ private IUserIdentity VerifyIssuedToken(IssuedIdentityToken issuedToken)
 
         #region Private Fields
         private ICertificateValidator m_userCertificateValidator;
+        private readonly IMainNodeManagerFactory m_mainNodeManagerFactory;
+        private readonly IServerInternal m_serverInternal;
+        private readonly IApplicationInstance m_applicationInstance;
+
         #endregion
     }
 }

Libraries/Opc.Ua.Configuration/ApplicationInstance.cs

@@ -44,7 +44,7 @@ namespace Opc.Ua.Configuration
     /// <summary>
     /// A class that install, configures and runs a UA application.
     /// </summary>
-    public class ApplicationInstance
+    public class ApplicationInstance : IApplicationInstance
     {
         #region Ctors
         /// <summary>
@@ -111,7 +111,7 @@ public Type ConfigurationType
         /// Gets the server.
         /// </summary>
         /// <value>The server.</value>
-        public ServerBase Server => m_server;
+        public IServerBase Server => m_server;
 
         /// <summary>
         /// Gets the application configuration used when the Start() method was called.
@@ -164,7 +164,7 @@ public bool ProcessCommandLine()
         /// Starts the UA server as a Windows Service.
         /// </summary>
         /// <param name="server">The server.</param>
-        public void StartAsService(ServerBase server)
+        public void StartAsService(IServerBase server)
         {
             throw new NotImplementedException(".NetStandard Opc.Ua libraries do not support to start as a windows service");
         }
@@ -173,7 +173,7 @@ public void StartAsService(ServerBase server)
         /// Starts the UA server.
         /// </summary>
         /// <param name="server">The server.</param>
-        public async Task Start(ServerBase server)
+        public async Task Start(IServerBase server)
         {
             m_server = server;
 
@@ -1144,7 +1144,7 @@ private static async Task<bool> ApproveMessageAsync(string message, bool silent)
         private ApplicationType m_applicationType;
         private string m_configSectionName;
         private Type m_configurationType;
-        private ServerBase m_server;
+        private IServerBase m_server;
         private ApplicationConfiguration m_applicationConfiguration;
         #endregion
     }

Libraries/Opc.Ua.Configuration/Extensions/DependencyInjection/ServiceCollectionExtensions.cs

@@ -0,0 +1,50 @@
+/* ========================================================================
+ * Copyright (c) 2005-2020 The OPC Foundation, Inc. All rights reserved.
+ *
+ * OPC Foundation MIT License 1.00
+ *
+ * Permission is hereby granted, free of charge, to any person
+ * obtaining a copy of this software and associated documentation
+ * files (the "Software"), to deal in the Software without
+ * restriction, including without limitation the rights to use,
+ * copy, modify, merge, publish, distribute, sublicense, and/or sell
+ * copies of the Software, and to permit persons to whom the
+ * Software is furnished to do so, subject to the following
+ * conditions:
+ *
+ * The above copyright notice and this permission notice shall be
+ * included in all copies or substantial portions of the Software.
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+ * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+ * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+ * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+ * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+ * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+ * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+ * OTHER DEALINGS IN THE SOFTWARE.
+ *
+ * The complete license agreement can be found here:
+ * http://opcfoundation.org/License/MIT/1.00/
+ * ======================================================================*/
+
+using Microsoft.Extensions.DependencyInjection;
+
+namespace Opc.Ua.Configuration.Extensions.DependencyInjection
+{
+    /// <summary>
+    /// Class that provides service collection extensions to setup dependency injection
+    /// for server objects.
+    /// </summary>
+    public static class ServiceCollectionExtensions
+    {
+        /// <summary>
+        /// Add all the necessary server services to dependency injection.
+        /// </summary>
+        /// <param name="services">The service collection of the application.</param>
+        /// <returns>The updated service collection.</returns>
+        public static IServiceCollection AddConfigurationServices(this IServiceCollection services)
+        {
+            return services.AddScoped<IApplicationInstance, ApplicationInstance>();
+        }
+    }
+}