1 /*
2 * Copyright (c) 2002-2025, City of Paris
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions
7 * are met:
8 *
9 * 1. Redistributions of source code must retain the above copyright notice
10 * and the following disclaimer.
11 *
12 * 2. Redistributions in binary form must reproduce the above copyright notice
13 * and the following disclaimer in the documentation and/or other materials
14 * provided with the distribution.
15 *
16 * 3. Neither the name of 'Mairie de Paris' nor 'Lutece' nor the names of its
17 * contributors may be used to endorse or promote products derived from
18 * this software without specific prior written permission.
19 *
20 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
21 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
22 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
23 * ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE
24 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
25 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
26 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
27 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
28 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
29 * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
30 * POSSIBILITY OF SUCH DAMAGE.
31 *
32 * License 1.0
33 */
34 package fr.paris.lutece.util.beanvalidation;
35
36 import java.util.ArrayList;
37 import java.util.List;
38 import java.util.Locale;
39 import java.util.Set;
40
41 import javax.validation.ConstraintViolation;
42 import javax.validation.Validation;
43 import javax.validation.Validator;
44 import javax.validation.ValidatorFactory;
45
46 /**
47 * BeanValidationUtils validates beans using JSR303 annotations.
48 *
49 * @see #validate(Object)
50 */
51 public final class BeanValidationUtil
52 {
53 /**
54 * Validator (JSR 303) is thread safe.
55 */
56 private static final Validator VALIDATOR;
57
58 static
59 {
60 // initialize the validator
61 ValidatorFactory factory = Validation.buildDefaultValidatorFactory( );
62 VALIDATOR = factory.getValidator( );
63 }
64
65 /**
66 * Utility class
67 */
68 private BeanValidationUtil( )
69 {
70 // nothing
71 }
72
73 /**
74 * Validates a bean.
75 *
76 * @param <T>
77 * the bean type
78 * @param bean
79 * the bean to validate
80 * @return the sets the
81 */
82 public static <T> Set<ConstraintViolation<T>> validate( T bean )
83 {
84 return VALIDATOR.validate( bean );
85 }
86
87 /**
88 * Use this in case you need more than a global validation
89 *
90 * @return the validator
91 */
92 public static Validator getValidator( )
93 {
94 return VALIDATOR;
95 }
96
97 /**
98 * Validate a bean
99 *
100 * @param <T>
101 * The bean class
102 * @param bean
103 * The bean
104 * @param locale
105 * The locale
106 * @param strFieldKeysPrefix
107 * The fields keys prefix in the resource file
108 * @return A list of errors
109 */
110 public static <T> List<ValidationError> validate( T bean, Locale locale, String strFieldKeysPrefix )
111 {
112 DefaultValidationErrorConfigdationErrorConfig.html#DefaultValidationErrorConfig">DefaultValidationErrorConfig config = new DefaultValidationErrorConfig( );
113 config.setFieldKeysPrefix( strFieldKeysPrefix );
114
115 return validate( bean, locale, config );
116 }
117
118 /**
119 * Validate a bean
120 *
121 * @param <T>
122 * The bean class
123 * @param bean
124 * The bean
125 * @param locale
126 * The locale
127 * @param config
128 * The config for validation errors rendering
129 * @return A list of errors
130 */
131 public static <T> List<ValidationError> validate( T bean, Locale locale, ValidationErrorConfig config )
132 {
133 List<ValidationError> list = new ArrayList<>( );
134 Set<ConstraintViolation<T>> setViolation = validate( bean );
135
136 for ( ConstraintViolation<T> cv : setViolation )
137 {
138 list.add( new ValidationError( cv, locale, config ) );
139 }
140
141 return list;
142 }
143 }