* This class contains the default validations that are used in the * validator-rules.xml file. *
** In general passing in a null or blank will return a null Object or a false * boolean. However, nulls and blanks do not result in an error being added to the * errors. *
* * @author David Winterfeldt * @author James Turner * @author Rob Leland * @since Struts 1.1 */ public class FieldChecks implements Serializable { /** * Commons Logging instance. */ private static final Log log = LogFactory.getLog(FieldChecks.class); public static final String FIELD_TEST_NULL = "NULL"; public static final String FIELD_TEST_NOTNULL = "NOTNULL"; public static final String FIELD_TEST_EQUAL = "EQUAL"; /** * Checks if the field isn't null and length of the field is greater than zero not * including whitespace. * * @param bean The bean validation is being performed on. * @param va TheValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if
* any validation errors occur.
* @param request Current request object.
* @return true if meets stated requirements, false otherwise.
*/
public static boolean validateRequired(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (GenericValidator.isBlankOrNull(value)) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
} else {
return true;
}
}
/**
* Checks if the field isn't null based on the values of other fields.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being
* performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if
* any validation errors occur.
* @param validator The Validator instance, used to access
* other field values.
* @param request Current request object.
* @return true if meets stated requirements, false otherwise.
*/
public static boolean validateRequiredIf(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
org.apache.commons.validator.Validator validator,
HttpServletRequest request) {
Object form = validator.getResource(org.apache.commons.validator.Validator.BEAN_KEY);
String value = null;
boolean required = false;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
int i = 0;
String fieldJoin = "AND";
if (!GenericValidator.isBlankOrNull(field.getVarValue("fieldJoin"))) {
fieldJoin = field.getVarValue("fieldJoin");
}
if (fieldJoin.equalsIgnoreCase("AND")) {
required = true;
}
while (!GenericValidator.isBlankOrNull(field.getVarValue("field[" + i + "]"))) {
String dependProp = field.getVarValue("field[" + i + "]");
String dependTest = field.getVarValue("fieldTest[" + i + "]");
String dependTestValue = field.getVarValue("fieldValue[" + i + "]");
String dependIndexed = field.getVarValue("fieldIndexed[" + i + "]");
if (dependIndexed == null) {
dependIndexed = "false";
}
String dependVal = null;
boolean thisRequired = false;
if (field.isIndexed() && dependIndexed.equalsIgnoreCase("true")) {
String key = field.getKey();
if ((key.indexOf("[") > -1) && (key.indexOf("]") > -1)) {
String ind = key.substring(0, key.indexOf(".") + 1);
dependProp = ind + dependProp;
}
}
dependVal = ValidatorUtil.getValueAsString(form, dependProp);
if (dependTest.equals(FIELD_TEST_NULL)) {
if ((dependVal != null) && (dependVal.length() > 0)) {
thisRequired = false;
} else {
thisRequired = true;
}
}
if (dependTest.equals(FIELD_TEST_NOTNULL)) {
if ((dependVal != null) && (dependVal.length() > 0)) {
thisRequired = true;
} else {
thisRequired = false;
}
}
if (dependTest.equals(FIELD_TEST_EQUAL)) {
thisRequired = dependTestValue.equalsIgnoreCase(dependVal);
}
if (fieldJoin.equalsIgnoreCase("AND")) {
required = required && thisRequired;
} else {
required = required || thisRequired;
}
i++;
}
if (required) {
if (GenericValidator.isBlankOrNull(value)) {
errors.add(
field.getKey(),
Resources.getActionError(request, va, field));
return false;
} else {
return true;
}
}
return true;
}
/**
* Checks if the field matches the regular expression in the field's mask attribute.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being
* performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if
* any validation errors occur.
* @param request Current request object.
* @return true if field matches mask, false otherwise.
*/
public static boolean validateMask(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
String mask = field.getVarValue("mask");
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
try {
if (!GenericValidator.isBlankOrNull(value)
&& !GenericValidator.matchRegexp(value, mask)) {
errors.add(
field.getKey(),
Resources.getActionError(request, va, field));
return false;
} else {
return true;
}
} catch (Exception e) {
log.error(e.getMessage(), e);
}
return true;
}
/**
* Checks if the field can safely be converted to a byte primitive.
*
*@param bean The bean validation is being performed on.
*@param va The ValidatorAction that is currently being performed.
*@param field The Field object associated with the current
*field being validated.
*@param errors The ActionErrors object to add errors to if
*any validation errors occur.
*@param request Current request object.
*@return A Byte if valid, null otherwise.
*/
public static Byte validateByte(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
Byte result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
result = GenericTypeValidator.formatByte(value);
if (result == null) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
}
}
return result;
}
/**
* Checks if the field can safely be converted to a short primitive.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if
* any validation errors occur.
* @param request Current request object.
* @return A Short if valid, otherwise null.
*/
public static Short validateShort(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
Short result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
result = GenericTypeValidator.formatShort(value);
if (result == null) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
}
}
return result;
}
/**
* Checks if the field can safely be converted to an int primitive.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return An Integer if valid, a null otherwise.
*/
public static Integer validateInteger(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
Integer result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
result = GenericTypeValidator.formatInt(value);
if (result == null) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
}
}
return result;
}
/**
* Checks if the field can safely be converted to a long primitive.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return A Long if valid, a null otherwise.
*/
public static Long validateLong(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
Long result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
result = GenericTypeValidator.formatLong(value);
if (result == null) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
}
}
return result;
}
/**
* Checks if the field can safely be converted to a float primitive.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return A Float if valid, a null otherwise.
*/
public static Float validateFloat(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
Float result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
result = GenericTypeValidator.formatFloat(value);
if (result == null) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
}
}
return result;
}
/**
* Checks if the field can safely be converted to a double primitive.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return A Double if valid, a null otherwise.
*/
public static Double validateDouble(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
Double result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
result = GenericTypeValidator.formatDouble(value);
if (result == null) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
}
}
return result;
}
/**
* Checks if the field is a valid date. If the field has a datePattern variable,
* that will be used to format java.text.SimpleDateFormat. If the
* field has a datePatternStrict variable, that will be used to format java.text.SimpleDateFormat
* and the length will be checked so '2/12/1999' will not pass validation with
* the format 'MM/dd/yyyy' because the month isn't two digits. If no datePattern
* variable is specified, then the field gets the DateFormat.SHORT format for
* the locale. The setLenient method is set to false for all variations.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return A Date if valid, a null if blank or invalid.
*/
public static Date validateDate(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
Date result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
String datePattern = field.getVarValue("datePattern");
String datePatternStrict = field.getVarValue("datePatternStrict");
Locale locale = Resources.getLocale(request);
if (!GenericValidator.isBlankOrNull(value)) {
try {
if (datePattern != null && datePattern.length() > 0) {
result = GenericTypeValidator.formatDate(value, datePattern, false);
} else if (datePatternStrict != null && datePatternStrict.length() > 0) {
result = GenericTypeValidator.formatDate(value, datePatternStrict, true);
} else {
result = GenericTypeValidator.formatDate(value, locale);
}
} catch (Exception e) {
log.error(e.getMessage(), e);
}
if (result == null) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
}
}
return result;
}
/**
* Checks if a fields value is within a range (min & max specified in the
* vars attribute).
*
*@deprecated As of Struts 1.1, replaced by {@link #validateIntRange(java.lang.Object,org.apache.commons.validator.ValidatorAction,org.apache.commons.validator.Field,org.apache.struts.action.ActionErrors,javax.servlet.http.HttpServletRequest)}
*@param bean The bean validation is being performed on.
*@param va The ValidatorAction that is currently being performed.
*@param field The Field object associated with the current
* field being validated.
*@param errors The ActionErrors object to add errors to if any
* validation errors occur.
*@param request Current request object.
*@return True if in range, false otherwise.
*/
public static boolean validateRange(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
return validateIntRange(bean, va, field, errors, request);
}
/**
* Checks if a fields value is within a range (min & max specified in the
* vars attribute).
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return True if in range, false otherwise.
*/
public static boolean validateIntRange(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
int intValue = Integer.parseInt(value);
int min = Integer.parseInt(field.getVarValue("min"));
int max = Integer.parseInt(field.getVarValue("max"));
if (!GenericValidator.isInRange(intValue, min, max)) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
} catch (Exception e) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
}
return true;
}
/**
* Checks if a fields value is within a range (min & max specified in the
* vars attribute).
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return True if in range, false otherwise.
*/
public static boolean validateDoubleRange(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
double doubleValue = Double.parseDouble(value);
double min = Double.parseDouble(field.getVarValue("min"));
double max = Double.parseDouble(field.getVarValue("max"));
if (!GenericValidator.isInRange(doubleValue, min, max)) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
} catch (Exception e) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
}
return true;
}
/**
* Checks if a fields value is within a range (min & max specified in the
* vars attribute).
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return True if in range, false otherwise.
*/
public static boolean validateFloatRange(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
float floatValue = Float.parseFloat(value);
float min = Float.parseFloat(field.getVarValue("min"));
float max = Float.parseFloat(field.getVarValue("max"));
if (!GenericValidator.isInRange(floatValue, min, max)) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
} catch (Exception e) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
}
return true;
}
/**
* Checks if the field is a valid credit card number.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return The credit card as a Long, a null if invalid, blank, or null.
*/
public static Long validateCreditCard(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
Long result = null;
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
result = GenericTypeValidator.formatCreditCard(value);
if (result == null) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
}
}
return result;
}
/**
* Checks if a field has a valid e-mail address.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return True if valid, false otherwise.
*/
public static boolean validateEmail(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value) && !GenericValidator.isEmail(value)) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
} else {
return true;
}
}
/**
* Checks if the field's length is less than or equal to the maximum value.
* A Null will be considered an error.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return True if stated conditions met.
*/
public static boolean validateMaxLength(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (value != null) {
try {
int max = Integer.parseInt(field.getVarValue("maxlength"));
if (!GenericValidator.maxLength(value, max)) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
} catch (Exception e) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
}
return true;
}
/**
* Checks if the field's length is greater than or equal to the minimum value.
* A Null will be considered an error.
*
* @param bean The bean validation is being performed on.
* @param va The ValidatorAction that is currently being performed.
* @param field The Field object associated with the current
* field being validated.
* @param errors The ActionErrors object to add errors to if any
* validation errors occur.
* @param request Current request object.
* @return True if stated conditions met.
*/
public static boolean validateMinLength(Object bean,
ValidatorAction va, Field field,
ActionErrors errors,
HttpServletRequest request) {
String value = null;
if (isString(bean)) {
value = (String) bean;
} else {
value = ValidatorUtil.getValueAsString(bean, field.getProperty());
}
if (!GenericValidator.isBlankOrNull(value)) {
try {
int min = Integer.parseInt(field.getVarValue("minlength"));
if (!GenericValidator.minLength(value, min)) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
} catch (Exception e) {
errors.add(field.getKey(), Resources.getActionError(request, va, field));
return false;
}
}
return true;
}
/**
* Return true if the specified object is a String or a null
* value.
*
* @param o Object to be tested
* @return The string value
*/
protected static boolean isString(Object o) {
return (o == null) ? true : String.class.isInstance(o);
}
}