json validation

Author: marko-bekhta

engine/pom.xml

@@ -103,7 +103,11 @@
             <artifactId>money-api</artifactId>
             <optional>true</optional>
         </dependency>
-
+        <dependency>
+            <groupId>javax.json</groupId>
+            <artifactId>javax.json-api</artifactId>
+            <optional>true</optional>
+        </dependency>
         <!--
         Test dependencies
         -->
@@ -147,6 +151,11 @@
             <artifactId>moneta</artifactId>
             <scope>test</scope>
         </dependency>
+        <dependency>
+            <groupId>org.glassfish</groupId>
+            <artifactId>javax.json</artifactId>
+            <scope>test</scope>
+        </dependency>
     </dependencies>
 
     <build>

engine/src/main/java/org/hibernate/validator/HibernateFreeFormValidator.java

@@ -0,0 +1,23 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator;
+
+import java.util.Set;
+
+import javax.json.JsonObject;
+import javax.validation.ConstraintViolation;
+
+/**
+ * An interface for validating objects like JSON or Map.
+ *
+ * @author Marko Bekhta
+ */
+@Incubating
+public interface HibernateFreeFormValidator {
+
+	Set<ConstraintViolation<JsonObject>> validateJson(JsonObject json, Class<?> typeToValidate, Class<?>... groups);
+}

engine/src/main/java/org/hibernate/validator/HibernateValidatorConfiguration.java

@@ -18,6 +18,7 @@
 import javax.validation.valueextraction.ValueExtractor;
 
 import org.hibernate.validator.cfg.ConstraintMapping;
+import org.hibernate.validator.cfg.json.JsonConstraintMapping;
 import org.hibernate.validator.constraints.ParameterScriptAssert;
 import org.hibernate.validator.constraints.ScriptAssert;
 import org.hibernate.validator.spi.properties.GetterPropertyMatcher;
@@ -333,4 +334,9 @@ public interface HibernateValidatorConfiguration extends Configuration<Hibernate
 	 */
 	@Incubating
 	HibernateValidatorConfiguration getterPropertyMatcher(GetterPropertyMatcher getterPropertyMatcher);
+
+	@Incubating
+	HibernateValidatorConfiguration addJsonMapping(JsonConstraintMapping mapping);
+
+	JsonConstraintMapping createJsonConstraintMapping();
 }

engine/src/main/java/org/hibernate/validator/cfg/json/Cascadable.java

@@ -0,0 +1,33 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.cfg.json;
+
+/**
+ * Facet of a constraint mapping creational context which allows to mark the underlying
+ * element as to be validated in a cascaded way.
+ *
+ * @author Gunnar Morling
+ * @author Kevin Pollet &lt;kevin.pollet@serli.com&gt; (C) 2011 SERLI
+ */
+public interface Cascadable<C extends Cascadable<C>> {
+
+	/**
+	 * Marks the current element (property, parameter etc.) as cascadable.
+	 *
+	 * @return The current creational context following the method chaining pattern.
+	 */
+	C valid();
+
+	/**
+	 * Adds a group conversion for this cascadable element. Several conversions may be configured for one element.
+	 *
+	 * @param from the source group of the conversion to be configured
+	 *
+	 * @return a creational context allow to set the target group of the conversion
+	 */
+	GroupConversionTargetContext<C> convertGroup(Class<?> from);
+}

engine/src/main/java/org/hibernate/validator/cfg/json/Constrainable.java

@@ -0,0 +1,27 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.cfg.json;
+
+import org.hibernate.validator.cfg.ConstraintDef;
+
+/**
+ * Facet of a constraint mapping creational context which allows to place
+ * constraints on the underlying element.
+ *
+ * @author Gunnar Morling
+ * @author Kevin Pollet &lt;kevin.pollet@serli.com&gt; (C) 2011 SERLI
+ */
+public interface Constrainable<C extends Constrainable<C>> {
+	/**
+	 * Adds a new constraint.
+	 *
+	 * @param definition The constraint to add.
+	 *
+	 * @return The current creational context following the method chaining pattern.
+	 */
+	C constraint(ConstraintDef<?, ?> definition);
+}

engine/src/main/java/org/hibernate/validator/cfg/json/GroupConversionTargetContext.java

@@ -0,0 +1,25 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.cfg.json;
+
+/**
+ * Creational context which allows to set the target group of a group conversion configured via
+ * {@link Cascadable#convertGroup(Class)}.
+ *
+ * @author Gunnar Morling
+ */
+public interface GroupConversionTargetContext<C> {
+
+	/**
+	 * Sets the target group of the conversion to be configured.
+	 *
+	 * @param to the target group of the conversion
+	 *
+	 * @return The current creational context following the method chaining pattern.
+	 */
+	C to(Class<?> to);
+}

engine/src/main/java/org/hibernate/validator/cfg/json/JsonConstraintMapping.java

@@ -0,0 +1,32 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.cfg.json;
+
+/**
+ * Represents a constraint mapping configured via the programmatic API.
+ *
+ * @author Hardy Ferentschik
+ * @author Gunnar Morling
+ * @author Kevin Pollet &lt;kevin.pollet@serli.com&gt; (C) 2011 SERLI
+ * @author Yoann Rodiere
+ * @author Marko Bekhta
+ */
+public interface JsonConstraintMapping {
+
+	/**
+	 * Starts defining constraints on the specified bean class. Each bean class may only be configured once within all
+	 * constraint mappings used for configuring one validator factory.
+	 *
+	 * @param <C> The type to be configured.
+	 * @param beanClass The bean class on which to define constraints. All constraints defined after calling this method
+	 * 		are added to the bean of the type {@code beanClass} until the next call of {@code type} or {@code annotation}.
+	 *
+	 * @return Instance allowing for defining constraints on the specified class.
+	 */
+	<C> TypeConstraintMappingContext<C> type(Class<C> beanClass);
+
+}

engine/src/main/java/org/hibernate/validator/cfg/json/PropertyConstraintMappingContext.java

@@ -0,0 +1,22 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.cfg.json;
+
+/**
+ * Constraint mapping creational context representing a property of a bean. Allows
+ * to place constraints on the property, mark the property as cascadable and to
+ * navigate to other constraint targets.
+ *
+ * @author Gunnar Morling
+ * @author Kevin Pollet &lt;kevin.pollet@serli.com&gt; (C) 2011 SERLI
+ * @author Marko Bekhta
+ */
+public interface PropertyConstraintMappingContext extends Constrainable<PropertyConstraintMappingContext>,
+		PropertyTarget,
+		Cascadable<PropertyConstraintMappingContext> {
+
+}

engine/src/main/java/org/hibernate/validator/cfg/json/PropertyTarget.java

@@ -0,0 +1,37 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.cfg.json;
+
+/**
+ * Facet of a constraint mapping creational context which allows to the select the bean
+ * property to which the next operations shall apply.
+ *
+ * @author Kevin Pollet &lt;kevin.pollet@serli.com&gt; (C) 2011 SERLI
+ * @author Gunnar Morling
+ * @author Marko Bekhta
+ */
+public interface PropertyTarget {
+
+	/**
+	 * Selects a property to which the next operations shall apply.
+	 * <p>
+	 * Until this method is called constraints apply on class level. After calling this method constraints
+	 * apply on the specified property with the given access type.
+	 * </p>
+	 * <p>
+	 * A given property may only be configured once.
+	 * </p>
+	 *
+	 * @param property The property on which to apply the following constraints (Java Bean notation).
+	 *
+	 * @return A creational context representing the selected property.
+	 */
+	PropertyConstraintMappingContext property(String property, Class<?> propertyType);
+
+
+	PropertyConstraintMappingContext property(String property);
+}

engine/src/main/java/org/hibernate/validator/cfg/json/TypeConstraintMappingContext.java

@@ -0,0 +1,44 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.cfg.json;
+
+import javax.json.JsonObject;
+
+import org.hibernate.validator.spi.group.DefaultGroupSequenceProvider;
+
+/**
+ * Constraint mapping creational context representing a type. Allows place
+ * class-level constraints on that type, define its default group sequence (and provider)
+ * and to navigate to other constraint targets.
+ *
+ * @param <C> The type represented by this creational context.
+ *
+ * @author Kevin Pollet &lt;kevin.pollet@serli.com&gt; (C) 2011 SERLI
+ * @author Gunnar Morling
+ */
+public interface TypeConstraintMappingContext<C> extends Constrainable<TypeConstraintMappingContext<C>>,
+		PropertyTarget {
+
+	/**
+	 * Defines the default group sequence for current type.
+	 *
+	 * @param defaultGroupSequence the default group sequence.
+	 *
+	 * @return The current creational context following the method chaining pattern.
+	 */
+	TypeConstraintMappingContext<C> defaultGroupSequence(Class<?>... defaultGroupSequence);
+
+	/**
+	 * Defines the default group sequence provider for the current type.
+	 *
+	 * @param defaultGroupSequenceProviderClass The default group sequence provider class.
+	 *
+	 * @return The current creational context following the method chaining pattern.
+	 */
+	TypeConstraintMappingContext<C> defaultGroupSequenceProviderClass(
+			Class<? extends DefaultGroupSequenceProvider<JsonObject>> defaultGroupSequenceProviderClass);
+}

engine/src/main/java/org/hibernate/validator/cfg/json/TypeTarget.java

@@ -0,0 +1,26 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+package org.hibernate.validator.cfg.json;
+
+/**
+ * Facet of a constraint mapping creational context which allows to the select the bean
+ * type to which the next operations shall apply.
+ *
+ * @author Kevin Pollet &lt;kevin.pollet@serli.com&gt; (C) 2011 SERLI
+ * @author Gunnar Morling
+ */
+public interface TypeTarget {
+	/**
+	 * Selects the type to which the next operations shall apply. A given type may only be configured once.
+	 *
+	 * @param <C> The type to select.
+	 * @param type The type to select.
+	 *
+	 * @return A creational context representing the selected type.
+	 */
+	<C> TypeConstraintMappingContext<C> type(Class<C> type);
+}

engine/src/main/java/org/hibernate/validator/cfg/json/package-info.java

@@ -0,0 +1,12 @@
+/*
+ * Hibernate Validator, declare and validate application constraints
+ *
+ * License: Apache License, Version 2.0
+ * See the license.txt file in the root directory or <http://www.apache.org/licenses/LICENSE-2.0>.
+ */
+
+/**
+ * <p>Contains facet and creational context interfaces forming the API for programmatic constraint definition for Json validation.</p>
+ * <p>This package is part of the public Hibernate Validator API.</p>
+ */
+package org.hibernate.validator.cfg.json;