AbstractXPageApplication.java

  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. import fr.paris.lutece.util.bean.BeanUtil;
  36. import fr.paris.lutece.util.beanvalidation.BeanValidationUtil;
  37. import fr.paris.lutece.util.beanvalidation.ValidationError;
  38. import fr.paris.lutece.util.beanvalidation.ValidationErrorConfig;

  39. import java.util.List;
  40. import java.util.Locale;
  41. import java.util.Set;

  42. import javax.servlet.http.HttpServletRequest;

  43. import javax.validation.ConstraintViolation;

  44. /**
  45.  * Abstract XPageApplication provides
  46.  *
  47.  */
  48. public abstract class AbstractXPageApplication implements XPageApplication
  49. {
  50.     /**
  51.      * Generated serial version UID
  52.      */
  53.     private static final long serialVersionUID = -6298306432030274941L;

  54.     /**
  55.      * Populate a bean using parameters in http request
  56.      *
  57.      * @param bean
  58.      *            bean to populate
  59.      * @param request
  60.      *            http request
  61.      */
  62.     protected void populate( Object bean, HttpServletRequest request )
  63.     {
  64.         BeanUtil.populate( bean, request );
  65.     }

  66.     /**
  67.      * Validates a bean.
  68.      *
  69.      * @param <T>
  70.      *            the bean type
  71.      * @param bean
  72.      *            the bean to validate
  73.      * @return the sets of constraints that has been violated
  74.      */
  75.     protected <T> Set<ConstraintViolation<T>> validate( T bean )
  76.     {
  77.         return BeanValidationUtil.validate( bean );
  78.     }

  79.     /**
  80.      * Validates a bean
  81.      *
  82.      * @param <T>
  83.      *            The bean type
  84.      * @param bean
  85.      *            The bean to validate
  86.      * @param strFieldsKeyPrefix
  87.      *            The fields keys prefix in resources files
  88.      * @param locale
  89.      *            The locale
  90.      * @return The error list
  91.      */
  92.     protected <T> List<ValidationError> validate( T bean, String strFieldsKeyPrefix, Locale locale )
  93.     {
  94.         return BeanValidationUtil.validate( bean, locale, strFieldsKeyPrefix );
  95.     }

  96.     /**
  97.      * Validates a bean
  98.      *
  99.      * @param <T>
  100.      *            The bean type
  101.      * @param bean
  102.      *            The bean to validate
  103.      * @param config
  104.      *            The config for Error validation rendering
  105.      * @param locale
  106.      *            The locale
  107.      * @return The error list
  108.      */
  109.     protected <T> List<ValidationError> validate( T bean, ValidationErrorConfig config, Locale locale )
  110.     {
  111.         return BeanValidationUtil.validate( bean, locale, config );
  112.     }
  113. }