Browse Source

DATAMONGO-1322 - Polishing.

Convert lineendings from CRLF to LF. Reduce validator implementations visibility to package. Extend Javadoc. Slight rewording in reference documentation.

Original pull request: #525.
Related pull request: #511.
Related ticket: DATACMNS-1835.
pull/527/head
Mark Paluch 8 years ago
parent
commit
c3dbce4d9e
  1. 2
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CollectionOptions.java
  2. 35
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java
  3. 5
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ReactiveMongoTemplate.java
  4. 6
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/validation/CriteriaValidator.java
  5. 9
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/validation/DocumentValidator.java
  6. 16
      spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/validation/JsonSchemaValidator.java
  7. 5
      spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/MongoTemplateValidationTests.java
  8. 2
      spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/validation/CriteriaValidatorUnitTests.java
  9. 2
      src/main/asciidoc/reference/mongo-3.adoc

2
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/CollectionOptions.java

@ -150,7 +150,7 @@ public class CollectionOptions {
} }
/** /**
* /** Create new {@link CollectionOptions} with already given settings and {@code validationOptions} set to given * Create new {@link CollectionOptions} with already given settings and {@code validationOptions} set to given
* {@link Validator}. * {@link Validator}.
* *
* @param validator can be {@literal null}. * @param validator can be {@literal null}.

35
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/MongoTemplate.java

@ -63,7 +63,6 @@ import org.springframework.data.mapping.context.MappingContext;
import org.springframework.data.mapping.model.ConvertingPropertyAccessor; import org.springframework.data.mapping.model.ConvertingPropertyAccessor;
import org.springframework.data.mongodb.MongoDbFactory; import org.springframework.data.mongodb.MongoDbFactory;
import org.springframework.data.mongodb.core.BulkOperations.BulkMode; import org.springframework.data.mongodb.core.BulkOperations.BulkMode;
import org.springframework.data.mongodb.core.CollectionOptions.ValidationOptions;
import org.springframework.data.mongodb.core.DefaultBulkOperations.BulkOperationContext; import org.springframework.data.mongodb.core.DefaultBulkOperations.BulkOperationContext;
import org.springframework.data.mongodb.core.aggregation.Aggregation; import org.springframework.data.mongodb.core.aggregation.Aggregation;
import org.springframework.data.mongodb.core.aggregation.AggregationOperationContext; import org.springframework.data.mongodb.core.aggregation.AggregationOperationContext;
@ -108,7 +107,6 @@ import org.springframework.data.mongodb.core.query.Meta;
import org.springframework.data.mongodb.core.query.NearQuery; import org.springframework.data.mongodb.core.query.NearQuery;
import org.springframework.data.mongodb.core.query.Query; import org.springframework.data.mongodb.core.query.Query;
import org.springframework.data.mongodb.core.query.Update; import org.springframework.data.mongodb.core.query.Update;
import org.springframework.data.mongodb.core.validation.JsonSchemaValidator;
import org.springframework.data.mongodb.core.validation.Validator; import org.springframework.data.mongodb.core.validation.Validator;
import org.springframework.data.mongodb.util.MongoClientVersion; import org.springframework.data.mongodb.util.MongoClientVersion;
import org.springframework.data.projection.ProjectionInformation; import org.springframework.data.projection.ProjectionInformation;
@ -141,16 +139,7 @@ import com.mongodb.client.MongoCollection;
import com.mongodb.client.MongoCursor; import com.mongodb.client.MongoCursor;
import com.mongodb.client.MongoDatabase; import com.mongodb.client.MongoDatabase;
import com.mongodb.client.MongoIterable; import com.mongodb.client.MongoIterable;
import com.mongodb.client.model.CountOptions; import com.mongodb.client.model.*;
import com.mongodb.client.model.CreateCollectionOptions;
import com.mongodb.client.model.DeleteOptions;
import com.mongodb.client.model.Filters;
import com.mongodb.client.model.FindOneAndDeleteOptions;
import com.mongodb.client.model.FindOneAndUpdateOptions;
import com.mongodb.client.model.ReturnDocument;
import com.mongodb.client.model.UpdateOptions;
import com.mongodb.client.model.ValidationAction;
import com.mongodb.client.model.ValidationLevel;
import com.mongodb.client.result.DeleteResult; import com.mongodb.client.result.DeleteResult;
import com.mongodb.client.result.UpdateResult; import com.mongodb.client.result.UpdateResult;
import com.mongodb.util.JSONParseException; import com.mongodb.util.JSONParseException;
@ -2385,11 +2374,12 @@ public class MongoTemplate implements MongoOperations, ApplicationContextAware,
Document doc = convertToDocument(collectionOptions); Document doc = convertToDocument(collectionOptions);
if (collectionOptions != null && collectionOptions.getValidationOptions().isPresent()) { if (collectionOptions != null) {
ValidationOptions v = collectionOptions.getValidationOptions().get(); collectionOptions.getValidationOptions().ifPresent(it -> it.getValidator() //
v.getValidator().ifPresent(val -> doc.put("validator", getMappedValidator(val, targetType))); .ifPresent(val -> doc.put("validator", getMappedValidator(val, targetType))));
} }
return doc; return doc;
} }
@ -2402,6 +2392,7 @@ public class MongoTemplate implements MongoOperations, ApplicationContextAware,
protected Document convertToDocument(@Nullable CollectionOptions collectionOptions) { protected Document convertToDocument(@Nullable CollectionOptions collectionOptions) {
Document document = new Document(); Document document = new Document();
if (collectionOptions != null) { if (collectionOptions != null) {
collectionOptions.getCapped().ifPresent(val -> document.put("capped", val)); collectionOptions.getCapped().ifPresent(val -> document.put("capped", val));
@ -2409,14 +2400,14 @@ public class MongoTemplate implements MongoOperations, ApplicationContextAware,
collectionOptions.getMaxDocuments().ifPresent(val -> document.put("max", val)); collectionOptions.getMaxDocuments().ifPresent(val -> document.put("max", val));
collectionOptions.getCollation().ifPresent(val -> document.append("collation", val.toDocument())); collectionOptions.getCollation().ifPresent(val -> document.append("collation", val.toDocument()));
if (collectionOptions.getValidationOptions().isPresent()) { collectionOptions.getValidationOptions().ifPresent(it -> {
CollectionOptions.ValidationOptions v = collectionOptions.getValidationOptions().get(); it.getValidationLevel().ifPresent(val -> document.append("validationLevel", val.getValue()));
v.getValidationLevel().ifPresent(val -> document.append("validationLevel", val.getValue())); it.getValidationAction().ifPresent(val -> document.append("validationAction", val.getValue()));
v.getValidationAction().ifPresent(val -> document.append("validationAction", val.getValue())); it.getValidator().ifPresent(val -> document.append("validator", getMappedValidator(val, Object.class)));
v.getValidator().ifPresent(val -> document.append("validator", getMappedValidator(val, Object.class))); });
}
} }
return document; return document;
} }
@ -2424,7 +2415,7 @@ public class MongoTemplate implements MongoOperations, ApplicationContextAware,
Document validationRules = validator.toDocument(); Document validationRules = validator.toDocument();
if (validator instanceof JsonSchemaValidator || validationRules.containsKey("$jsonSchema")) { if (validationRules.containsKey("$jsonSchema")) {
return schemaMapper.mapSchema(validationRules, domainType); return schemaMapper.mapSchema(validationRules, domainType);
} }

5
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/ReactiveMongoTemplate.java

@ -100,7 +100,6 @@ import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.query.NearQuery; import org.springframework.data.mongodb.core.query.NearQuery;
import org.springframework.data.mongodb.core.query.Query; import org.springframework.data.mongodb.core.query.Query;
import org.springframework.data.mongodb.core.query.Update; import org.springframework.data.mongodb.core.query.Update;
import org.springframework.data.mongodb.core.validation.JsonSchemaValidator;
import org.springframework.data.mongodb.core.validation.Validator; import org.springframework.data.mongodb.core.validation.Validator;
import org.springframework.data.mongodb.util.MongoClientVersion; import org.springframework.data.mongodb.util.MongoClientVersion;
import org.springframework.data.projection.ProjectionInformation; import org.springframework.data.projection.ProjectionInformation;
@ -2033,11 +2032,11 @@ public class ReactiveMongoTemplate implements ReactiveMongoOperations, Applicati
return result; return result;
} }
Document getMappedValidator(Validator validator, Class<?> domainType) { private Document getMappedValidator(Validator validator, Class<?> domainType) {
Document validationRules = validator.toDocument(); Document validationRules = validator.toDocument();
if (validator instanceof JsonSchemaValidator || validationRules.containsKey("$jsonSchema")) { if (validationRules.containsKey("$jsonSchema")) {
return schemaMapper.mapSchema(validationRules, domainType); return schemaMapper.mapSchema(validationRules, domainType);
} }

6
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/validation/CriteriaValidator.java

@ -36,7 +36,7 @@ import org.springframework.util.Assert;
*/ */
@RequiredArgsConstructor(access = AccessLevel.PRIVATE) @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
@EqualsAndHashCode @EqualsAndHashCode
public class CriteriaValidator implements Validator { class CriteriaValidator implements Validator {
private final CriteriaDefinition criteria; private final CriteriaDefinition criteria;
@ -48,9 +48,10 @@ public class CriteriaValidator implements Validator {
* @return new instance of {@link CriteriaValidator}. * @return new instance of {@link CriteriaValidator}.
* @throws IllegalArgumentException when criteria is {@literal null}. * @throws IllegalArgumentException when criteria is {@literal null}.
*/ */
public static CriteriaValidator of(CriteriaDefinition criteria) { static CriteriaValidator of(CriteriaDefinition criteria) {
Assert.notNull(criteria, "Criteria must not be null!"); Assert.notNull(criteria, "Criteria must not be null!");
return new CriteriaValidator(criteria); return new CriteriaValidator(criteria);
} }
@ -71,5 +72,4 @@ public class CriteriaValidator implements Validator {
public String toString() { public String toString() {
return SerializationUtils.serializeToJsonSafely(toDocument()); return SerializationUtils.serializeToJsonSafely(toDocument());
} }
} }

9
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/validation/DocumentValidator.java

@ -28,25 +28,26 @@ import org.springframework.util.Assert;
* which can be either a {@code $jsonSchema} or query expression. * which can be either a {@code $jsonSchema} or query expression.
* *
* @author Christoph Strobl * @author Christoph Strobl
* @author Mark Paluch
* @since 2.1 * @since 2.1
* @see <a href="https://docs.mongodb.com/manual/core/schema-validation/">Schema Validation</a> * @see <a href="https://docs.mongodb.com/manual/core/schema-validation/">Schema Validation</a>
*/ */
@RequiredArgsConstructor(access = AccessLevel.PRIVATE) @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
@EqualsAndHashCode @EqualsAndHashCode
public class DocumentValidator implements Validator { class DocumentValidator implements Validator {
private final Document validatorObject; private final Document validatorObject;
/** /**
* Create new {@link org.springframework.data.mongodb.core.validation.DocumentValidator} defining validation rules via * Create new {@link DocumentValidator} defining validation rules via a plain {@link Document}.
* a plain {@link Document}.
* *
* @param validatorObject must not be {@literal null}. * @param validatorObject must not be {@literal null}.
* @throws IllegalArgumentException if validatorObject is {@literal null}. * @throws IllegalArgumentException if validatorObject is {@literal null}.
*/ */
public static DocumentValidator of(Document validatorObject) { static DocumentValidator of(Document validatorObject) {
Assert.notNull(validatorObject, "ValidatorObject must not be null!"); Assert.notNull(validatorObject, "ValidatorObject must not be null!");
return new DocumentValidator(new Document(validatorObject)); return new DocumentValidator(new Document(validatorObject));
} }

16
spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/validation/JsonSchemaValidator.java

@ -28,23 +28,27 @@ import org.springframework.util.Assert;
* {@link Validator} implementation based on {@link MongoJsonSchema JSON Schema}. * {@link Validator} implementation based on {@link MongoJsonSchema JSON Schema}.
* *
* @author Christoph Strobl * @author Christoph Strobl
* @author Mark Paluch
* @since 2.1 * @since 2.1
* @see <a href="https://docs.mongodb.com/manual/core/schema-validation/#json-schema">Schema Validation</a> * @see <a href="https://docs.mongodb.com/manual/core/schema-validation/#json-schema">Schema Validation</a>
*/ */
@RequiredArgsConstructor(access = AccessLevel.PRIVATE) @RequiredArgsConstructor(access = AccessLevel.PRIVATE)
@EqualsAndHashCode @EqualsAndHashCode
public class JsonSchemaValidator implements Validator { class JsonSchemaValidator implements Validator {
private final MongoJsonSchema schema; private final MongoJsonSchema schema;
public static JsonSchemaValidator of(MongoJsonSchema schema) { /**
* Create new {@link JsonSchemaValidator} defining validation rules via {@link MongoJsonSchema}.
*
* @param schema must not be {@literal null}.
* @throws IllegalArgumentException if schema is {@literal null}.
*/
static JsonSchemaValidator of(MongoJsonSchema schema) {
Assert.notNull(schema, "Schema must not be null!"); Assert.notNull(schema, "Schema must not be null!");
return new JsonSchemaValidator(schema);
}
public MongoJsonSchema getSchema() { return new JsonSchemaValidator(schema);
return schema;
} }
/* /*

5
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/MongoTemplateValidationTests.java

@ -36,7 +36,6 @@ import org.springframework.data.mongodb.config.AbstractMongoConfiguration;
import org.springframework.data.mongodb.core.CollectionOptions.ValidationOptions; import org.springframework.data.mongodb.core.CollectionOptions.ValidationOptions;
import org.springframework.data.mongodb.core.mapping.Field; import org.springframework.data.mongodb.core.mapping.Field;
import org.springframework.data.mongodb.core.query.Criteria; import org.springframework.data.mongodb.core.query.Criteria;
import org.springframework.data.mongodb.core.validation.DocumentValidator;
import org.springframework.data.mongodb.test.util.MongoVersionRule; import org.springframework.data.mongodb.test.util.MongoVersionRule;
import org.springframework.data.util.Version; import org.springframework.data.util.Version;
import org.springframework.lang.Nullable; import org.springframework.lang.Nullable;
@ -48,7 +47,8 @@ import com.mongodb.client.model.ValidationLevel;
/** /**
* Integration tests for {@link CollectionOptions#validation(ValidationOptions)} using * Integration tests for {@link CollectionOptions#validation(ValidationOptions)} using
* {@link org.springframework.data.mongodb.core.validation.CriteriaValidator} and {@link DocumentValidator}. * {@link org.springframework.data.mongodb.core.validation.CriteriaValidator} and
* {@link org.springframework.data.mongodb.core.validation.DocumentValidator}.
* *
* @author Andreas Zink * @author Andreas Zink
* @author Christoph Strobl * @author Christoph Strobl
@ -212,5 +212,4 @@ public class MongoTemplateValidationTests {
private @Nullable Integer rangedInteger; private @Nullable Integer rangedInteger;
private @Field("customName") Object customFieldName; private @Field("customName") Object customFieldName;
} }
} }

2
spring-data-mongodb/src/test/java/org/springframework/data/mongodb/core/validation/CriteriaValidatorUnitTests.java

@ -15,7 +15,7 @@
*/ */
package org.springframework.data.mongodb.core.validation; package org.springframework.data.mongodb.core.validation;
import static org.assertj.core.api.Assertions.assertThat; import static org.assertj.core.api.Assertions.*;
import org.bson.Document; import org.bson.Document;
import org.junit.Test; import org.junit.Test;

2
src/main/asciidoc/reference/mongo-3.adoc

@ -99,7 +99,7 @@ Spring Data MongoDB supports MongoDB's specific JSON schema implementation to de
[[mongo.mongo-3.validation.query-expression]] [[mongo.mongo-3.validation.query-expression]]
==== Query Expression Validation ==== Query Expression Validation
Next to the <<mongo.mongo-3.validation.json-schema>> as of version 3.2 MongoDB supports validating documents against a given query structure. The structure can be built using `Criteria` objects just the same way as they are used for defining queries. Next to the <<mongo.mongo-3.validation.json-schema>>, MongoDB supports as of version 3.2 validating documents against a given structure described by a query. The structure can be built using `Criteria` objects just the same way as they are used for defining queries.
[source,java] [source,java]
---- ----

Loading…
Cancel
Save