Package org.springframework.data.mongodb.core.schema

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

Constructors

Constructor	Description
EncryptedJsonSchemaProperty(JsonSchemaProperty target)	Create new instance of IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty wrapping the given target.

Method Summary

Modifier and Type	Method	Description
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty	aead_aes_256_cbc_hmac_sha_512_deterministic()	Use AEAD_AES_256_CBC_HMAC_SHA_512-Deterministic algorithm.
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty	aead_aes_256_cbc_hmac_sha_512_random()	Use AEAD_AES_256_CBC_HMAC_SHA_512-Random algorithm.
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty	algorithm(String algorithm)	Use the given algorithm identified via its name.
static IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty	encrypted(JsonSchemaProperty target)	Create new instance of IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty wrapping the given target.
String	getIdentifier()	The identifier can be either the property name or the regex expression properties have to match when used along with TypedJsonSchemaObject.ObjectJsonSchemaObject.patternProperties(JsonSchemaProperty...).
Set<JsonSchemaObject.Type>	getTypes()	Get the set of types defined for this schema element. The Set is likely to contain only one element in most cases.
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty	keyId(String keyId)
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty	keys(Object... keyId)
IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty	keys(UUID... keyId)
org.bson.Document	toDocument()	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

public EncryptedJsonSchemaProperty(JsonSchemaProperty target)

Create new instance of IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty wrapping the given target.

Parameters:

target - must not be null.

Method Details

encrypted

public static IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty encrypted(JsonSchemaProperty target)

Create new instance of IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty wrapping the given target.

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

public IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty algorithm(String algorithm)

Use the given algorithm identified via its name.

Returns:

new instance of IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty.

keyId

public IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty keyId(String keyId)

Parameters:

keyId - must not be null.

Returns:

new instance of IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty.

keys

public IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty keys(UUID... keyId)

Parameters:

keyId - must not be null.

Returns:

new instance of IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty.

keys

public IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty keys(Object... keyId)

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 produced Document through the mapping infrastructure.

Specified by:

toDocument in interface JsonSchemaObject

Returns:

never null.

getIdentifier

public String 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 with TypedJsonSchemaObject.ObjectJsonSchemaObject.patternProperties(JsonSchemaProperty...).

Specified by:

getIdentifier in interface JsonSchemaProperty

Returns:

never null.

getTypes

public Set<JsonSchemaObject.Type> getTypes()

Description copied from interface: JsonSchemaObject

Get the set of types defined for this schema element.
The Set is likely to contain only one element in most cases.

Specified by:

getTypes in interface JsonSchemaObject

Returns:

never null.