Packages

c

org.mongodb.scala.vault

ClientEncryption

case class ClientEncryption(wrapped: com.mongodb.async.client.vault.ClientEncryption) extends Closeable with Product with Serializable

The Key vault.

Used to create data encryption keys, and to explicitly encrypt and decrypt values when auto-encryption is not an option.

Annotations
@Beta()
Since

2.7

Linear Supertypes
Serializable, Product, Equals, Closeable, AutoCloseable, AnyRef, Any
Type Hierarchy
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ClientEncryption
  2. Serializable
  3. Product
  4. Equals
  5. Closeable
  6. AutoCloseable
  7. AnyRef
  8. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ClientEncryption(wrapped: com.mongodb.async.client.vault.ClientEncryption)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  6. def close(): Unit
    Definition Classes
    ClientEncryption → Closeable → AutoCloseable
  7. def createDataKey(kmsProvider: String, dataKeyOptions: DataKeyOptions): SingleObservable[BsonBinary]

    Create a data key with the given KMS provider and options.

    Create a data key with the given KMS provider and options.

    Creates a new key document and inserts into the key vault collection.

    kmsProvider

    the KMS provider

    dataKeyOptions

    the options for data key creation

    returns

    a Publisher containing the identifier for the created data key

  8. def createDataKey(kmsProvider: String): SingleObservable[BsonBinary]

    Create a data key with the given KMS provider.

    Create a data key with the given KMS provider.

    Creates a new key document and inserts into the key vault collection.

    kmsProvider

    the KMS provider

    returns

    a Publisher containing the identifier for the created data key

  9. def decrypt(value: BsonBinary): SingleObservable[BsonValue]

    Decrypt the given value.

    Decrypt the given value.

    value

    the value to decrypt, which must be of subtype 6

    returns

    a Publisher containing the decrypted value

  10. def encrypt(value: BsonValue, options: EncryptOptions): SingleObservable[BsonBinary]

    Encrypt the given value with the given options.

    Encrypt the given value with the given options. The driver may throw an exception for prohibited BSON value types

    value

    the value to encrypt

    options

    the options for data encryption

    returns

    a Publisher containing the encrypted value, a BSON binary of subtype 6

  11. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  12. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  13. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  16. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  17. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  18. def productElementNames: Iterator[String]
    Definition Classes
    Product
  19. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  20. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  21. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  22. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()

Inherited from Serializable

Inherited from Product

Inherited from Equals

Inherited from Closeable

Inherited from AutoCloseable

Inherited from AnyRef

Inherited from Any

Ungrouped