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
static CollectionOptions.EncryptedFieldsOptions	fromProperties(List<IdentifiableJsonSchemaProperty.QueryableJsonSchemaProperty> 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()

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<IdentifiableJsonSchemaProperty.QueryableJsonSchemaProperty> 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.

toDocument

public org.bson.Document toDocument()