diff --git a/.idea/codeStyleSettings.xml b/.idea/codeStyleSettings.xml
index 9178b38..b4f1cbd 100644
--- a/.idea/codeStyleSettings.xml
+++ b/.idea/codeStyleSettings.xml
@@ -6,8 +6,14 @@
+
+
+
+
+
+
diff --git a/.idea/encodings.xml b/.idea/encodings.xml
index 12108cd..cf1353c 100644
--- a/.idea/encodings.xml
+++ b/.idea/encodings.xml
@@ -7,4 +7,5 @@
-
\ No newline at end of file
+
+
diff --git a/.idea/misc.xml b/.idea/misc.xml
index 55a314f..6269f0b 100644
--- a/.idea/misc.xml
+++ b/.idea/misc.xml
@@ -9,6 +9,7 @@
+
-
\ No newline at end of file
+
+
diff --git a/valdr-bean-validation-parent.iml b/valdr-bean-validation-parent.iml
index b26c4d0..b475024 100644
--- a/valdr-bean-validation-parent.iml
+++ b/valdr-bean-validation-parent.iml
@@ -9,4 +9,5 @@
-
\ No newline at end of file
+
+
diff --git a/valdr-bean-validation/src/main/java/com/github/valdr/AnnotatedClass.java b/valdr-bean-validation/src/main/java/com/github/valdr/AnnotatedClass.java
index fdd3f6a..f0819b0 100644
--- a/valdr-bean-validation/src/main/java/com/github/valdr/AnnotatedClass.java
+++ b/valdr-bean-validation/src/main/java/com/github/valdr/AnnotatedClass.java
@@ -19,6 +19,7 @@ public class AnnotatedClass {
private final Class clazz;
private final List excludedFields;
private final Iterable> relevantAnnotationClasses;
+ private final boolean outputValidationGroups;
/**
* @param clazz wrapped class
@@ -27,10 +28,27 @@ public class AnnotatedClass {
* AnnotatedClass#extractValidationRules()} is invoked
*/
AnnotatedClass(Class clazz, List excludedFields, Iterable>
- relevantAnnotationClasses) {
+ relevantAnnotationClasses) {
this.clazz = clazz;
this.excludedFields = excludedFields;
this.relevantAnnotationClasses = relevantAnnotationClasses;
+ this.outputValidationGroups = false;
+ }
+
+ /**
+ * @param clazz wrapped class
+ * @param excludedFields collection of fully qualified field names which are skipped by the parser
+ * @param relevantAnnotationClasses only these annotation classes are considered when {@link
+ * AnnotatedClass#extractValidationRules()} is invoked
+ * @param outputValidationGroups Whether to output the value of the validation groups attribute of the validation
+ * annotations.
+ */
+ AnnotatedClass(Class clazz, List excludedFields, Iterable>
+ relevantAnnotationClasses, boolean outputValidationGroups) {
+ this.clazz = clazz;
+ this.excludedFields = excludedFields;
+ this.relevantAnnotationClasses = relevantAnnotationClasses;
+ this.outputValidationGroups = outputValidationGroups;
}
/**
@@ -45,7 +63,7 @@ ClassConstraints extractValidationRules() {
for (Field field : allFields) {
if (isNotExcluded(field)) {
FieldConstraints fieldValidationRules = new AnnotatedField(field,
- relevantAnnotationClasses).extractValidationRules();
+ relevantAnnotationClasses, outputValidationGroups).extractValidationRules();
if (fieldValidationRules.size() > 0) {
classConstraints.put(field.getName(), fieldValidationRules);
}
diff --git a/valdr-bean-validation/src/main/java/com/github/valdr/AnnotatedField.java b/valdr-bean-validation/src/main/java/com/github/valdr/AnnotatedField.java
index 4bb6952..449e8ce 100644
--- a/valdr-bean-validation/src/main/java/com/github/valdr/AnnotatedField.java
+++ b/valdr-bean-validation/src/main/java/com/github/valdr/AnnotatedField.java
@@ -12,15 +12,17 @@
public class AnnotatedField {
private final Field field;
private final Iterable> relevantAnnotationClasses;
+ private final boolean outputValidationGroups;
/**
* @param field wrapped field
* @param relevantAnnotationClasses only these annotation classes are considered when {@link
* AnnotatedField#extractValidationRules()} is invoked
*/
- AnnotatedField(Field field, Iterable> relevantAnnotationClasses) {
+ AnnotatedField(Field field, Iterable> relevantAnnotationClasses, boolean outputValidationGroups) {
this.field = field;
this.relevantAnnotationClasses = relevantAnnotationClasses;
+ this.outputValidationGroups = outputValidationGroups;
}
/**
@@ -35,7 +37,7 @@ FieldConstraints extractValidationRules() {
for (Annotation annotation : annotations) {
if (Iterables.contains(relevantAnnotationClasses, annotation.annotationType())) {
- ConstraintAttributes constraintAttributes = new ConstraintAttributes(annotation);
+ ConstraintAttributes constraintAttributes = new ConstraintAttributes(annotation, outputValidationGroups);
BuiltInConstraint supportedValidator = BuiltInConstraint.valueOfAnnotationClassOrNull(annotation
.annotationType());
if (supportedValidator == null) {
diff --git a/valdr-bean-validation/src/main/java/com/github/valdr/ClasspathScanner.java b/valdr-bean-validation/src/main/java/com/github/valdr/ClasspathScanner.java
index 215eb46..19298ec 100644
--- a/valdr-bean-validation/src/main/java/com/github/valdr/ClasspathScanner.java
+++ b/valdr-bean-validation/src/main/java/com/github/valdr/ClasspathScanner.java
@@ -12,16 +12,18 @@
import org.slf4j.LoggerFactory;
import java.net.URL;
-import java.util.Collection;
-import java.util.Set;
+import java.util.*;
/**
* Provides means to scan the classpath for model classes that need to be parsed for constraint annotations.
*/
public class ClasspathScanner {
- private final Logger logger = LoggerFactory.getLogger(ClasspathScanner.class);
+ private static final Logger logger = LoggerFactory.getLogger(ClasspathScanner.class);
private final Options options;
+ private static Reflections all = null;
+
+
/**
* Constructor.
*
@@ -29,6 +31,16 @@ public class ClasspathScanner {
*/
public ClasspathScanner(Options options) {
this.options = options;
+
+ List groupsToScan = new ArrayList(options.getValidationGroupPackages());
+ if (groupsToScan.size() > 0) {
+ groupsToScan.add("javax.validation.groups");
+
+ all = new Reflections(new ConfigurationBuilder().
+ setUrls(buildClassLoaderUrls(groupsToScan)).setScanners(new SubTypesScanner(false)));
+
+ }
+
}
/**
@@ -40,14 +52,21 @@ public ClasspathScanner(Options options) {
*/
public Set> findClassesToParse() {
Reflections reflections = new Reflections(new ConfigurationBuilder().
- setUrls(buildClassLoaderUrls()).setScanners(new SubTypesScanner(false)).filterInputsBy(buildPackagePredicates()));
+ setUrls(buildClassLoaderUrls(options.getModelPackages())).setScanners(new SubTypesScanner(false)).filterInputsBy(buildPackagePredicates()));
return reflections.getSubTypesOf(Object.class);
}
- private Collection buildClassLoaderUrls() {
+ // Using a static method accessing a static member is a sneaky optimization to avoid
+ // scanning through a lot of classes when analyzing each constraint annotation.
+ // The member gets set when this class' constructor is called.
+ public static Set> getSubTypesOf(Class aClass) {
+ return all == null ? new HashSet<>() : all.getSubTypesOf(aClass);
+ }
+
+ private Collection buildClassLoaderUrls(List packageNames) {
Collection urls = Sets.newHashSet();
- for (String packageName : options.getModelPackages()) {
+ for (String packageName : packageNames) {
if (StringUtils.isNotEmpty(packageName)) {
urls.addAll(ClasspathHelper.forPackage(packageName));
}
diff --git a/valdr-bean-validation/src/main/java/com/github/valdr/ConstraintAttributes.java b/valdr-bean-validation/src/main/java/com/github/valdr/ConstraintAttributes.java
index c315f08..bb0851a 100644
--- a/valdr-bean-validation/src/main/java/com/github/valdr/ConstraintAttributes.java
+++ b/valdr-bean-validation/src/main/java/com/github/valdr/ConstraintAttributes.java
@@ -2,11 +2,9 @@
import com.github.valdr.thirdparty.spring.AnnotationUtils;
+import javax.validation.groups.Default;
import java.lang.annotation.Annotation;
-import java.util.HashMap;
-import java.util.Iterator;
-import java.util.Map;
-import java.util.Set;
+import java.util.*;
/**
* All attributes of a constraint (i.e. Bean Validation annotation attributes).
@@ -14,15 +12,22 @@
public class ConstraintAttributes implements MinimalObjectMap {
private final Map map = new HashMap<>();
+ private final boolean outputValidationGroups;
+ private static final String GROUPS = "groups";
/**
* Constructor.
*
* @param annotation annotation which is queried for attributes
*/
- public ConstraintAttributes(Annotation annotation) {
+ public ConstraintAttributes(Annotation annotation, boolean outputValidationGroups) {
+ this.outputValidationGroups = outputValidationGroups;
Map annotationAttributes = AnnotationUtils.getAnnotationAttributes(annotation);
removeUnusedAttributes(annotationAttributes);
+ if (outputValidationGroups) {
+ validationGroupClassNamesToSimple(annotationAttributes);
+ }
+
map.putAll(annotationAttributes);
}
@@ -45,9 +50,40 @@ private void removeUnusedAttributes(Map annotationAttributes) {
Iterator it = annotationAttributes.keySet().iterator();
while (it.hasNext()) {
String key = it.next();
- if ("groups".equals(key) || "payload".equals(key)) {
+ if ("payload".equals(key) || (GROUPS.equals(key) && !outputValidationGroups)) {
it.remove();
}
}
}
+
+ private void validationGroupClassNamesToSimple(Map annotationAttributes) {
+ Class[] groupClasses = (Class[])annotationAttributes.get(GROUPS);
+ if (groupClasses.length == 0) {
+ groupClasses = new Class[]{Default.class};
+ }
+
+ Set simpleNames = new HashSet<>();
+ for(Class groupClass: groupClasses) {
+ for(Class c: getThisAndDescendants(groupClass)) {
+ simpleNames.add(c.getSimpleName());
+ }
+ }
+ annotationAttributes.put(GROUPS, simpleNames);
+ }
+
+ private List getThisAndDescendants(Class aClass) {
+ List ret = new ArrayList<>();
+
+ ret.add(aClass);
+ ret.addAll(ClasspathScanner.getSubTypesOf(aClass));
+ Collections.sort(ret, new Comparator() {
+ @Override
+ public int compare(Class o1, Class o2) {
+ return o1.getSimpleName().compareTo(o2.getSimpleName());
+ }
+ });
+
+ return ret;
+ }
+
}
diff --git a/valdr-bean-validation/src/main/java/com/github/valdr/ConstraintParser.java b/valdr-bean-validation/src/main/java/com/github/valdr/ConstraintParser.java
index fdbae5f..53f2310 100644
--- a/valdr-bean-validation/src/main/java/com/github/valdr/ConstraintParser.java
+++ b/valdr-bean-validation/src/main/java/com/github/valdr/ConstraintParser.java
@@ -54,7 +54,7 @@ public String parse() {
for (Class clazz : classpathScanner.findClassesToParse()) {
if (clazz != null) {
ClassConstraints classValidationRules = new AnnotatedClass(clazz, options.getExcludedFields(),
- allRelevantAnnotationClasses).extractValidationRules();
+ allRelevantAnnotationClasses, options.getOutputValidationGroups()).extractValidationRules();
if (classValidationRules.size() > 0) {
String name = options.getOutputFullTypeName() ? clazz.getName() : clazz.getSimpleName();
classNameToValidationRulesMap.put(name, classValidationRules);
diff --git a/valdr-bean-validation/src/main/java/com/github/valdr/Options.java b/valdr-bean-validation/src/main/java/com/github/valdr/Options.java
index 92993b4..0005cab 100644
--- a/valdr-bean-validation/src/main/java/com/github/valdr/Options.java
+++ b/valdr-bean-validation/src/main/java/com/github/valdr/Options.java
@@ -83,6 +83,19 @@ public final class Options {
*/
private String outputFile = StringUtils.EMPTY;
+ /**
+ * Whether to output validation annotation group attribute values in the meta-model (JSON). Validation groups are
+ * expanded to include their also descendants. If omitted, validation group values are not written.
+ */
+ private Boolean outputValidationGroups = Boolean.FALSE;
+
+ /**
+ * Fully qualified names of packages containing validation group interfaces. Must be specified, if
+ * outputValidationGroups is set to TRUE. (Finding subclasses by reflection from ALL classes in a classloader
+ * will spew out warnings, so we restrict the search to certain packages.)
+ */
+ private List validationGroupPackages = Lists.newArrayList();
+
/**
* Validates the consistency and integrity of the configured options.
*
@@ -92,6 +105,9 @@ public void validate() {
if (this.getModelPackages().isEmpty()) {
throw new InvalidConfigurationException("Model package names must not be empty.");
}
+ if (this.getOutputValidationGroups() && this.getValidationGroupPackages().isEmpty()) {
+ throw new InvalidConfigurationException("When outputting validation groups, validationGroupPackages must not be empty.");
+ }
}
/**
diff --git a/valdr-bean-validation/src/test/java/com/github/valdr/ClasspathScannerTest.java b/valdr-bean-validation/src/test/java/com/github/valdr/ClasspathScannerTest.java
index 2377f72..a938a41 100644
--- a/valdr-bean-validation/src/test/java/com/github/valdr/ClasspathScannerTest.java
+++ b/valdr-bean-validation/src/test/java/com/github/valdr/ClasspathScannerTest.java
@@ -58,7 +58,7 @@ public void shouldExcludedConfiguredClasses() {
Set> classesToParse = classpathScanner.findClassesToParse();
// then
assertThat(classesToParse, notContains(TestModelWithASingleAnnotatedMember.class));
- assertThat(classesToParse.size(), is(10));
+ assertThat(classesToParse.size(), is(11));
}
private Matcher>> notContains(final Class testModelClass) {
diff --git a/valdr-bean-validation/src/test/java/com/github/valdr/ConstraintParserTest.java b/valdr-bean-validation/src/test/java/com/github/valdr/ConstraintParserTest.java
index bac950d..858a550 100644
--- a/valdr-bean-validation/src/test/java/com/github/valdr/ConstraintParserTest.java
+++ b/valdr-bean-validation/src/test/java/com/github/valdr/ConstraintParserTest.java
@@ -12,11 +12,13 @@
import com.github.valdr.model.f.TestModelWithHibernateEmailAnnotation;
import com.github.valdr.model.g.TestModelWithHibernateUrlAnnotation;
import com.github.valdr.model.h.TestModelWithPatterns;
+import com.github.valdr.model.j.TestModelWithValidationGroups;
import com.github.valdr.model.validation.CustomValidation;
import com.google.common.collect.Lists;
import org.junit.Test;
import java.io.IOException;
+import java.util.Arrays;
import java.util.Collections;
import java.util.List;
@@ -218,6 +220,45 @@ public void shouldDecoratePatternConstraint() {
assertThat(json, containsString("/\\\\\\\\abc\\\\./")); // JSON needs to escape \ -> double escape here
}
+ @Test
+ public void shouldIncludeValidationGroupWhenSoConfigured() {
+ // given
+ parserConfiguredFor(Lists.newArrayList(TestModelWithValidationGroups.class.getPackage().getName()), true, Arrays.asList("com.github.valdr.util"));
+ // when
+ String json = parser.parse();
+ // then
+ String expected = "{\n" +
+ " \"TestModelWithValidationGroups\" : {\n" +
+ " \"oneAndOnePointOne\" : {\n" +
+ " \"required\" : {\n" +
+ " \"message\" : \"{javax.validation.constraints.NotNull.message}\",\n" +
+ " \"groups\" : [ \"GroupOne\", \"GroupOnePointOne\" ]\n" +
+ " }\n" +
+ " },\n" +
+ " \"justTwo\" : {\n" +
+ " \"required\" : {\n" +
+ " \"message\" : \"{javax.validation.constraints.NotNull.message}\",\n" +
+ " \"groups\" : [ \"GroupTwo\" ]\n" +
+ " }\n" +
+ " },\n" +
+ " \"noGroupSpecifiedMeansDefault\" : {\n" +
+ " \"required\" : {\n" +
+ " \"message\" : \"{javax.validation.constraints.NotNull.message}\",\n" +
+ " \"groups\" : [ \"GroupTwo\", \"Default\", \"GroupOne\", \"GroupOnePointOne\" ]\n" +
+ " }\n" +
+ " },\n" +
+ " \"twoAndOneAndOnePointOne\" : {\n" +
+ " \"required\" : {\n" +
+ " \"message\" : \"{javax.validation.constraints.NotNull.message}\",\n" +
+ " \"groups\" : [ \"GroupTwo\", \"GroupOne\", \"GroupOnePointOne\" ]\n" +
+ " }\n" +
+ " }\n" +
+ " }\n" +
+ "}";
+ assertThat(json, is(expected));
+ }
+
+
private void parserConfiguredFor(List modelPackages, List customAnnotationClasses) {
Options options = new Options();
options.setModelPackages(modelPackages);
@@ -225,6 +266,14 @@ private void parserConfiguredFor(List modelPackages, List custom
parser = new ConstraintParser(options);
}
+ private void parserConfiguredFor(List modelPackages, boolean outputValidationGroups, List validationGroupPackages) {
+ Options options = new Options();
+ options.setModelPackages(modelPackages);
+ options.setValidationGroupPackages(validationGroupPackages);
+ options.setOutputValidationGroups(outputValidationGroups);
+ parser = new ConstraintParser(options);
+ }
+
private List emptyStringList() {
return Collections.emptyList();
}
diff --git a/valdr-bean-validation/src/test/java/com/github/valdr/model/j/TestModelWithValidationGroups.java b/valdr-bean-validation/src/test/java/com/github/valdr/model/j/TestModelWithValidationGroups.java
new file mode 100644
index 0000000..94a96b1
--- /dev/null
+++ b/valdr-bean-validation/src/test/java/com/github/valdr/model/j/TestModelWithValidationGroups.java
@@ -0,0 +1,21 @@
+package com.github.valdr.model.j;
+
+import com.github.valdr.util.ValidationGroup;
+import lombok.Getter;
+
+import javax.validation.constraints.NotNull;
+
+@Getter
+public class TestModelWithValidationGroups {
+ @NotNull(groups = ValidationGroup.GroupOne.class)
+ private String oneAndOnePointOne;
+
+ @NotNull(groups = {ValidationGroup.GroupTwo.class, ValidationGroup.GroupOne.class})
+ private String twoAndOneAndOnePointOne;
+
+ @NotNull(groups = {ValidationGroup.GroupTwo.class})
+ private String justTwo;
+
+ @NotNull
+ private String noGroupSpecifiedMeansDefault;
+}
diff --git a/valdr-bean-validation/src/test/java/com/github/valdr/util/ValidationGroup.java b/valdr-bean-validation/src/test/java/com/github/valdr/util/ValidationGroup.java
new file mode 100644
index 0000000..fe6ab69
--- /dev/null
+++ b/valdr-bean-validation/src/test/java/com/github/valdr/util/ValidationGroup.java
@@ -0,0 +1,22 @@
+package com.github.valdr.util;
+
+import javax.validation.groups.Default;
+
+public class ValidationGroup {
+ public interface GroupOne extends Default {
+ // validation group marker interface
+ }
+
+ public interface GroupOnePointOne extends GroupOne {
+ // validation group marker interface
+ }
+
+ public interface GroupTwo extends Default {
+ // validation group marker interface
+ }
+
+ // Should not show up as does not extend Default
+ public interface GroupThreeDoesNotExtendDefault {
+ // validation group marker interface
+ }
+}
\ No newline at end of file
diff --git a/valdr-bean-validation/valdr-bean-validation.iml b/valdr-bean-validation/valdr-bean-validation.iml
index 0a0ba32..cd7176c 100644
--- a/valdr-bean-validation/valdr-bean-validation.iml
+++ b/valdr-bean-validation/valdr-bean-validation.iml
@@ -40,4 +40,5 @@
-
\ No newline at end of file
+
+