Package com.mongodb.crypt.capi

Enum MongoCryptContext.State

java.lang.Object

java.lang.Enum<MongoCryptContext.State>

com.mongodb.crypt.capi.MongoCryptContext.State

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<MongoCryptContext.State>

Enclosing interface:

MongoCryptContext

public static enum MongoCryptContext.State
extends java.lang.Enum<MongoCryptContext.State>

The possible states.

Enum Constant Summary

Enum Constants

Enum Constant	Description
DONE	Done
NEED_KMS	Need the key management service
NEED_MONGO_COLLINFO	Needs collection information from the cluster encrypting to
NEED_MONGO_KEYS	Need keys from the key vault
NEED_MONGO_MARKINGS	Need to mark command with encryption markers
READY	Ready for encryption/decryption

Method Summary

Modifier and Type	Method	Description
static MongoCryptContext.State	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static MongoCryptContext.State[]	values()	Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

NEED_MONGO_COLLINFO

public static final MongoCryptContext.State NEED_MONGO_COLLINFO

Needs collection information from the cluster encrypting to

NEED_MONGO_MARKINGS

public static final MongoCryptContext.State NEED_MONGO_MARKINGS

Need to mark command with encryption markers

NEED_MONGO_KEYS

public static final MongoCryptContext.State NEED_MONGO_KEYS

Need keys from the key vault

NEED_KMS

public static final MongoCryptContext.State NEED_KMS

Need the key management service

READY

public static final MongoCryptContext.State READY

Ready for encryption/decryption

DONE

public static final MongoCryptContext.State DONE

Done

Method Detail

values

public static MongoCryptContext.State[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (MongoCryptContext.State c : MongoCryptContext.State.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static MongoCryptContext.State valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null