Module spring.data.mongodb

Package org.springframework.data.mongodb.core

Class CollectionOptions.EncryptedFieldsOptions

java.lang.Object

org.springframework.data.mongodb.core.CollectionOptions.EncryptedFieldsOptions

Enclosing class:

CollectionOptions

public static class CollectionOptions.EncryptedFieldsOptions
extends Object

Encapsulation of Encryption options for collections.

Since:

4.5

Author:

Christoph Strobl

Method Summary

Modifier and Type	Method	Description
CollectionOptions.EncryptedFieldsOptions	encrypted(JsonSchemaProperty property, Object keyId)	Add a property that should be encrypted but not queryable.
static CollectionOptions.EncryptedFieldsOptions	fromProperties(List<? extends JsonSchemaProperty> properties)
static CollectionOptions.EncryptedFieldsOptions	fromSchema(MongoJsonSchema schema)
static CollectionOptions.EncryptedFieldsOptions	none()
CollectionOptions.EncryptedFieldsOptions	queryable(JsonSchemaProperty property, QueryCharacteristic... characteristics)	Add a new queryable property for the given source property.
org.bson.Document	toDocument()
CollectionOptions.EncryptedFieldsOptions	with(IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty property)	Add an encrypted property that should not be queryable.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Details

none

public static CollectionOptions.EncryptedFieldsOptions none()

Returns:

NONE

fromSchema

public static CollectionOptions.EncryptedFieldsOptions fromSchema(MongoJsonSchema schema)

Returns:

new instance of CollectionOptions.EncryptedFieldsOptions.

fromProperties

public static CollectionOptions.EncryptedFieldsOptions fromProperties(List<? extends JsonSchemaProperty> properties)

Returns:

new instance of CollectionOptions.EncryptedFieldsOptions.

queryable

@Contract("_, _ -> new")
@CheckReturnValue
public CollectionOptions.EncryptedFieldsOptions queryable(JsonSchemaProperty property,
 QueryCharacteristic... characteristics)

Add a new queryable property for the given source property.

Please note that, a given JsonSchemaProperty may override options from a given MongoJsonSchema if set.

Parameters:

property - the queryable source - typically encrypted.

characteristics - the query options to set.

Returns:

new instance of CollectionOptions.EncryptedFieldsOptions.

with

@Contract("_ -> new")
@CheckReturnValue
public CollectionOptions.EncryptedFieldsOptions with(IdentifiableJsonSchemaProperty.EncryptedJsonSchemaProperty property)

Add an encrypted property that should not be queryable.

Parameters:

property - must not be null.

Returns:

new instance of CollectionOptions.EncryptedFieldsOptions.

Since:

4.5.1

encrypted

@Contract("_, _ -> new")
@CheckReturnValue
public CollectionOptions.EncryptedFieldsOptions encrypted(JsonSchemaProperty property,
 @Nullable
 Object keyId)

Add a property that should be encrypted but not queryable.

Parameters:

property - must not be null.

keyId - the key identifier to be used, can be null.

Returns:

new instance of CollectionOptions.EncryptedFieldsOptions.

Since:

4.5.1

toDocument

public org.bson.Document toDocument()