class Mongo::Crypt::KMS::KMIP::Credentials

KMIP KMS Credentials object contains credentials for a remote KMIP KMS provider.

@api private

Constants

FORMAT_HINT

Attributes

endpoint[R]

@return [ String ] KMIP KMS endpoint with optional port.

Public Class Methods

new(opts) click to toggle source

Creates a KMIP KMS credentials object form a parameters hash.

@param [ Hash ] opts A hash that contains credentials for

KMIP KMS provider.

@option opts [ String ] :endpoint KMIP endpoint.

@raise [ ArgumentError ] If required options are missing or incorrectly

formatted.
# File lib/mongo/crypt/kms/kmip/credentials.rb, line 47
def initialize(opts)
  @opts = opts
  unless empty?
    @endpoint = validate_param(:endpoint, opts, FORMAT_HINT)
  end
end

Public Instance Methods

to_document() click to toggle source

Convert credentials object to a BSON document in libmongocrypt format.

@return [ BSON::Document ] Local KMS credentials in libmongocrypt format.

# File lib/mongo/crypt/kms/kmip/credentials.rb, line 57
def to_document
  return BSON::Document.new({}) if empty?
  BSON::Document.new({
    endpoint: endpoint,
  })
end