DATAMONGO-1835 - Polishing.

Add JSON schema to collection creation using reactive API. Refactor MongoJsonSchema to interface with default implementations for JsonSchemaObject and Document-based schemas. Make fields final and methods static where possible.

Add minItems/maxItems/additionalItems properties to ArrayJsonSchemaProperty. Add missing overrides to NullJsonSchemaProperty.
Slightly rename methods for item/property counts. Add generics, Javadoc, minor tweaks.

Original pull request: #524.

Author: mp911de

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

@@ -15,6 +15,8 @@
  */
 package org.springframework.data.mongodb.core;
 
+import lombok.RequiredArgsConstructor;
+
 import java.util.Optional;
 
 import org.springframework.data.mongodb.core.query.Collation;
@@ -146,7 +148,8 @@ public CollectionOptions schema(@Nullable MongoJsonSchema schema) {
 	}
 
 	/**
-	 * Create new {@link CollectionOptions} with already given settings and {@code validationLevel} set to {@code off}.
+	 * Create new {@link CollectionOptions} with already given settings and {@code validationLevel} set to
+	 * {@link ValidationLevel#OFF}.
 	 *
 	 * @return new {@link CollectionOptions}.
 	 * @since 2.1
@@ -156,7 +159,8 @@ public CollectionOptions disableValidation() {
 	}
 
 	/**
-	 * Create new {@link CollectionOptions} with already given settings and {@code validationLevel} set to {@code strict}.
+	 * Create new {@link CollectionOptions} with already given settings and {@code validationLevel} set to
+	 * {@link ValidationLevel#STRICT}.
 	 *
 	 * @return new {@link CollectionOptions}.
 	 * @since 2.1
@@ -167,7 +171,7 @@ public CollectionOptions strictValidation() {
 
 	/**
 	 * Create new {@link CollectionOptions} with already given settings and {@code validationLevel} set to
-	 * {@code moderate}.
+	 * {@link ValidationLevel#MODERATE}.
 	 *
 	 * @return new {@link CollectionOptions}.
 	 * @since 2.1
@@ -177,7 +181,8 @@ public CollectionOptions moderateValidation() {
 	}
 
 	/**
-	 * Create new {@link CollectionOptions} with already given settings and {@code validationAction} set to {@code warn}.
+	 * Create new {@link CollectionOptions} with already given settings and {@code validationAction} set to
+	 * {@link ValidationAction#WARN}.
 	 *
 	 * @return new {@link CollectionOptions}.
 	 * @since 2.1
@@ -187,7 +192,8 @@ public CollectionOptions warnOnValidationError() {
 	}
 
 	/**
-	 * Create new {@link CollectionOptions} with already given settings and {@code validationAction} set to {@code error}.
+	 * Create new {@link CollectionOptions} with already given settings and {@code validationAction} set to
+	 * {@link ValidationAction#ERROR}.
 	 *
 	 * @return new {@link CollectionOptions}.
 	 * @since 2.1
@@ -291,25 +297,18 @@ public Optional<Validator> getValidator() {
 	 * @author Christoph Strobl
 	 * @since 2.1
 	 */
+	@RequiredArgsConstructor
 	public static class Validator {
 
 		private static final Validator NONE = new Validator(null, null, null);
 
-		private @Nullable MongoJsonSchema schema;
-		private @Nullable ValidationLevel validationLevel;
-		private @Nullable ValidationAction validationAction;
-
-		private Validator(@Nullable MongoJsonSchema schema, @Nullable ValidationLevel validationLevel,
-				@Nullable ValidationAction validationAction) {
-
-			this.schema = schema;
-			this.validationLevel = validationLevel;
-			this.validationAction = validationAction;
-		}
+		private final @Nullable MongoJsonSchema schema;
+		private final @Nullable ValidationLevel validationLevel;
+		private final @Nullable ValidationAction validationAction;
 
 		/**
 		 * Create an empty {@link Validator}.
-		 * 
+		 *
 		 * @return never {@literal null}.
 		 */
 		public static Validator none() {
@@ -321,7 +320,6 @@ public static Validator none() {
 		 *
 		 * @return {@link Optional#empty()} if not set.
 		 */
-		@Nullable
 		public Optional<MongoJsonSchema> getSchema() {
 			return Optional.ofNullable(schema);
 		}
@@ -331,7 +329,6 @@ public Optional<MongoJsonSchema> getSchema() {
 		 *
 		 * @return {@link Optional#empty()} if not set.
 		 */
-		@Nullable
 		public Optional<ValidationLevel> getValidationLevel() {
 			return Optional.ofNullable(validationLevel);
 		}
@@ -341,7 +338,6 @@ public Optional<ValidationLevel> getValidationLevel() {
 		 *
 		 * @return @return {@link Optional#empty()} if not set.
 		 */
-		@Nullable
 		public Optional<ValidationAction> getValidationAction() {
 			return Optional.ofNullable(validationAction);
 		}

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

@@ -124,6 +124,9 @@
 import org.springframework.util.ResourceUtils;
 import org.springframework.util.StringUtils;
 
+import com.mongodb.DBCollection;
+import com.mongodb.DBCursor;
+import com.mongodb.Mongo;
 import com.mongodb.MongoClient;
 import com.mongodb.MongoException;
 import com.mongodb.ReadPreference;
@@ -2370,7 +2373,7 @@ protected Document convertToDocument(@Nullable CollectionOptions collectionOptio
 
 		Document doc = convertToDocument(collectionOptions);
 
-		if (collectionOptions.getValidator().isPresent()) {
+		if (collectionOptions != null && collectionOptions.getValidator().isPresent()) {
 			Validator v = collectionOptions.getValidator().get();
 			v.getSchema().ifPresent(val -> doc.put("validator", schemaMapper.mapSchema(val.toDocument(), targetType)));
 		}

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

@@ -69,15 +69,7 @@
 import org.springframework.data.mongodb.core.aggregation.AggregationOptions;
 import org.springframework.data.mongodb.core.aggregation.TypeBasedAggregationOperationContext;
 import org.springframework.data.mongodb.core.aggregation.TypedAggregation;
-import org.springframework.data.mongodb.core.convert.DbRefProxyHandler;
-import org.springframework.data.mongodb.core.convert.DbRefResolver;
-import org.springframework.data.mongodb.core.convert.DbRefResolverCallback;
-import org.springframework.data.mongodb.core.convert.MappingMongoConverter;
-import org.springframework.data.mongodb.core.convert.MongoConverter;
-import org.springframework.data.mongodb.core.convert.MongoCustomConversions;
-import org.springframework.data.mongodb.core.convert.MongoWriter;
-import org.springframework.data.mongodb.core.convert.QueryMapper;
-import org.springframework.data.mongodb.core.convert.UpdateMapper;
+import org.springframework.data.mongodb.core.convert.*;
 import org.springframework.data.mongodb.core.index.IndexOperationsAdapter;
 import org.springframework.data.mongodb.core.index.MongoMappingEventPublisher;
 import org.springframework.data.mongodb.core.index.MongoPersistentEntityIndexCreator;
@@ -125,6 +117,7 @@
 import com.mongodb.client.model.FindOneAndUpdateOptions;
 import com.mongodb.client.model.ReturnDocument;
 import com.mongodb.client.model.UpdateOptions;
+import com.mongodb.client.model.ValidationOptions;
 import com.mongodb.client.result.DeleteResult;
 import com.mongodb.client.result.UpdateResult;
 import com.mongodb.reactivestreams.client.AggregatePublisher;
@@ -176,6 +169,7 @@ public class ReactiveMongoTemplate implements ReactiveMongoOperations, Applicati
 	private final PersistenceExceptionTranslator exceptionTranslator;
 	private final QueryMapper queryMapper;
 	private final UpdateMapper updateMapper;
+	private final JsonSchemaMapper schemaMapper;
 	private final SpelAwareProxyProjectionFactory projectionFactory;
 
 	private @Nullable WriteConcern writeConcern;
@@ -220,6 +214,7 @@ public ReactiveMongoTemplate(ReactiveMongoDatabaseFactory mongoDatabaseFactory,
 		this.mongoConverter = mongoConverter == null ? getDefaultMongoConverter() : mongoConverter;
 		this.queryMapper = new QueryMapper(this.mongoConverter);
 		this.updateMapper = new UpdateMapper(this.mongoConverter);
+		this.schemaMapper = new MongoJsonSchemaMapper(this.mongoConverter);
 		this.projectionFactory = new SpelAwareProxyProjectionFactory();
 
 		// We always have a mapping context in the converter, whether it's a simple one or not
@@ -486,23 +481,24 @@ public <T> Mono<MongoCollection<Document>> createCollection(Class<T> entityClass
 	 */
 	public <T> Mono<MongoCollection<Document>> createCollection(Class<T> entityClass,
 			@Nullable CollectionOptions collectionOptions) {
-		return createCollection(determineCollectionName(entityClass), collectionOptions);
+		return doCreateCollection(determineCollectionName(entityClass),
+				convertToCreateCollectionOptions(collectionOptions, entityClass));
 	}
 
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.core.ReactiveMongoOperations#createCollection(java.lang.String)
 	 */
-	public Mono<MongoCollection<Document>> createCollection(final String collectionName) {
+	public Mono<MongoCollection<Document>> createCollection(String collectionName) {
 		return doCreateCollection(collectionName, new CreateCollectionOptions());
 	}
 
 	/*
 	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.core.ReactiveMongoOperations#createCollection(java.lang.String, org.springframework.data.mongodb.core.CollectionOptions)
 	 */
-	public Mono<MongoCollection<Document>> createCollection(final String collectionName,
-			final CollectionOptions collectionOptions) {
+	public Mono<MongoCollection<Document>> createCollection(String collectionName,
+			@Nullable CollectionOptions collectionOptions) {
 		return doCreateCollection(collectionName, convertToCreateCollectionOptions(collectionOptions));
 	}
 
@@ -814,8 +810,7 @@ protected <O> Flux<O> aggregate(Aggregation aggregation, String collectionName,
 		}
 
 		ReadDocumentCallback<O> readCallback = new ReadDocumentCallback<>(mongoConverter, outputType, collectionName);
-		return execute(collectionName,
-				collection -> aggregateAndMap(collection, pipeline, options, readCallback));
+		return execute(collectionName, collection -> aggregateAndMap(collection, pipeline, options, readCallback));
 	}
 
 	private <O> Flux<O> aggregateAndMap(MongoCollection<Document> collection, List<Document> pipeline,
@@ -1995,17 +1990,36 @@ private Document addFieldsForProjection(Document fields, Class<?> domainType, Cl
 	}
 
 	protected CreateCollectionOptions convertToCreateCollectionOptions(@Nullable CollectionOptions collectionOptions) {
+		return convertToCreateCollectionOptions(collectionOptions, Object.class);
+	}
 
-		CreateCollectionOptions result = new CreateCollectionOptions();
+	protected CreateCollectionOptions convertToCreateCollectionOptions(@Nullable CollectionOptions collectionOptions,
+			Class<?> entityType) {
 
-		if (collectionOptions != null) {
+		CreateCollectionOptions result = new CreateCollectionOptions();
 
-			collectionOptions.getCapped().ifPresent(result::capped);
-			collectionOptions.getSize().ifPresent(result::sizeInBytes);
-			collectionOptions.getMaxDocuments().ifPresent(result::maxDocuments);
-			collectionOptions.getCollation().map(Collation::toMongoCollation).ifPresent(result::collation);
+		if (collectionOptions == null) {
+			return result;
 		}
 
+		collectionOptions.getCapped().ifPresent(result::capped);
+		collectionOptions.getSize().ifPresent(result::sizeInBytes);
+		collectionOptions.getMaxDocuments().ifPresent(result::maxDocuments);
+		collectionOptions.getCollation().map(Collation::toMongoCollation).ifPresent(result::collation);
+
+		collectionOptions.getValidator().ifPresent(it -> {
+
+			ValidationOptions validationOptions = new ValidationOptions();
+
+			it.getValidationAction().ifPresent(validationOptions::validationAction);
+			it.getValidationLevel().ifPresent(validationOptions::validationLevel);
+
+			it.getSchema()
+					.ifPresent(val -> validationOptions.validator(schemaMapper.mapSchema(val.toDocument(), entityType)));
+
+			result.validationOptions(validationOptions);
+		});
+
 		return result;
 	}
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/convert/MongoJsonSchemaMapper.java

@@ -34,6 +34,7 @@
  * provided domain type.
  *
  * @author Christoph Strobl
+ * @author Mark Paluch
  * @since 2.1
  */
 public class MongoJsonSchemaMapper implements JsonSchemaMapper {
@@ -60,7 +61,7 @@ public MongoJsonSchemaMapper(MongoConverter converter) {
 	}
 
 	/*
-	 * (non-Javadoc) 
+	 * (non-Javadoc)
 	 * @see org.springframework.data.mongodb.core.convert.JsonSchemaMapper#mapSchema(org.springframework.data.mongodb.core.schema.MongoJsonSchema, java.lang.Class)
 	 */
 	public Document mapSchema(Document jsonSchema, Class<?> type) {
@@ -78,7 +79,8 @@ public Document mapSchema(Document jsonSchema, Class<?> type) {
 				mapSchemaObject(mappingContext.getPersistentEntity(type), jsonSchema.get($JSON_SCHEMA, Document.class)));
 	}
 
-	private Document mapSchemaObject(@Nullable PersistentEntity entity, Document source) {
+	@SuppressWarnings("unchecked")
+	private Document mapSchemaObject(@Nullable PersistentEntity<?, MongoPersistentProperty> entity, Document source) {
 
 		Document sink = new Document(source);
 

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/schema/DefaultMongoJsonSchema.java

@@ -0,0 +1,43 @@
+/*
+ * Copyright 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.mongodb.core.schema;
+
+import lombok.AllArgsConstructor;
+import lombok.NonNull;
+
+import org.bson.Document;
+
+/**
+ * Value object representing a MongoDB-specific JSON schema which is the default {@link MongoJsonSchema} implementation.
+ *
+ * @author Christoph Strobl
+ * @author Mark Paluch
+ * @since 2.1
+ */
+@AllArgsConstructor
+class DefaultMongoJsonSchema implements MongoJsonSchema {
+
+	private final @NonNull JsonSchemaObject root;
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.schema.MongoJsonSchema#toDocument()
+	 */
+	@Override
+	public Document toDocument() {
+		return new Document("$jsonSchema", root.toDocument());
+	}
+}

spring-data-mongodb/src/main/java/org/springframework/data/mongodb/core/schema/DocumentJsonSchema.java

@@ -0,0 +1,42 @@
+/*
+ * Copyright 2018 the original author or authors.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *      http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.springframework.data.mongodb.core.schema;
+
+import lombok.AllArgsConstructor;
+import lombok.NonNull;
+
+import org.bson.Document;
+
+/**
+ * JSON schema backed by a {@link org.bson.Document} object.
+ *
+ * @author Mark Paluch
+ * @since 2.1
+ */
+@AllArgsConstructor
+class DocumentJsonSchema implements MongoJsonSchema {
+
+	private final @NonNull Document document;
+
+	/*
+	 * (non-Javadoc)
+	 * @see org.springframework.data.mongodb.core.schema.MongoJsonSchema#toDocument()
+	 */
+	@Override
+	public Document toDocument() {
+		return new Document("$jsonSchema", new Document(document));
+	}
+}