UA-.NETStandard/Libraries/Opc.Ua.Server/NodeManager/ServerSystemContext.cs

/* ========================================================================
 * Copyright (c) 2005-2025 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;

namespace Opc.Ua.Server
{
    /// <summary>
    /// A generic implementation for ISystemContext interface.
    /// </summary>
    public class ServerSystemContext : SessionSystemContext
    {
        /// <summary>
        /// Initializes a new instance of the <see cref="SystemContext"/> class.
        /// </summary>
        /// <param name="server">The server.</param>
        public ServerSystemContext(IServerInternal server)
            : base((server ?? throw new ArgumentNullException(nameof(server))).Telemetry)
        {
            Server = server;
            OperationContext = null!;
            NamespaceUris = server.NamespaceUris;
            ServerUris = server.ServerUris;
            TypeTable = server.TypeTree;
            EncodeableFactory = server.Factory;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="SystemContext"/> class.
        /// </summary>
        /// <param name="server">The server.</param>
        /// <param name="context">The context.</param>
        public ServerSystemContext(IServerInternal server, OperationContext context)
             : base((server ?? throw new ArgumentNullException(nameof(server))).Telemetry)
        {
            Server = server;
            OperationContext = context;
            NamespaceUris = server.NamespaceUris;
            ServerUris = server.ServerUris;
            TypeTable = server.TypeTree;
            EncodeableFactory = server.Factory;
        }

        /// <summary>
        /// Initializes a new instance of the <see cref="SystemContext"/> class.
        /// </summary>
        /// <param name="server">The server.</param>
        /// <param name="session">The session.</param>
        public ServerSystemContext(IServerInternal server, ISession session)
             : base((server ?? throw new ArgumentNullException(nameof(server))).Telemetry)
        {
            Server = server;
            OperationContext = null!;
            SessionId = session.Id;
            UserIdentity = session.Identity;
            PreferredLocales = session.PreferredLocales;
            NamespaceUris = server.NamespaceUris;
            ServerUris = server.ServerUris;
            TypeTable = server.TypeTree;
            EncodeableFactory = server.Factory;
        }

        /// <summary>
        /// The <see cref="IServerInternal"/> backing this system context.
        /// Provides access to server-wide services (AggregateManager,
        /// SessionManager, audit reporting, etc.) needed by infrastructure
        /// components such as the historian dispatcher.
        /// </summary>
        public IServerInternal Server { get; }

        /// <summary>
        /// The operation context associated with system context.
        /// </summary>
        /// <value>The operation context.</value>
        /// <remarks>
        /// May return <c>null</c> if the underlying base context's operation context
        /// has not been set or is not an <see cref="OperationContext"/> instance
        /// (e.g. during NodeManager startup before any operation has begun).
        /// </remarks>
        public new OperationContext? OperationContext
        {
            get => base.OperationContext as OperationContext;
            set => base.OperationContext = value;
        }

        /// <summary>
        /// Creates a copy of the context that can be used with the specified operation context.
        /// </summary>
        /// <returns>A copy of the system context.</returns>
        public ServerSystemContext Copy()
        {
            return (ServerSystemContext)MemberwiseClone();
        }

        /// <summary>
        /// Creates a copy of the context that can be used with the specified operation context.
        /// </summary>
        /// <param name="context">The operation context to use.</param>
        /// <returns>
        /// A copy of the system context that references the new operation context.
        /// </returns>
        public ServerSystemContext Copy(OperationContext context)
        {
            var copy = (ServerSystemContext)MemberwiseClone();

            if (context != null)
            {
                copy.OperationContext = context;
            }

            return copy;
        }

        /// <summary>
        /// Creates a copy of the context that can be used with the specified session.
        /// </summary>
        /// <param name="session">The session to use.</param>
        /// <returns>
        /// A copy of the system context that references the new session.
        /// </returns>
        public ServerSystemContext Copy(ISession session)
        {
            var copy = (ServerSystemContext)MemberwiseClone();

            copy.OperationContext = null!;

            if (session != null)
            {
                copy.SessionId = session.Id;
                copy.UserIdentity = session.Identity;
                copy.PreferredLocales = session.PreferredLocales;
            }
            else
            {
                copy.SessionId = default;
                copy.UserIdentity = null;
                copy.PreferredLocales = default;
            }

            return copy;
        }

        /// <summary>
        /// Creates a copy of the context that can be used with the specified server context.
        /// </summary>
        /// <param name="context">The server context to use.</param>
        /// <returns>
        /// A copy of the system context that references the new server context.
        /// </returns>
        public ServerSystemContext Copy(ServerSystemContext context)
        {
            var copy = (ServerSystemContext)MemberwiseClone();

            if (context != null)
            {
                copy.OperationContext = context.OperationContext;
                copy.SessionId = context.SessionId;
                copy.UserIdentity = context.UserIdentity;
                copy.PreferredLocales = context.PreferredLocales;
                copy.NamespaceUris = context.NamespaceUris;
                copy.ServerUris = context.ServerUris;
                copy.TypeTable = context.TypeTable;
                copy.EncodeableFactory = context.EncodeableFactory;
                copy.NodeIdFactory = context.NodeIdFactory;
            }

            return copy;
        }
    }
}