com.opensymphony.xwork2.validator.validators.ConditionalVisitorFieldValidator Maven / Gradle / Ivy
/*
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package com.opensymphony.xwork2.validator.validators;
import com.opensymphony.xwork2.validator.ValidationException;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
/**
*
* The ConditionalVisitorFieldValidator will forward validation to the VisitorFieldValidator
* only if the expression will evaluate to true.
*
*
*
*
* - expression - an OGNL expression which should evaluate to true to pass validation to the VisitorFieldValidator
*
*
*
*
*
* <field name="colleaguePosition">
* <field-validator type="conditionalvisitor">
* <param name="expression">reason == 'colleague' and colleaguePositionID == 'OTHER'</param>
* <message>You must select reason Colleague and position Other</message>
* </field-validator>
* </field>
*
*
*
* @author Matt Raible
*/
public class ConditionalVisitorFieldValidator extends VisitorFieldValidator {
private static final Logger LOG = LogManager.getLogger(ConditionalVisitorFieldValidator.class);
private String expression;
public void setExpression(String expression) {
this.expression = expression;
}
public String getExpression() {
return expression;
}
/**
* If expression evaluates to true, invoke visitor validation.
*
* @param object the object being validated
* @throws ValidationException in case of validation problems
*/
@Override
public void validate(Object object) throws ValidationException {
if (validateExpression(object)) {
super.validate(object);
}
}
/**
* Validate the expression contained in the "expression" paramter.
*
* @param object the object you're validating
* @return true if expression evaluates to true (implying a validation
* failure)
* @throws ValidationException if anything goes wrong
*/
public boolean validateExpression(Object object) throws ValidationException {
Boolean answer = Boolean.FALSE;
Object obj = null;
try {
obj = getFieldValue(expression, object);
} catch (ValidationException e) {
throw e;
} catch (Exception e) {
// let this pass, but it will be logged right below
}
if ((obj != null) && (obj instanceof Boolean)) {
answer = (Boolean) obj;
} else {
LOG.warn("Got result of {} when trying to get Boolean.", obj);
}
return answer;
}
}