Added options to MongoClient settings

Author: papafe

src/MongoDB.Driver/MongoClientSettings.cs

@@ -59,6 +59,10 @@ public class MongoClientSettings : IEquatable<MongoClientSettings>, IInheritable
         private TimeSpan _maxConnectionLifeTime;
         private int _maxConnectionPoolSize;
         private int _minConnectionPoolSize;
+        private string _proxyHost;
+        private int? _proxyPort;
+        private string _proxyUsername;
+        private string _proxyPassword;
         private ReadConcern _readConcern;
         private UTF8Encoding _readEncoding;
         private ReadPreference _readPreference;
@@ -110,6 +114,10 @@ public MongoClientSettings()
             _maxConnectionLifeTime = MongoDefaults.MaxConnectionLifeTime;
             _maxConnectionPoolSize = MongoDefaults.MaxConnectionPoolSize;
             _minConnectionPoolSize = MongoDefaults.MinConnectionPoolSize;
+            _proxyHost = null;
+            _proxyPort = null;
+            _proxyUsername = null;
+            _proxyPassword = null;
             _readConcern = ReadConcern.Default;
             _readEncoding = null;
             _readPreference = ReadPreference.Primary;
@@ -428,6 +436,64 @@ public int MinConnectionPoolSize
             }
         }
 
+        /// <summary>
+        /// Gets or sets the proxy host.
+        /// </summary>
+        public string ProxyHost
+        {
+            get => _proxyHost;
+            set
+            {
+                if (_isFrozen) { throw new InvalidOperationException("MongoClientSettings is frozen."); }
+                _proxyHost = Ensure.IsNotNullOrEmpty(value, nameof(ProxyHost));
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the proxy port.
+        /// </summary>
+        public int? ProxyPort
+        {
+            get => _proxyPort;
+            set
+            {
+                if (_isFrozen) { throw new InvalidOperationException("MongoClientSettings is frozen."); }
+
+                if (value is < 0 or > 65535)
+                {
+                    throw new MongoConfigurationException("ProxyPort must be between 0 and 65535.");
+                }
+
+                _proxyPort = value;
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the proxy username.
+        /// </summary>
+        public string ProxyUsername
+        {
+            get => _proxyUsername;
+            set
+            {
+                if (_isFrozen) { throw new InvalidOperationException("MongoClientSettings is frozen."); }
+                _proxyUsername = Ensure.IsNotNullOrEmpty(value, nameof(ProxyUsername));
+            }
+        }
+
+        /// <summary>
+        /// Gets or sets the proxy password.
+        /// </summary>
+        public string ProxyPassword
+        {
+            get => _proxyPassword;
+            set
+            {
+                if (_isFrozen) { throw new InvalidOperationException("MongoClientSettings is frozen."); }
+                _proxyPassword = Ensure.IsNotNullOrEmpty(value, nameof(ProxyPassword));
+            }
+        }
+
         /// <summary>
         /// Gets or sets the read concern.
         /// </summary>
@@ -863,6 +929,10 @@ public static MongoClientSettings FromUrl(MongoUrl url)
             clientSettings.MaxConnectionLifeTime = url.MaxConnectionLifeTime;
             clientSettings.MaxConnectionPoolSize = ConnectionStringConversions.GetEffectiveMaxConnections(url.MaxConnectionPoolSize);
             clientSettings.MinConnectionPoolSize = url.MinConnectionPoolSize;
+            clientSettings.ProxyHost = url.ProxyHost;
+            clientSettings.ProxyPort = url.ProxyPort;
+            clientSettings.ProxyUsername = url.ProxyUsername;
+            clientSettings.ProxyPassword = url.ProxyPassword;
             clientSettings.ReadConcern = new ReadConcern(url.ReadConcernLevel);
             clientSettings.ReadEncoding = null; // ReadEncoding must be provided in code
             clientSettings.ReadPreference = (url.ReadPreference == null) ? ReadPreference.Primary : url.ReadPreference;
@@ -920,6 +990,10 @@ public MongoClientSettings Clone()
             clone._maxConnectionLifeTime = _maxConnectionLifeTime;
             clone._maxConnectionPoolSize = _maxConnectionPoolSize;
             clone._minConnectionPoolSize = _minConnectionPoolSize;
+            clone._proxyHost = _proxyHost;
+            clone._proxyPort = _proxyPort;
+            clone._proxyUsername = _proxyUsername;
+            clone._proxyPassword = _proxyPassword;
             clone._readConcern = _readConcern;
             clone._readEncoding = _readEncoding;
             clone._readPreference = _readPreference;
@@ -989,6 +1063,10 @@ public override bool Equals(object obj)
                 _maxConnectionLifeTime == rhs._maxConnectionLifeTime &&
                 _maxConnectionPoolSize == rhs._maxConnectionPoolSize &&
                 _minConnectionPoolSize == rhs._minConnectionPoolSize &&
+                _proxyHost == rhs._proxyHost &&
+                _proxyPort == rhs._proxyPort &&
+                _proxyUsername == rhs._proxyUsername &&
+                _proxyPassword == rhs._proxyPassword &&
                 object.Equals(_readEncoding, rhs._readEncoding) &&
                 object.Equals(_readConcern, rhs._readConcern) &&
                 object.Equals(_readPreference, rhs._readPreference) &&
@@ -1076,6 +1154,10 @@ public override int GetHashCode()
                 .Hash(_maxConnectionLifeTime)
                 .Hash(_maxConnectionPoolSize)
                 .Hash(_minConnectionPoolSize)
+                .Hash(_proxyHost)
+                .Hash(_proxyPort)
+                .Hash(_proxyUsername)
+                .Hash(_proxyPassword)
                 .Hash(_readConcern)
                 .Hash(_readEncoding)
                 .Hash(_readPreference)
@@ -1145,6 +1227,22 @@ public override string ToString()
             sb.AppendFormat("MaxConnectionLifeTime={0};", _maxConnectionLifeTime);
             sb.AppendFormat("MaxConnectionPoolSize={0};", _maxConnectionPoolSize);
             sb.AppendFormat("MinConnectionPoolSize={0};", _minConnectionPoolSize);
+            if (_proxyHost != null)
+            {
+                sb.AppendFormat("ProxyHost={0};", _proxyHost);
+            }
+            if (_proxyPort != null)
+            {
+                sb.AppendFormat("ProxyPort={0};", _proxyPort.Value);
+            }
+            if (_proxyUsername != null)
+            {
+                sb.AppendFormat("ProxyUsername={0};", _proxyUsername);
+            }
+            if (_proxyPassword != null)
+            {
+                sb.AppendFormat("ProxyPassword={0};", _proxyPassword);
+            }
             if (_readEncoding != null)
             {
                 sb.Append("ReadEncoding=UTF8Encoding;");
@@ -1297,6 +1395,29 @@ private void ThrowIfSettingsAreInvalid()
                     throw new InvalidOperationException("Load balanced mode cannot be used with direct connection.");
                 }
             }
+
+            if (string.IsNullOrEmpty(_proxyHost))
+            {
+                if (_proxyPort is not null)
+                {
+                    throw new InvalidOperationException("ProxyPort cannot be specified without ProxyHost.");
+                }
+
+                if (!string.IsNullOrEmpty(_proxyUsername))
+                {
+                    throw new InvalidOperationException("ProxyUsername cannot be specified without ProxyHost.");
+                }
+
+                if (!string.IsNullOrEmpty(_proxyPassword))
+                {
+                    throw new InvalidOperationException("ProxyPassword cannot be specified without ProxyHost.");
+                }
+            }
+
+            if (string.IsNullOrEmpty(_proxyUsername) != string.IsNullOrEmpty(_proxyPassword))
+            {
+                throw new InvalidOperationException("ProxyUsername and ProxyPassword must both be specified or neither.");
+            }
         }
     }
 }