org.exolab.castor.xml.Validator Maven / Gradle / Ivy

/*
 * Redistribution and use of this software and associated documentation ("Software"), with or
 * without modification, are permitted provided that the following conditions are met:
 *
 * 1. Redistributions of source code must retain copyright statements and notices. Redistributions
 * must also contain a copy of this document.
 *
 * 2. Redistributions in binary form must reproduce the above copyright notice, this list of
 * conditions and the following disclaimer in the documentation and/or other materials provided with
 * the distribution.
 *
 * 3. The name "Exolab" must not be used to endorse or promote products derived from this Software
 * without prior written permission of Intalio, Inc. For written permission, please contact
 * [email protected].
 *
 * 4. Products derived from this Software may not be called "Exolab" nor may "Exolab" appear in
 * their names without prior written permission of Intalio, Inc. Exolab is a registered trademark of
 * Intalio, Inc.
 *
 * 5. Due credit should be given to the Exolab Project (http://www.exolab.org/).
 *
 * THIS SOFTWARE IS PROVIDED BY INTALIO, INC. AND CONTRIBUTORS ``AS IS'' AND ANY EXPRESSED OR
 * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL INTALIO, INC. OR ITS
 * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
 * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
 * WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY
 * WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 *
 * Copyright 1999-2002 (C) Intalio, Inc. All Rights Reserved.
 *
 * This file was originally developed by Keith Visco during the course of employment at Intalio Inc.
 * All portions of this file developed by Keith Visco after Jan 19 2005 are Copyright (C) 2005 Keith
 * Visco. All Rights Reserved.
 *
 * $Id$
 */
package org.exolab.castor.xml;

import java.text.MessageFormat;
import java.util.Locale;
import java.util.ResourceBundle;

import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.castor.xml.BackwardCompatibilityContext;
import org.castor.xml.InternalContext;
import org.exolab.castor.mapping.FieldDescriptor;
import org.exolab.castor.xml.location.XPathLocation;
import org.exolab.castor.xml.validators.ClassValidator;

/**
 * A class which can perform Validation on an Object model. This class uses the ClassDescriptors and
 * FieldDescriptors to perform the validation.
 *
 * @author Keith Visco
 * @version $Revision$ $Date: 2005-02-28 17:43:25 -0700 (Mon, 28 Feb 2005) $
 */
public class Validator implements ClassValidator {
  private static final Log LOG = LogFactory.getLog(Validator.class);

  /** resource bundle */
  protected static ResourceBundle resourceBundle;

  static {
    resourceBundle = ResourceBundle.getBundle("ValidationMessages", Locale.getDefault());
  }

  /**
   * Creates a new Validator.
   */
  public Validator() {
    super();
    // usage
    // MessageFormat.format(rbm.getString(validator.cannot.validate.null.object), new Object[]
    // {"Yes!!!", "is"});
  } // -- Validator

  /**
   * Validates the given Object.
   *
   * @param object the Object to validate
   * @throws ValidationException if validation fails.
   */
  public void validate(final Object object) throws ValidationException {
    validate(object, (ValidationContext) null);
  }

  /**
   * Validates the given Object.
   *
   * @param object the Object to validate
   * @param context the ValidationContext to use during validation.
   * @throws ValidationException if validation fails.
   */
  public void validate(final Object object, final ValidationContext context)
      throws ValidationException {
    if (object == null) {
      throw new ValidationException(
          resourceBundle.getString("validator.error.cannot.validate.null.object"));
    }

    if (context == null) {
      ValidationContext v2 = new ValidationContext();
      InternalContext ic = new BackwardCompatibilityContext();
      ic.setClassLoader(object.getClass().getClassLoader());
      v2.setInternalContext(ic);
      validate(object, v2);
      return;
    }

    if (context.getClassDescriptorResolver() == null) {
      String message = resourceBundle.getString("validator.error.class.descriptor.resolver.null");
      throw new IllegalStateException(message);
    }

    XMLClassDescriptor classDesc = null;

    if (!MarshalFramework.isPrimitive(object.getClass())) {
      try {
        classDesc =
            (XMLClassDescriptor) context.getClassDescriptorResolver().resolve(object.getClass());
      } catch (ResolverException rx) {
        throw new ValidationException(rx);
      }
    }

    // -- we cannot validate an object if ClassDescriptor is null
    if (classDesc == null) {
      return;
    }

    XMLFieldDescriptor fieldDesc = null;

    try {
      TypeValidator validator = classDesc.getValidator();
      if (validator != null) {
        validator.validate(object, context);
      } else {
        // Default validation -- just validate each field
        FieldDescriptor[] fields = classDesc.getFields();
        if (fields != null) {
          for (int i = 0; i < fields.length; i++) {
            fieldDesc = (XMLFieldDescriptor) fields[i];
            if (fieldDesc == null) {
              continue;
            }
            FieldValidator fieldValidator = fieldDesc.getValidator();
            if (fieldValidator != null) {
              fieldValidator.validate(object, context);
            }
          }
        }
      }
    } catch (ValidationException vx) {
      // -- add location information
      XPathLocation loc = (XPathLocation) vx.getLocation();
      if (loc == null) {
        loc = new XPathLocation();
        vx.setLocation(loc);
        if (fieldDesc != null) {
          if (fieldDesc.getNodeType() == NodeType.Attribute) {
            loc.addAttribute(fieldDesc.getXMLName());
          } else {
            loc.addChild(fieldDesc.getXMLName());
          }
        }
      }
      if (classDesc.getXMLName() != null) {
        loc.addParent(classDesc.getXMLName());
      }
      throw vx;
    }

    // checkUnresolvedIdrefs(context);

  }

  public void checkUnresolvedIdrefs(ValidationContext context) throws ValidationException {
    if (!context.getUnresolvedIdRefs().isEmpty()) {
      String err = MessageFormat.format(
          resourceBundle.getString("validator.error.class.descriptor.resolver.null"),
          new Object[] {context.getUnresolvedIdRefs().toString()});
      throw new ValidationException(err);
    }
  }

  // TODO: add cleanup life-cycle method to be called from outside

}