MongoDB C++ Driver mongocxx-4.0.0
Loading...
Searching...
No Matches
client_encryption.hpp
Go to the documentation of this file.
1// Copyright 2009-present MongoDB, Inc.
2//
3// Licensed under the Apache License, Version 2.0 (the "License");
4// you may not use this file except in compliance with the License.
5// You may obtain a copy of the License at
6//
7// http://www.apache.org/licenses/LICENSE-2.0
8//
9// Unless required by applicable law or agreed to in writing, software
10// distributed under the License is distributed on an "AS IS" BASIS,
11// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12// See the License for the specific language governing permissions and
13// limitations under the License.
14
15#pragma once
16
17#include <string>
18
22
25
27
28namespace mongocxx {
29namespace v_noabi {
30namespace options {
31
36 public:
53
60 MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::client*>&)
62
66 using ns_pair = std::pair<std::string, std::string>;
67
86
94 MONGOCXX_ABI_EXPORT_CDECL(const bsoncxx::v_noabi::stdx::optional<ns_pair>&)
96
142 kms_providers(bsoncxx::v_noabi::document::view_or_value kms_providers);
143
151 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
153
178 tls_opts(bsoncxx::v_noabi::document::view_or_value tls_opts);
179
187 const bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value>&)
188 tls_opts() const;
189
190 private:
191 friend ::mongocxx::v_noabi::client_encryption;
192
193 void* convert() const;
194
195 bsoncxx::v_noabi::stdx::optional<mongocxx::v_noabi::client*> _key_vault_client;
196 bsoncxx::v_noabi::stdx::optional<ns_pair> _key_vault_namespace;
197 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _kms_providers;
198 bsoncxx::v_noabi::stdx::optional<bsoncxx::v_noabi::document::view_or_value> _tls_opts;
199};
200
201} // namespace options
202} // namespace v_noabi
203} // namespace mongocxx
204
205#include <mongocxx/config/postlude.hpp>
206
Class representing options for the object managing explicit client-side encryption.
Definition client_encryption.hpp:35
const bsoncxx::v_noabi::stdx::optional< mongocxx::v_noabi::client * > & key_vault_client() const
Gets the key vault client.
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & tls_opts() const
Gets the TLS options.
const bsoncxx::v_noabi::stdx::optional< ns_pair > & key_vault_namespace() const
Gets the key vault namespace.
std::pair< std::string, std::string > ns_pair
Represents the name of a database and a collection.
Definition client_encryption.hpp:66
const bsoncxx::v_noabi::stdx::optional< bsoncxx::v_noabi::document::view_or_value > & kms_providers() const
Gets the KMS providers.
Class representing the optional arguments to a MongoDB driver client object.
Definition client.hpp:39
Declares mongocxx::v_noabi::client.
Declares mongocxx::v_noabi::client_encryption.
Provides bsoncxx::v_noabi::document::view_or_value.
#define MONGOCXX_ABI_EXPORT_CDECL(...)
Equivalent to MONGOCXX_ABI_EXPORT with MONGOCXX_ABI_CDECL.
Definition fwd.hpp:204
The mongocxx macro guard prelude header.
The top-level namespace within which all bsoncxx library entities are declared.
The top-level namespace within which all mongocxx library entities are declared.
The top-level namespace reserved for the C++ standard library.
Provides std::optional-related polyfills for library API usage.
Declares mongocxx::v_noabi::options::client_encryption.