src/java/org/mxchange/pizzaapplication/validator/url/PizzaUrlValidator.java

   1 /*
   2  * Copyright (C) 2016 - 2022 Free Software Foundation
   3  *
   4  * This program is free software: you can redistribute it and/or modify
   5  * it under the terms of the GNU Affero General Public License as
   6  * published by the Free Software Foundation, either version 3 of the
   7  * License, or (at your option) any later version.
   8  *
   9  * This program is distributed in the hope that it will be useful,
  10  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  11  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  12  * GNU Affero General Public License for more details.
  13  *
  14  * You should have received a copy of the GNU Affero General Public License
  15  * along with this program.  If not, see <http://www.gnu.org/licenses/>.
  16  */
  17 package org.mxchange.pizzaapplication.validator.url;
  18
  19 import java.text.MessageFormat;
  20 import java.util.regex.Pattern;
  21 import javax.faces.application.FacesMessage;
  22 import javax.faces.component.UIComponent;
  23 import javax.faces.context.FacesContext;
  24 import javax.faces.validator.FacesValidator;
  25 import javax.faces.validator.ValidatorException;
  26 import org.mxchange.jcoreee.validator.string.BaseStringValidator;
  27
  28 /**
  29  * A validator for URL vallidation (only regex, but allow empty value if
  30  * allowed).
  31  * <p>
  32  * @author Roland Häder<roland@mxchange.org>
  33  */
  34 @FacesValidator ("UrlValidator")
  35 public class PizzaUrlValidator extends BaseStringValidator {
  36
  37         /**
  38          * Pattern matcher
  39          */
  40         private static final Pattern PATTERN_MATCHER = Pattern.compile(PizzaUrlValidator.URL_REGEX);
  41
  42         /**
  43          * Email pattern
  44          */
  45         private static final String URL_REGEX = "(http|https):\\/\\/[\\w\\-_]+(\\.[\\w\\-_]+)+([\\w\\-\\.,@?^=%&amp;:/~\\+#]*[\\w\\-\\@?^=%&amp;/~\\+#])?"; //NOI18N
  46
  47         /**
  48          * Serial number
  49          */
  50         private static final long serialVersionUID = 187_536_745_607_193L;
  51
  52         @Override
  53         public void validate (final FacesContext context, final UIComponent component, final Object value) throws ValidatorException {
  54                 // The required field
  55                 final String[] requiredFields = {"companyWebsiteUrl"}; //NOI18N
  56
  57                 // Default is to reject empty email address fields
  58                 Boolean allowEmptyValue = Boolean.FALSE;
  59
  60                 // Is attribute "allowEmptyValue" set?
  61                 if (component.getAttributes().containsKey("allowEmptyValue")) { //NOI18N
  62                         // Get attribute
  63                         Object attribute = component.getAttributes().get("allowEmptyValue"); //NOI18N
  64
  65                         // Make sure, it is Boolean as no String is accepted anymore
  66                         if (!(attribute instanceof String)) {
  67                                 // Not valid attribute, please use "true" or "false" (default)
  68                                 throw new IllegalArgumentException("allowEmptyValue must be of type String. Please use \"true\" or \"false\" for f:attribute value."); //NOI18N
  69                         }
  70
  71                         // Securely cast it
  72                         allowEmptyValue = Boolean.parseBoolean((String) attribute);
  73                 }
  74
  75                 // Pre-validation (example: not null, not a string, empty string ...)
  76                 super.preValidate(context, component, value, requiredFields, allowEmptyValue);
  77
  78                 // Is the email address empty and allowed?
  79                 if (null == value && allowEmptyValue) {
  80                         // Then accept this here
  81                         return;
  82                 } else if (null == value) {
  83                         // Abort here
  84                         throw new ValidatorException(new FacesMessage("No empty URL allowed.")); //NOI18N
  85                 }
  86
  87                 // Get string from object ... ;-)
  88                 final String url = String.valueOf(value).trim();
  89
  90                 // Checks if the email address matches a regex ("low-level" check)
  91                 // @TODO Should also be done by <f:validatorRegex />)
  92                 final boolean matches = PATTERN_MATCHER.matcher(url).matches(); //NOI18N
  93
  94                 // Is the email address valid?
  95                 if (!matches) {
  96                         // Generate message
  97                         String message = MessageFormat.format("URL {0} does not match regular expression.", url); //NOI18N
  98
  99                         // Not matching
 100                         throw new ValidatorException(new FacesMessage(FacesMessage.SEVERITY_WARN, message, message));
 101                 }
 102         }
 103
 104 }