io.guise.framework.validator.PANValidator Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of guise-framework Show documentation
Guise™ Internet application framework.
There is a newer version: 0.5.3
/*
 * Copyright © 2005-2008 GlobalMentor, Inc. 
 *
 * Licensed 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 io.guise.framework.validator;

import static java.util.Collections.*;
import static java.util.Objects.*;

import static com.globalmentor.java.Classes.*;

import java.util.*;

import com.globalmentor.iso.idcard.*;
import com.globalmentor.java.Arrays;

/**
 * A validator to validate a Primary Account Number (PAN) of an identification card as defined in ISO/IEC 7812-1:2000(E),
 * "Identification cards - Identification of issuers - Part 1: Numbering system". The validator ensures that the PAN represents one of the allowed ID card
 * products. PANs for unknown products are considered invalid.
 * @see IDCard
 */
public class PANValidator extends AbstractValidator { //TODO add http://www.darkcoding.net/index.php/credit-card-numbers/ reference

	/** The valid products bound property. */
	public static final String VALID_PRODUCTS_PROPERTY = getPropertyName(PANValidator.class, "validProducts");

	/** The read-only set of valid products. */
	private Set validProducts;

	/** @return The read-only set of valid products. */
	public Set getValidProducts() {
		return validProducts;
	}

	/**
	 * Sets the PAN products that the validator considers valid. This is a bound property.
	 * @param newValidProducts The set of valid products.
	 * @throws NullPointerException if the given set of valid products is null.
	 * @see #VALID_PRODUCTS_PROPERTY
	 */
	public void setValidProducts(final Set newValidProducts) {
		if(!validProducts.equals(requireNonNull(newValidProducts, "Valid products cannot be null."))) { //if the value is really changing
			final Set oldValidProducts = validProducts; //get the current value
			this.validProducts = unmodifiableSet(new HashSet(newValidProducts)); //create a new unmodifiable copy set of valid products
			firePropertyChange(VALID_PRODUCTS_PROPERTY, oldValidProducts, validProducts);
		}
	}

	/**
	 * Sets the PAN products that the validator considers valid. This is a bound property. This implementation delegates to {@link #setValidProducts(Set)}
	 * @param validProducts The products that are allowed, if any.
	 * @throws NullPointerException if the given array of valid products is null.
	 * @see #VALID_PRODUCTS_PROPERTY
	 */
	public void setValidProducts(final Product... validProducts) {
		final Set validProductSet = new HashSet(); //create a new set of valid products
		addAll(validProductSet, requireNonNull(validProducts, "Valid products cannot be null.")); //add all the specified valid products to our set
		setValidProducts(validProductSet); //set the valid products
	}

	/**
	 * Valid products constructor with no value required.
	 * @param validProducts The products that are allowed, if any.
	 * @throws NullPointerException if the given array of valid products is null.
	 */
	public PANValidator(final Product... validProducts) {
		this(false, validProducts); //construct the class without requiring a value
	}

	/**
	 * Value required constructor accepting all known products.
	 * @param valueRequired Whether the value must be non-null in order to be considered valid.
	 */
	public PANValidator(final boolean valueRequired) {
		this(valueRequired, Product.values()); //construct the class, accepting all known products
	}

	/**
	 * Value required and valid products constructor.
	 * @param valueRequired Whether the value must be non-null in order to be considered valid.
	 * @param validProducts The products that are allowed, if any.
	 * @throws NullPointerException if the given array of valid products is null.
	 */
	public PANValidator(final boolean valueRequired, final Product... validProducts) {
		super(valueRequired); //construct the parent class
		final Set validProductSet = new HashSet(); //create a new set of valid products
		addAll(validProductSet, requireNonNull(validProducts, "Valid products cannot be null.")); //add all the specified valid products to our set
		this.validProducts = unmodifiableSet(validProductSet); //save the set of valid products
	}

	/**
	 * {@inheritDoc}
	 * 
	 * This version determines whether a given PAN represents one of the supported products and is the correct length.
	 * 
	 */
	@Override
	public void validate(final PAN value) throws ValidationException {
		super.validate(value); //do the default validation
		if(value != null) { //if the value passed default validation checks and isn't null
			final Product product = IDCard.getProduct(value); //get the product for this PAN
			if(product == null) { //if we don't know the product
				throwInvalidValueValidationException(value); //the PAN isn't valid to us TODO create specific message
			}
			if(!validProducts.contains(product)) { //if this isn't a supported product
				throwInvalidValueValidationException(value); //this isn't one of the values we accept TODO create specific message
			}
			if(!Arrays.contains(product.getPANLengths(), value.toString().length())) { //if this product doesn't accept this PAN length
				throwInvalidValueValidationException(value); //indicate that the PAN is invalid for this product TODO create specific message
			}
		}
	}

}