View Javadoc
1   /*
2    * Copyright (c) 2002-2022, 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.portal.web.xpages;
35  
36  import fr.paris.lutece.util.bean.BeanUtil;
37  import fr.paris.lutece.util.beanvalidation.BeanValidationUtil;
38  import fr.paris.lutece.util.beanvalidation.ValidationError;
39  import fr.paris.lutece.util.beanvalidation.ValidationErrorConfig;
40  
41  import java.util.List;
42  import java.util.Locale;
43  import java.util.Set;
44  
45  import javax.servlet.http.HttpServletRequest;
46  
47  import javax.validation.ConstraintViolation;
48  
49  /**
50   * Abstract XPageApplication provides
51   *
52   */
53  public abstract class AbstractXPageApplication implements XPageApplication
54  {
55      /**
56       * Generated serial version UID
57       */
58      private static final long serialVersionUID = -6298306432030274941L;
59  
60      /**
61       * Populate a bean using parameters in http request
62       * 
63       * @param bean
64       *            bean to populate
65       * @param request
66       *            http request
67       */
68      protected void populate( Object bean, HttpServletRequest request )
69      {
70          BeanUtil.populate( bean, request );
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 of constraints that has been violated
81       */
82      protected <T> Set<ConstraintViolation<T>> validate( T bean )
83      {
84          return BeanValidationUtil.validate( bean );
85      }
86  
87      /**
88       * Validates a bean
89       * 
90       * @param <T>
91       *            The bean type
92       * @param bean
93       *            The bean to validate
94       * @param strFieldsKeyPrefix
95       *            The fields keys prefix in resources files
96       * @param locale
97       *            The locale
98       * @return The error list
99       */
100     protected <T> List<ValidationError> validate( T bean, String strFieldsKeyPrefix, Locale locale )
101     {
102         return BeanValidationUtil.validate( bean, locale, strFieldsKeyPrefix );
103     }
104 
105     /**
106      * Validates a bean
107      * 
108      * @param <T>
109      *            The bean type
110      * @param bean
111      *            The bean to validate
112      * @param config
113      *            The config for Error validation rendering
114      * @param locale
115      *            The locale
116      * @return The error list
117      */
118     protected <T> List<ValidationError> validate( T bean, ValidationErrorConfig config, Locale locale )
119     {
120         return BeanValidationUtil.validate( bean, locale, config );
121     }
122 }