UA-.NETStandard/tools/Opc.Ua.SourceGeneration.Core/Generators/ServerApiTemplates.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/
 * ======================================================================*/

namespace Opc.Ua.SourceGeneration
{
    /// <summary>
    /// Template strings
    /// </summary>
    internal static class ServerApiTemplates
    {
        /// <summary>
        /// Server base template
        /// </summary>
        public static readonly TemplateString File = TemplateString.Parse(
            $$"""
            {{Tokens.CodeHeader}}

            namespace {{Tokens.Prefix}}
            {
                {{Tokens.ServiceSets}}
            }
            """);

        /// <summary>
        /// Server API service set template
        /// </summary>
        public static readonly TemplateString ServiceSet = TemplateString.Parse(
            $$"""
            /// <summary>
            /// An interface to a UA server implementation.
            /// </summary>
            [global::System.CodeDom.Compiler.GeneratedCodeAttribute("{{Tokens.Tool}}", "{{Tokens.Version}}")]
            public interface I{{Tokens.ServiceSet}}Server : global::Opc.Ua.IServerBase
            {
                {{Tokens.ServerApi}}
            }

            /// <summary>
            /// A basic implementation of the {{Tokens.ServiceSet}} server.
            /// </summary>
            [global::System.CodeDom.Compiler.GeneratedCodeAttribute("{{Tokens.Tool}}", "{{Tokens.Version}}")]
            [global::System.Diagnostics.CodeAnalysis.ExcludeFromCodeCoverageAttribute()]
            public partial class {{Tokens.ServiceSet}}ServerBase :
                global::Opc.Ua.ServerBase,
                global::Opc.Ua.I{{Tokens.ServiceSet}}Server
            {
                /// <summary>
                /// Create the {{Tokens.ServiceSet}} server.
                /// </summary>
                public {{Tokens.ServiceSet}}ServerBase(global::Opc.Ua.ITelemetryContext telemetry)
                    : base(telemetry)
                {
                }

                {{Tokens.ServerStubs}}
            }

            """);

        /// <summary>
        /// Server API interface method template
        /// </summary>
        public static readonly TemplateString InterfaceMethod = TemplateString.Parse(
            $$"""
            /// <summary>
            /// Invokes the {{Tokens.Name}} service using async Task based request.
            /// </summary>
            {{Tokens.ServerMethodAsync}}

            """);

        /// <summary>
        /// Server API interface method template
        /// </summary>
        public static readonly TemplateString Method = TemplateString.Parse(
            $$"""
            /// <summary>
            /// Invokes the {{Tokens.Name}} service using async Task based request.
            /// </summary>
            {{Tokens.ServerMethodAsync}}
            {
                ValidateRequest(requestHeader);

                // Insert implementation.
                await global::System.Threading.Tasks.Task.CompletedTask;

                throw new global::Opc.Ua.ServiceResultException(global::Opc.Ua.StatusCodes.BadServiceUnsupported);
            }

            """);
    }
}