Class: Mongo::Crypt::KMS::KMIP::Credentials Private

Inherits:
Object
  • Object
show all
Extended by:
Forwardable
Includes:
Validations
Defined in:
lib/mongo/crypt/kms/kmip/credentials.rb

Overview

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

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

Constant Summary collapse

FORMAT_HINT =

This constant is part of a private API. You should avoid using this constant if possible, as it may be removed or be changed in the future. 

"KMIP KMS provider options must be in the format: " +
"{ endpoint: 'ENDPOINT' }"

Instance Attribute Summary collapse

Instance Method Summary collapse

Methods included from Validations

#validate_param, validate_tls_options

Constructor Details

#initialize(opts) ⇒ Credentials

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Creates a KMIP KMS credentials object form a parameters hash.

Options Hash (opts):

  • :endpoint (String) —

    KMIP endpoint.

Raises:

  • (ArgumentError) —

    If required options are missing or incorrectly formatted.



47
48
49
50
51
52
 
# 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

Instance Attribute Details

#endpoint ⇒ String (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns KMIP KMS endpoint with optional port.



31
32
33
 
# File 'lib/mongo/crypt/kms/kmip/credentials.rb', line 31

def endpoint
  @endpoint
end

Instance Method Details

#to_document ⇒ BSON::Document

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Convert credentials object to a BSON document in libmongocrypt format.



57
58
59
60
61
62
 
# 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