CSHARP-694: Added ReadEncoding and WriteEncoding to MongoClientSettings also.

Author: rstam

MongoDB.Driver/Communication/MongoConnection.cs

@@ -19,6 +19,7 @@
 using System.Net.Sockets;
 using System.Security.Authentication;
 using System.Security.Cryptography.X509Certificates;
+using System.Text;
 using MongoDB.Bson;
 using MongoDB.Bson.IO;
 using MongoDB.Bson.Serialization;
@@ -253,6 +254,7 @@ internal CommandResult RunCommand(
 
             var writerSettings = new BsonBinaryWriterSettings
             {
+                Encoding = _serverInstance.Settings.WriteEncoding ?? new UTF8Encoding(false, true),
                 GuidRepresentation = GuidRepresentation.Unspecified,
                 MaxDocumentSize = _serverInstance.MaxDocumentSize
             };
@@ -262,6 +264,7 @@ internal CommandResult RunCommand(
 
             var readerSettings = new BsonBinaryReaderSettings
             {
+                Encoding = _serverInstance.Settings.ReadEncoding ?? new UTF8Encoding(false, true),
                 GuidRepresentation = GuidRepresentation.Unspecified,
                 MaxDocumentSize = _serverInstance.MaxDocumentSize
             };
@@ -367,6 +370,7 @@ internal WriteConcernResult SendMessage(BsonBuffer buffer, MongoRequestMessage m
                 {
                     var readerSettings = new BsonBinaryReaderSettings
                     {
+                        Encoding = _serverInstance.Settings.ReadEncoding ?? new UTF8Encoding(false, true),
                         GuidRepresentation = message.WriterSettings.GuidRepresentation,
                         MaxDocumentSize = _serverInstance.MaxDocumentSize
                     };

MongoDB.Driver/MongoClientSettings.cs

@@ -38,6 +38,7 @@ public class MongoClientSettings : IEquatable<MongoClientSettings>
         private TimeSpan _maxConnectionLifeTime;
         private int _maxConnectionPoolSize;
         private int _minConnectionPoolSize;
+        private UTF8Encoding _readEncoding;
         private ReadPreference _readPreference;
         private string _replicaSetName;
         private TimeSpan _secondaryAcceptableLatency;
@@ -49,6 +50,7 @@ public class MongoClientSettings : IEquatable<MongoClientSettings>
         private int _waitQueueSize;
         private TimeSpan _waitQueueTimeout;
         private WriteConcern _writeConcern;
+        private UTF8Encoding _writeEncoding;
 
         // the following fields are set when Freeze is called
         private bool _isFrozen;
@@ -70,6 +72,7 @@ public MongoClientSettings()
             _maxConnectionLifeTime = MongoDefaults.MaxConnectionLifeTime;
             _maxConnectionPoolSize = MongoDefaults.MaxConnectionPoolSize;
             _minConnectionPoolSize = MongoDefaults.MinConnectionPoolSize;
+            _readEncoding = null;
             _readPreference = ReadPreference.Primary;
             _replicaSetName = null;
             _secondaryAcceptableLatency = MongoDefaults.SecondaryAcceptableLatency;
@@ -81,6 +84,7 @@ public MongoClientSettings()
             _waitQueueSize = MongoDefaults.ComputedWaitQueueSize;
             _waitQueueTimeout = MongoDefaults.WaitQueueTimeout;
             _writeConcern = WriteConcern.Acknowledged;
+            _writeEncoding = null;
         }
 
         // public properties
@@ -213,6 +217,19 @@ public int MinConnectionPoolSize
             }
         }
 
+        /// <summary>
+        /// Gets or sets the Read Encoding.
+        /// </summary>
+        public UTF8Encoding ReadEncoding
+        {
+            get { return _readEncoding; }
+            set
+            {
+                if (_isFrozen) { throw new InvalidOperationException("MongoClientSettings is frozen."); }
+                _readEncoding = value;
+            }
+        }
+
         /// <summary>
         /// Gets or sets the read preferences.
         /// </summary>
@@ -386,6 +403,19 @@ public WriteConcern WriteConcern
             }
         }
 
+        /// <summary>
+        /// Gets or sets the Write Encoding.
+        /// </summary>
+        public UTF8Encoding WriteEncoding
+        {
+            get { return _writeEncoding; }
+            set
+            {
+                if (_isFrozen) { throw new InvalidOperationException("MongoClientSettings is frozen."); }
+                _writeEncoding = value;
+            }
+        }
+
         // public operators
         /// <summary>
         /// Determines whether two <see cref="MongoClientSettings"/> instances are equal.
@@ -440,6 +470,7 @@ public static MongoClientSettings FromConnectionStringBuilder(MongoConnectionStr
             clientSettings.MaxConnectionLifeTime = builder.MaxConnectionLifeTime;
             clientSettings.MaxConnectionPoolSize = builder.MaxConnectionPoolSize;
             clientSettings.MinConnectionPoolSize = builder.MinConnectionPoolSize;
+            clientSettings.ReadEncoding = null; // ReadEncoding must be provided in code
             clientSettings.ReadPreference = (builder.ReadPreference == null) ? ReadPreference.Primary : builder.ReadPreference.Clone();
             clientSettings.ReplicaSetName = builder.ReplicaSetName;
             clientSettings.SecondaryAcceptableLatency = builder.SecondaryAcceptableLatency;
@@ -451,6 +482,7 @@ public static MongoClientSettings FromConnectionStringBuilder(MongoConnectionStr
             clientSettings.WaitQueueSize = builder.ComputedWaitQueueSize;
             clientSettings.WaitQueueTimeout = builder.WaitQueueTimeout;
             clientSettings.WriteConcern = builder.GetWriteConcern(true); // WriteConcern is enabled by default for MongoClient
+            clientSettings.WriteEncoding = null; // WriteEncoding must be provided in code
             return clientSettings;
         }
 
@@ -480,6 +512,7 @@ public static MongoClientSettings FromUrl(MongoUrl url)
             clientSettings.MaxConnectionLifeTime = url.MaxConnectionLifeTime;
             clientSettings.MaxConnectionPoolSize = url.MaxConnectionPoolSize;
             clientSettings.MinConnectionPoolSize = url.MinConnectionPoolSize;
+            clientSettings.ReadEncoding = null; // ReadEncoding must be provided in code
             clientSettings.ReadPreference = (url.ReadPreference == null) ? ReadPreference.Primary : url.ReadPreference;
             clientSettings.ReplicaSetName = url.ReplicaSetName;
             clientSettings.SecondaryAcceptableLatency = url.SecondaryAcceptableLatency;
@@ -491,6 +524,7 @@ public static MongoClientSettings FromUrl(MongoUrl url)
             clientSettings.WaitQueueSize = url.ComputedWaitQueueSize;
             clientSettings.WaitQueueTimeout = url.WaitQueueTimeout;
             clientSettings.WriteConcern = url.GetWriteConcern(true); // WriteConcern is enabled by default for MongoClient
+            clientSettings.WriteEncoding = null; // WriteEncoding must be provided in code
             return clientSettings;
         }
 
@@ -511,6 +545,7 @@ public MongoClientSettings Clone()
             clone._maxConnectionLifeTime = _maxConnectionLifeTime;
             clone._maxConnectionPoolSize = _maxConnectionPoolSize;
             clone._minConnectionPoolSize = _minConnectionPoolSize;
+            clone._readEncoding = _readEncoding;
             clone._readPreference = _readPreference.Clone();
             clone._replicaSetName = _replicaSetName;
             clone._secondaryAcceptableLatency = _secondaryAcceptableLatency;
@@ -522,6 +557,7 @@ public MongoClientSettings Clone()
             clone._waitQueueSize = _waitQueueSize;
             clone._waitQueueTimeout = _waitQueueTimeout;
             clone._writeConcern = _writeConcern.Clone();
+            clone._writeEncoding = _writeEncoding;
             return clone;
         }
 
@@ -558,6 +594,7 @@ public override bool Equals(object obj)
                 _maxConnectionLifeTime == rhs._maxConnectionLifeTime &&
                 _maxConnectionPoolSize == rhs._maxConnectionPoolSize &&
                 _minConnectionPoolSize == rhs._minConnectionPoolSize &&
+                object.Equals(_readEncoding, rhs._readEncoding) &&
                 _readPreference == rhs._readPreference &&
                 _replicaSetName == rhs._replicaSetName &&
                 _secondaryAcceptableLatency == rhs._secondaryAcceptableLatency &&
@@ -568,7 +605,8 @@ public override bool Equals(object obj)
                 _verifySslCertificate == rhs._verifySslCertificate &&
                 _waitQueueSize == rhs._waitQueueSize &&
                 _waitQueueTimeout == rhs._waitQueueTimeout &&
-                _writeConcern == rhs._writeConcern;
+                _writeConcern == rhs._writeConcern &&
+                object.Equals(_writeEncoding, rhs._writeEncoding);
         }
 
         /// <summary>
@@ -625,6 +663,7 @@ public override int GetHashCode()
                 .Hash(_maxConnectionLifeTime)
                 .Hash(_maxConnectionPoolSize)
                 .Hash(_minConnectionPoolSize)
+                .Hash(_readEncoding)
                 .Hash(_readPreference)
                 .Hash(_replicaSetName)
                 .Hash(_secondaryAcceptableLatency)
@@ -636,6 +675,7 @@ public override int GetHashCode()
                 .Hash(_waitQueueSize)
                 .Hash(_waitQueueTimeout)
                 .Hash(_writeConcern)
+                .Hash(_writeEncoding)
                 .GetHashCode();
         }
 
@@ -660,6 +700,10 @@ public override string ToString()
             sb.AppendFormat("MaxConnectionLifeTime={0};", _maxConnectionLifeTime);
             sb.AppendFormat("MaxConnectionPoolSize={0};", _maxConnectionPoolSize);
             sb.AppendFormat("MinConnectionPoolSize={0};", _minConnectionPoolSize);
+            if (_readEncoding != null)
+            {
+                sb.Append("ReadEncoding=[set]");
+            }
             sb.AppendFormat("ReadPreference={0};", _readPreference);
             sb.AppendFormat("ReplicaSetName={0};", _replicaSetName);
             sb.AppendFormat("SecondaryAcceptableLatency={0};", _secondaryAcceptableLatency);
@@ -674,6 +718,10 @@ public override string ToString()
             sb.AppendFormat("WaitQueueSize={0};", _waitQueueSize);
             sb.AppendFormat("WaitQueueTimeout={0}", _waitQueueTimeout);
             sb.AppendFormat("WriteConcern={0};", _writeConcern);
+            if (_writeEncoding != null)
+            {
+                sb.Append("WriteEncoding=[set]");
+            }
             return sb.ToString();
         }
     }

MongoDB.Driver/MongoCollection.cs

@@ -81,8 +81,10 @@ protected MongoCollection(MongoDatabase database, string name, MongoCollectionSe
                 {
                     AssignIdOnInsert = false,
                     GuidRepresentation = _settings.GuidRepresentation,
+                    ReadEncoding = _settings.ReadEncoding,
                     ReadPreference = _settings.ReadPreference,
-                    WriteConcern = _settings.WriteConcern
+                    WriteConcern = _settings.WriteConcern,
+                    WriteEncoding = _settings.WriteEncoding
                 };
                 _commandCollection = _database.GetCollection("$cmd", commandCollectionSettings);
             }

MongoDB.Driver/MongoCollectionSettings.cs

@@ -405,13 +405,13 @@ public override string ToString()
             parts.Add(string.Format("GuidRepresentation={0}", _guidRepresentation));
             if (_readEncoding.HasBeenSet)
             {
-                parts.Add(string.Format("ReadEncoding=[set]", _readEncoding.Value));
+                parts.Add("ReadEncoding=[set]");
             }
             parts.Add(string.Format("ReadPreference={0}", _readPreference));
             parts.Add(string.Format("WriteConcern={0}", _writeConcern));
             if (_writeEncoding.HasBeenSet)
             {
-                parts.Add(string.Format("WriteEncoding=[set]", _writeEncoding.Value));
+                parts.Add("WriteEncoding=[set]");
             }
             return string.Join(";", parts.ToArray());
         }

MongoDB.Driver/MongoDatabaseSettings.cs

@@ -320,13 +320,13 @@ public override string ToString()
             parts.Add(string.Format("GuidRepresentation={0}", _guidRepresentation.Value));
             if (_readEncoding.HasBeenSet)
             {
-                parts.Add(string.Format("ReadEncoding={0}", _readEncoding.Value));
+                parts.Add("ReadEncoding=[set]");
             }
             parts.Add(string.Format("ReadPreference={0}", _readPreference.Value));
             parts.Add(string.Format("WriteConcern={0}", _writeConcern.Value));
             if (_writeEncoding.HasBeenSet)
             {
-                parts.Add(string.Format("WriteEncoding={0}", _writeEncoding.Value));
+                parts.Add("WriteEncoding=[set]");
             }
             return string.Join(";", parts.ToArray());
         }

MongoDB.Driver/MongoServerSettings.cs

@@ -509,6 +509,7 @@ public static MongoServerSettings FromClientSettings(MongoClientSettings clientS
             serverSettings.MaxConnectionLifeTime = clientSettings.MaxConnectionLifeTime;
             serverSettings.MaxConnectionPoolSize = clientSettings.MaxConnectionPoolSize;
             serverSettings.MinConnectionPoolSize = clientSettings.MinConnectionPoolSize;
+            serverSettings.ReadEncoding = clientSettings.ReadEncoding;
             serverSettings.ReadPreference = clientSettings.ReadPreference.Clone();
             serverSettings.ReplicaSetName = clientSettings.ReplicaSetName;
             serverSettings.SecondaryAcceptableLatency = clientSettings.SecondaryAcceptableLatency;
@@ -520,6 +521,7 @@ public static MongoServerSettings FromClientSettings(MongoClientSettings clientS
             serverSettings.WaitQueueSize = clientSettings.WaitQueueSize;
             serverSettings.WaitQueueTimeout = clientSettings.WaitQueueTimeout;
             serverSettings.WriteConcern = clientSettings.WriteConcern.Clone();
+            serverSettings.WriteEncoding = clientSettings.WriteEncoding;
             return serverSettings;
         }
 
@@ -549,6 +551,7 @@ public static MongoServerSettings FromConnectionStringBuilder(MongoConnectionStr
             serverSettings.MaxConnectionLifeTime = builder.MaxConnectionLifeTime;
             serverSettings.MaxConnectionPoolSize = builder.MaxConnectionPoolSize;
             serverSettings.MinConnectionPoolSize = builder.MinConnectionPoolSize;
+            serverSettings.ReadEncoding = null; // ReadEncoding must be provided in code
             serverSettings.ReadPreference = (builder.ReadPreference == null) ? ReadPreference.Primary : builder.ReadPreference.Clone();
             serverSettings.ReplicaSetName = builder.ReplicaSetName;
             serverSettings.SecondaryAcceptableLatency = builder.SecondaryAcceptableLatency;
@@ -562,6 +565,7 @@ public static MongoServerSettings FromConnectionStringBuilder(MongoConnectionStr
 #pragma warning disable 618
             serverSettings.WriteConcern = builder.GetWriteConcern(MongoDefaults.SafeMode.Enabled);
 #pragma warning restore
+            serverSettings.WriteEncoding = null; // WriteEncoding must be provided in code
             return serverSettings;
         }
 
@@ -591,6 +595,7 @@ public static MongoServerSettings FromUrl(MongoUrl url)
             serverSettings.MaxConnectionLifeTime = url.MaxConnectionLifeTime;
             serverSettings.MaxConnectionPoolSize = url.MaxConnectionPoolSize;
             serverSettings.MinConnectionPoolSize = url.MinConnectionPoolSize;
+            serverSettings.ReadEncoding = null; // ReadEncoding must be provided in code
             serverSettings.ReadPreference = (url.ReadPreference == null) ? ReadPreference.Primary : url.ReadPreference;
             serverSettings.ReplicaSetName = url.ReplicaSetName;
             serverSettings.SecondaryAcceptableLatency = url.SecondaryAcceptableLatency;
@@ -604,6 +609,7 @@ public static MongoServerSettings FromUrl(MongoUrl url)
 #pragma warning disable 618
             serverSettings.WriteConcern = url.GetWriteConcern(MongoDefaults.SafeMode.Enabled);
 #pragma warning restore
+            serverSettings.WriteEncoding = null; // WriteEncoding must be provided in code
             return serverSettings;
         }
 
@@ -781,7 +787,7 @@ public override string ToString()
             parts.Add(string.Format("MinConnectionPoolSize={0}", _minConnectionPoolSize));
             if (_readEncoding != null)
             {
-                parts.Add(string.Format("ReadEncoding={0}", _readEncoding));
+                parts.Add("ReadEncoding=[set]");
             }
             parts.Add(string.Format("ReadPreference={0}", _readPreference));
             parts.Add(string.Format("ReplicaSetName={0}", _replicaSetName));
@@ -799,7 +805,7 @@ public override string ToString()
             parts.Add(string.Format("WriteConcern={0}", _writeConcern));
             if (_writeEncoding != null)
             {
-                parts.Add(string.Format("WriteEncoding={0}", _writeEncoding));
+                parts.Add("WriteEncoding=[set]");
             }
             return string.Join(",", parts.ToArray());
         }