WireMock.Net-wiremock/src/WireMock.Net/Settings/IWireMockServerSettings.cs

using System;
using HandlebarsDotNet;
using JetBrains.Annotations;
using WireMock.Handlers;
using WireMock.Logging;
using WireMock.Matchers;

namespace WireMock.Settings
{
    /// <summary>
    /// IWireMockServerSettings
    /// </summary>
    public interface IWireMockServerSettings
    {
        /// <summary>
        /// Gets or sets the port.
        /// </summary>
        [PublicAPI]
        int? Port { get; set; }

        /// <summary>
        /// Gets or sets the use SSL.
        /// </summary>
        // ReSharper disable once InconsistentNaming
        [PublicAPI]
        bool? UseSSL { get; set; }

        /// <summary>
        /// Gets or sets whether to start admin interface.
        /// </summary>
        [PublicAPI]
        bool? StartAdminInterface { get; set; }

        /// <summary>
        /// Gets or sets if the static mappings should be read at startup.
        /// </summary>
        [PublicAPI]
        bool? ReadStaticMappings { get; set; }

        /// <summary>
        /// Watch the static mapping files + folder for changes when running.
        /// </summary>
        [PublicAPI]
        bool? WatchStaticMappings { get; set; }

        /// <summary>
        /// A value indicating whether subdirectories within the static mappings path should be monitored.
        /// </summary>
        [PublicAPI]
        bool? WatchStaticMappingsInSubdirectories { get; set; }

        /// <summary>
        /// Gets or sets if the proxy and record settings.
        /// </summary>
        [PublicAPI]
        IProxyAndRecordSettings ProxyAndRecordSettings { get; set; }

        /// <summary>
        /// Gets or sets the urls.
        /// </summary>
        [PublicAPI]
        string[] Urls { get; set; }

        /// <summary>
        /// StartTimeout
        /// </summary>
        [PublicAPI]
        int StartTimeout { get; set; }

        /// <summary>
        /// Allow Partial Mapping (default set to false).
        /// </summary>
        [PublicAPI]
        bool? AllowPartialMapping { get; set; }

        /// <summary>
        /// The username needed for __admin access.
        /// </summary>
        [PublicAPI]
        string AdminUsername { get; set; }

        /// <summary>
        /// The password needed for __admin access.
        /// </summary>
        [PublicAPI]
        string AdminPassword { get; set; }

        /// <summary>
        /// The RequestLog expiration in hours (optional).
        /// </summary>
        [PublicAPI]
        int? RequestLogExpirationDuration { get; set; }

        /// <summary>
        /// The MaxRequestLog count (optional).
        /// </summary>
        [PublicAPI]
        int? MaxRequestLogCount { get; set; }

        /// <summary>
        /// Action which is called (with the IAppBuilder or IApplicationBuilder) before the internal WireMockMiddleware is initialized. [Optional]
        /// </summary>
        [PublicAPI]
        Action<object> PreWireMockMiddlewareInit { get; set; }

        /// <summary>
        /// Action which is called (with the IAppBuilder or IApplicationBuilder) after the internal WireMockMiddleware is initialized. [Optional]
        /// </summary>
        [PublicAPI]
        Action<object> PostWireMockMiddlewareInit { get; set; }

        /// <summary>
        /// The IWireMockLogger which logs Debug, Info, Warning or Error
        /// </summary>
        [PublicAPI]
        IWireMockLogger Logger { get; set; }

        /// <summary>
        /// Handler to interact with the file system to read and write static mapping files.
        /// </summary>
        [PublicAPI]
        IFileSystemHandler FileSystemHandler { get; set; }

        /// <summary>
        /// Action which can be used to add additional Handlebars registrations. [Optional]
        /// </summary>
        [PublicAPI]
        Action<IHandlebars, IFileSystemHandler> HandlebarsRegistrationCallback { get; set; }

        /// <summary>
        /// Allow the usage of CSharpCodeMatcher (default is not allowed).
        /// </summary>
        [PublicAPI]
        bool? AllowCSharpCodeMatcher { get; set; }

        /// <summary>
        /// Allow a Body for all HTTP Methods. (default set to false).
        /// </summary>
        [PublicAPI]
        bool? AllowBodyForAllHttpMethods { get; set; }

        /// <summary>
        /// Allow only a HttpStatus Code in the response which is defined. (default set to false).
        /// - false : also null, 0, empty or invalid HttpStatus codes are allowed.
        /// - true  : only codes defined in <see cref="System.Net.HttpStatusCode"/> are allowed.
        /// </summary>
        [PublicAPI]
        bool? AllowOnlyDefinedHttpStatusCodeInResponse { get; set; }

        /// <summary>
        /// Set to true to disable Json deserialization when processing requests. (default set to false).
        /// </summary>
        [PublicAPI]
        bool? DisableJsonBodyParsing { get; set; }

        /// <summary>
        /// Disable support for GZip and Deflate request body decompression. (default set to false).
        /// </summary>
        [PublicAPI]
        bool? DisableRequestBodyDecompressing { get; set; }

        /// <summary>
        /// Handle all requests synchronously. (default set to false).
        /// </summary>
        [PublicAPI]
        bool? HandleRequestsSynchronously { get; set; }

        /// <summary>
        /// Throw an exception when the <see cref="IMatcher"/> fails because of invalid input. (default set to false).
        /// </summary>
        [PublicAPI]
        bool? ThrowExceptionWhenMatcherFails { get; set; }

        /// <summary>
        /// If https is used, these settings can be used to configure the CertificateSettings in case a custom certificate instead the default .NET certificate should be used.
        ///
        /// X509StoreName and X509StoreLocation should be defined
        /// OR
        /// X509CertificateFilePath and X509CertificatePassword should be defined
        /// </summary>
        [PublicAPI]
        IWireMockCertificateSettings CertificateSettings { get; set; }

        /// <summary>
        /// Defines if custom CertificateSettings are defined
        /// </summary>
        [PublicAPI]
        bool CustomCertificateDefined { get; }

        /// <summary>
        /// Defines the global IWebhookSettingsto use
        /// </summary>
        [PublicAPI]
        IWebhookSettings WebhookSettings { get; set; }
    }
}