Class IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
java.lang.Object
org.springframework.data.mongodb.core.schema.IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
- All Implemented Interfaces:
JsonSchemaObject
,JsonSchemaProperty
- Enclosing class:
- IdentifiableJsonSchemaProperty<T extends JsonSchemaObject>
public static class IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
extends Object
implements JsonSchemaProperty
JsonSchemaProperty
implementation for encrypted fields.- Since:
- 2.2
- Author:
- Christoph Strobl
-
Nested Class Summary
Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaObject
JsonSchemaObject.Type
Nested classes/interfaces inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaProperty
JsonSchemaProperty.JsonSchemaPropertyBuilder
-
Constructor Summary
ConstructorDescriptionCreate new instance ofIdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
wrapping the giventarget
. -
Method Summary
Modifier and TypeMethodDescriptionUse AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic algorithm.Use AEAD_AES_256_CBC_HMAC_SHA_512-Random algorithm.Use the given algorithm identified via its name.encrypted
(JsonSchemaProperty target) Create new instance ofIdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
wrapping the giventarget
.The identifier can be either the property name or the regex expression properties have to match when used along withTypedJsonSchemaObject.ObjectJsonSchemaObject.patternProperties(JsonSchemaProperty...)
.getTypes()
Get the set of types defined for this schema element.
TheSet
is likely to contain only one element in most cases.org.bson.Document
Get the MongoDB specific representation.
The Document may contain fields (eg. like bsonType) not contained in the JsonSchema specification.Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface org.springframework.data.mongodb.core.schema.JsonSchemaProperty
isRequired
-
Constructor Details
-
EncryptedJsonSchemaProperty
Create new instance ofIdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
wrapping the giventarget
.- Parameters:
target
- must not be null.
-
-
Method Details
-
encrypted
public static IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty encrypted(JsonSchemaProperty target) Create new instance ofIdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
wrapping the giventarget
.- Parameters:
target
- must not be null.- Returns:
- new instance of
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
.
-
aead_aes_256_cbc_hmac_sha_512_random
public IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty aead_aes_256_cbc_hmac_sha_512_random()Use AEAD_AES_256_CBC_HMAC_SHA_512-Random algorithm.- Returns:
- new instance of
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
.
-
aead_aes_256_cbc_hmac_sha_512_deterministic
public IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty aead_aes_256_cbc_hmac_sha_512_deterministic()Use AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic algorithm.- Returns:
- new instance of
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
.
-
algorithm
Use the given algorithm identified via its name.- Returns:
- new instance of
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
.
-
keyId
- Parameters:
keyId
- must not be null.- Returns:
- new instance of
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
.
-
keys
- Parameters:
keyId
- must not be null.- Returns:
- new instance of
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
.
-
keys
- Parameters:
keyId
- must not be null.- Returns:
- new instance of
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty
.
-
toDocument
public org.bson.Document toDocument()Description copied from interface:JsonSchemaObject
Get the MongoDB specific representation.
The Document may contain fields (eg. like bsonType) not contained in the JsonSchema specification. It may also contain types not directly processable by the MongoDB java driver. Make sure to run the producedDocument
through the mapping infrastructure.- Specified by:
toDocument
in interfaceJsonSchemaObject
- Returns:
- never null.
-
getIdentifier
Description copied from interface:JsonSchemaProperty
The identifier can be either the property name or the regex expression properties have to match when used along withTypedJsonSchemaObject.ObjectJsonSchemaObject.patternProperties(JsonSchemaProperty...)
.- Specified by:
getIdentifier
in interfaceJsonSchemaProperty
- Returns:
- never null.
-
getTypes
Description copied from interface:JsonSchemaObject
Get the set of types defined for this schema element.
TheSet
is likely to contain only one element in most cases.- Specified by:
getTypes
in interfaceJsonSchemaObject
- Returns:
- never null.
-