CXX-162 Configure client at initialization time via Options class

Author: acmorrow

src/SConscript.client

@@ -88,14 +88,14 @@ clientSourceBasic = [
     'mongo/client/gridfs.cpp',
     'mongo/client/init.cpp',
     'mongo/client/insert_write_operation.cpp',
+    'mongo/client/options.cpp',
     'mongo/client/sasl_client_authenticate.cpp',
     'mongo/client/update_write_operation.cpp',
     'mongo/client/wire_protocol_writer.cpp',
     'mongo/client/write_concern.cpp',
     'mongo/db/jsobj.cpp',
     'mongo/db/json.cpp',
     'mongo/db/dbmessage.cpp',
-    'mongo/db/server_options.cpp',
     'mongo/logger/log_manager.cpp',
     'mongo/logger/log_severity.cpp',
     'mongo/logger/logger.cpp',
@@ -198,6 +198,7 @@ clientHeaders = [
     'mongo/client/export_macros.h',
     'mongo/client/gridfs.h',
     'mongo/client/init.h',
+    'mongo/client/options.h',
     'mongo/client/redef_macros.h',
     'mongo/client/sasl_client_authenticate.h',
     'mongo/client/undef_macros.h',
@@ -206,7 +207,6 @@ clientHeaders = [
     'mongo/config.h',
     'mongo/db/jsobj.h',
     'mongo/db/json.h',
-    'mongo/db/server_options.h',
     'mongo/logger/appender.h',
     'mongo/logger/labeled_level.h',
     'mongo/logger/log_domain.h',
@@ -249,7 +249,6 @@ clientHeaders = [
     'mongo/util/net/operation.h',
     'mongo/util/net/sock.h',
     'mongo/util/net/ssl_manager.h',
-    'mongo/util/net/ssl_options.h',
     'mongo/util/time_support.h',
     'mongo/version.h',
 ]

src/mongo/client/dbclient.cpp

@@ -28,6 +28,7 @@
 #include "mongo/client/dbclientcursorshimcursorid.h"
 #include "mongo/client/dbclient_writer.h"
 #include "mongo/client/insert_write_operation.h"
+#include "mongo/client/options.h"
 #include "mongo/client/update_write_operation.h"
 #include "mongo/client/delete_write_operation.h"
 #include "mongo/client/sasl_client_authenticate.h"
@@ -37,7 +38,6 @@
 #include "mongo/db/namespace_string.h"
 #include "mongo/util/assert_util.h"
 #include "mongo/util/net/ssl_manager.h"
-#include "mongo/util/net/ssl_options.h"
 #include "mongo/util/password_digest.h"
 
 namespace mongo {
@@ -918,11 +918,8 @@ namespace mongo {
         }
 
 #ifdef MONGO_SSL
-        int sslModeVal = sslGlobalParams.sslMode.load();
-        if (sslModeVal == SSLGlobalParams::SSLMode_preferSSL ||
-            sslModeVal == SSLGlobalParams::SSLMode_requireSSL) {
+        if (client::Options::current().SSLEnabled())
             return p->secure( sslManager(), _server.host() );
-        }
 #endif
         BSONObj info;
         bool worked = simpleCommand("admin", &info, "ismaster");

src/mongo/client/dbclient.h

@@ -54,8 +54,8 @@
 #include "mongo/client/dbclientinterface.h"
 #include "mongo/client/gridfs.h"
 #include "mongo/client/init.h"
+#include "mongo/client/options.h"
 #include "mongo/client/sasl_client_authenticate.h"
-#include "mongo/util/net/ssl_options.h"
 #include "mongo/version.h"
 
 #include "mongo/client/undef_macros.h"

src/mongo/client/examples/httpClientTest.cpp

@@ -45,11 +45,13 @@ void play( std::string url ) {
 
 int main( int argc, const char **argv, char **envp) {
 
+    mongo::client::Options options;
+
 #ifdef MONGO_SSL
-    mongo::sslGlobalParams.sslMode.store(mongo::SSLGlobalParams::SSLMode_requireSSL);
+    options.setSSLMode(mongo::client::Options::kSSLRequired);
 #endif
 
-    mongo::Status status = mongo::client::initialize();
+    mongo::Status status = mongo::client::initialize(options);
     if (!status.isOK()) {
         std::cout << "Failed to initialize mongodb client. " << status << std::endl;
         return EXIT_FAILURE;

src/mongo/client/init.cpp

@@ -21,6 +21,7 @@
 
 #include "mongo/base/initializer.h"
 #include "mongo/client/connpool.h"
+#include "mongo/client/private/options.h"
 #include "mongo/client/replica_set_monitor.h"
 #include "mongo/util/background.h"
 
@@ -30,13 +31,16 @@ namespace client {
     namespace {
         void callShutdownAtExit() {
             // We can't really do anything of value if this returns a non-OK status.
-            mongo::client::shutdown(kDefaultShutdownGracePeriodMillis);
+            mongo::client::shutdown();
         }
     } // namespace
 
-    Status initialize(bool atexit) {
+    Status initialize(const Options& options) {
 
-        if (atexit) {
+        // Copy in the provided options.
+        setOptions(options);
+
+        if (options.callShutdownAtExit()) {
             if (std::atexit(&callShutdownAtExit) != 0) {
                 return Status(
                     ErrorCodes::InternalError,
@@ -57,9 +61,12 @@ namespace client {
         return Status::OK();
     }
 
-    Status shutdown(int gracePeriodMillis) {
+    Status shutdown() {
         ReplicaSetMonitor::cleanup();
-        Status s = PeriodicTask::stopRunningPeriodicTasks(gracePeriodMillis);
+
+        const int gracePeriod = Options::current().autoShutdownGracePeriodMillis();
+        Status s = PeriodicTask::stopRunningPeriodicTasks(gracePeriod);
+
         shutdownNetworking();
         return s;
     }

src/mongo/client/init.h

@@ -19,6 +19,7 @@
 
 #include "mongo/base/status.h"
 #include "mongo/client/export_macros.h"
+#include "mongo/client/options.h"
 
 // NOTE: These functions are only intended to be used when linking against the libmongoclient
 // library. The below functions are not defined in servers like mongos or mongod, which have
@@ -36,31 +37,26 @@ namespace mongo {
  */
 namespace client {
 
-    const int kDefaultShutdownGracePeriodMillis = 250;
-
     /**
-     *  Initializes the client driver. If the 'callShutdownAtExit' parameter is true, then
-     *  'initialize' schedules a call to 'client::shutdown', with a grace period of
-     *  'kDefaultShutdownGracePeriodMillis', via std::atexit. Failure to shutdown within the
-     *  grace period in the 'atexit' callback leads to a call to abort. If the
-     *  'callShutDownAtExit' parameter is false, then it is the responsibility of the user of
-     *  the client driver to appropriately sequence a call to 'mongo::client::shutdown' and
-     *  respond to any failure to terminate within the grace period. Note that 'initialize'
-     *  invokes 'runGlobalInitializers', so it is not permitted to explicitly call
-     *  'runGlobalInitializers' if calling 'initialize'. If a non-OK status is returned by this
-     *  function, the error should be reported and the client driver API must not be used.
+     *  Initializes the client driver, possibly with custom options. See the Options class for
+     *  details on the various fields.
+     *
+     *  NOTE: Do not call 'initialize' before entering 'main' (i.e. from a static initializer),
+     *  as it relies on all static initialization having been completed.
+     *
+     *  NOTE: Do not call 'initialize' more than once.
      */
-    MONGO_CLIENT_API Status MONGO_CLIENT_FUNC initialize(bool callShutdownAtExit = true);
+    MONGO_CLIENT_API Status MONGO_CLIENT_FUNC initialize(const Options& options = Options());
 
     /**
-     *  Terminates the client driver. If the driver does not terminate within the provided
-     *  grace period (which defaults to kDefaultShutdownGracePeriodMillis), an
-     *  'ExceededTimeLimit' Status will be returned, in which case it is legal to retry
-     *  'shutdown'. Other non-OK status values do not admit retrying the operation, and the
-     *  failure to terminate the driver should be reported, and it may be unsafe to exit the
-     *  process by any mechanism which causes normal destruction of static objects.
+     *  Terminates the client driver. If the driver does not terminate within the currently
+     *  configured grace period in the driver options, an 'ExceededTimeLimit' Status will be
+     *  returned, in which case it is legal to retry 'shutdown'. Other non-OK status values do
+     *  not admit retrying the operation. A permanent failure to terminate the driver should be
+     *  logged, and it may be unsafe to exit the process by any mechanism which causes normal
+     *  destruction of static objects.
      */
-    MONGO_CLIENT_API Status MONGO_CLIENT_FUNC shutdown(int gracePeriodMillis = kDefaultShutdownGracePeriodMillis);
+    MONGO_CLIENT_API Status MONGO_CLIENT_FUNC shutdown();
 
 } // namespace client
 } // namespace mongo

src/mongo/client/options.cpp

@@ -0,0 +1,152 @@
+/*    Copyright 2014 10gen Inc.
+ *
+ *    Licensed under the Apache License, Version 2.0 (the "License");
+ *    you may not use this file except in compliance with the License.
+ *    You may obtain a copy of the License at
+ *
+ *    http://www.apache.org/licenses/LICENSE-2.0
+ *
+ *    Unless required by applicable law or agreed to in writing, software
+ *    distributed under the License is distributed on an "AS IS" BASIS,
+ *    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ *    See the License for the specific language governing permissions and
+ *    limitations under the License.
+ */
+
+#include "mongo/platform/basic.h"
+
+#include "mongo/client/private/options.h"
+#include "mongo/client/options.h"
+
+namespace mongo {
+namespace client {
+
+    namespace {
+        // The unique global options instance.
+        Options options;
+    } // namespace
+
+#if !defined(_MSC_EXTENSIONS)
+    const int Options::kDefaultDefaultLocalThresholdMillis;
+    const int Options::kDefaultAutoShutdownGracePeriodMillis;
+#endif
+
+    void setOptions(const Options& newOptions) {
+        options = newOptions;
+    }
+
+    const Options& Options::current() {
+        return options;
+    }
+
+    Options::Options()
+        : _callShutdownAtExit(true)
+        , _autoShutdownGracePeriodMillis(kDefaultAutoShutdownGracePeriodMillis)
+        , _sslMode(kSSLDisabled)
+        , _useFIPSMode(false)
+        , _sslAllowInvalidCertificates(false)
+        , _defaultLocalThresholdMillis(kDefaultDefaultLocalThresholdMillis)
+        , _validateObjects(false)
+    {}
+
+    Options& Options::setCallShutdownAtExit(bool value) {
+        _callShutdownAtExit = value;
+        return *this;
+    }
+
+    bool Options::callShutdownAtExit() const {
+        return _callShutdownAtExit;
+    }
+
+    Options& Options::setAutoShutdownGracePeriodMillis(int millis) {
+        _autoShutdownGracePeriodMillis = millis;
+        return *this;
+    }
+
+    int Options::autoShutdownGracePeriodMillis() const {
+        return _autoShutdownGracePeriodMillis;
+    }
+
+    Options& Options::setDefaultLocalThresholdMillis(int millis) {
+        _defaultLocalThresholdMillis = millis;
+        return *this;
+    }
+
+    int Options::defaultLocalThresholdMillis() const {
+        return _defaultLocalThresholdMillis;
+    }
+
+    Options& Options::setSSLMode(SSLModes sslMode) {
+        _sslMode = sslMode;
+        return *this;
+    }
+
+    Options::SSLModes Options::SSLMode() const {
+        return _sslMode;
+    }
+
+    Options& Options::setFIPSMode(bool value) {
+        _useFIPSMode = value;
+        return *this;
+    }
+
+    const bool Options::FIPSMode() const {
+        return _useFIPSMode;
+    }
+
+    Options& Options::setSSLCAFile(const std::string& fileName) {
+        _sslCAFile = fileName;
+        return *this;
+    }
+
+    const std::string& Options::SSLCAFile() const {
+        return _sslCAFile;
+    }
+
+    Options& Options::setSSLPEMKeyFile(const std::string& fileName) {
+        _sslPEMKeyFile = fileName;
+        return *this;
+    }
+
+    const std::string& Options::SSLPEMKeyFile() const {
+        return _sslPEMKeyFile;
+    }
+
+    Options& Options::setSSLPEMKeyPassword(const std::string& password) {
+        _sslPEMKeyPassword = password;
+        return *this;
+    }
+
+    const std::string& Options::SSLPEMKeyPassword() const {
+        return _sslPEMKeyPassword;
+    }
+
+    Options& Options::setSSLCRLFile(const std::string& fileName) {
+        _sslCRLFile = fileName;
+        return *this;
+    }
+
+    const std::string& Options::SSLCRLFile() const {
+        return _sslCRLFile;
+    }
+
+    Options& Options::setSSLAllowInvalidCertificates(bool value) {
+        _sslAllowInvalidCertificates = value;
+        return *this;
+    }
+
+    const bool Options::SSLAllowInvalidCertificates() const {
+        return _sslAllowInvalidCertificates;
+    }
+
+    Options& Options::setValidateObjects(bool value) {
+        _validateObjects = value;
+        return *this;
+    }
+
+    bool Options::validateObjects() const {
+        return _validateObjects;
+    }
+
+} // namespace client
+} // namespace mongo