Interface EncryptionKey
public interface EncryptionKey
The
EncryptionKey
represents a Data Encryption Key reference that can be either direct via the
key id
or its Key Alternative Name
.- Since:
- 4.1
- Author:
- Christoph Strobl
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionstatic EncryptionKey
keyAltName
(String keyAltName) Create a newEncryptionKey
that uses an Key Alternative Name for reference.static EncryptionKey
keyId
(org.bson.BsonBinary key) Create a newEncryptionKey
that uses the keys id for reference.type()
value()
-
Method Details
-
keyId
Create a newEncryptionKey
that uses the keys id for reference.- Parameters:
key
- must not be null.- Returns:
- new instance of
KeyId
.
-
keyAltName
Create a newEncryptionKey
that uses an Key Alternative Name for reference.- Parameters:
keyAltName
- must not be null or empty.- Returns:
- new instance of
KeyAltName
.
-
value
Object value()- Returns:
- the value that allows to reference a specific key.
-
type
EncryptionKey.Type type()- Returns:
- the
EncryptionKey.Type
of reference.
-