org.apache.commons.validator

Class CreditCardValidator


public class CreditCardValidator
extends java.lang.Object

Perform credit card validations.

By default, all supported card types are allowed. You can specify which cards should pass validation by configuring the validation options. For example,
CreditCardValidator ccv = new CreditCardValidator(CreditCardValidator.AMEX + CreditCardValidator.VISA); configures the validator to only pass American Express and Visa cards. If a card type is not directly supported by this class, you can implement the CreditCardType interface and pass an instance into the addAllowedCardType method. For a similar implementation in Perl, reference Sean M. Burke's script. More information is also available here.

Version:
$Revision: 478334 $ $Date: 2006-11-22 21:31:54 +0000 (Wed, 22 Nov 2006) $
Since:
Validator 1.1

Nested Class Summary

private class
CreditCardValidator.Amex
static interface
CreditCardValidator.CreditCardType
CreditCardType implementations define how validation is performed for one type/brand of credit card.
private class
CreditCardValidator.Discover
private class
CreditCardValidator.Mastercard
private class
CreditCardValidator.Visa
Change to support Visa Carte Blue used in France has been removed - see Bug 35926

Field Summary

static int
AMEX
Option specifying that American Express cards are allowed.
static int
DISCOVER
Option specifying that Discover cards are allowed.
static int
MASTERCARD
Option specifying that Mastercard cards are allowed.
static int
NONE
Option specifying that no cards are allowed.
static int
VISA
Option specifying that Visa cards are allowed.
private Collection
cardTypes
The CreditCardTypes that are allowed to pass validation.

Constructor Summary

CreditCardValidator()
Create a new CreditCardValidator with default options.
CreditCardValidator(int options)
Create a new CreditCardValidator with the specified options.

Method Summary

void
addAllowedCardType(CreditCardValidator.CreditCardType type)
Add an allowed CreditCardType that participates in the card validation algorithm.
boolean
isValid(String card)
Checks if the field is a valid credit card number.
protected boolean
luhnCheck(String cardNumber)
Checks for a valid credit card number.

Field Details

AMEX

public static final int AMEX
Option specifying that American Express cards are allowed.
Field Value:
1

DISCOVER

public static final int DISCOVER
Option specifying that Discover cards are allowed.
Field Value:
8

MASTERCARD

public static final int MASTERCARD
Option specifying that Mastercard cards are allowed.
Field Value:
4

NONE

public static final int NONE
Option specifying that no cards are allowed. This is useful if you want only custom card types to validate so you turn off the default cards with this option.
 CreditCardValidator v = new CreditCardValidator(CreditCardValidator.NONE);
 v.addAllowedCardType(customType);
 v.isValid(aCardNumber);
 
Field Value:
0
Since:
Validator 1.1.2

VISA

public static final int VISA
Option specifying that Visa cards are allowed.
Field Value:
2

cardTypes

private Collection cardTypes
The CreditCardTypes that are allowed to pass validation.

Constructor Details

CreditCardValidator

public CreditCardValidator()
Create a new CreditCardValidator with default options.

CreditCardValidator

public CreditCardValidator(int options)
Create a new CreditCardValidator with the specified options.
Parameters:
options - Pass in CreditCardValidator.VISA + CreditCardValidator.AMEX to specify that those are the only valid card types.

Method Details

addAllowedCardType

public void addAllowedCardType(CreditCardValidator.CreditCardType type)
Add an allowed CreditCardType that participates in the card validation algorithm.
Parameters:
type - The type that is now allowed to pass validation.
Since:
Validator 1.1.2

isValid

public boolean isValid(String card)
Checks if the field is a valid credit card number.
Parameters:
card - The card number to validate.
Returns:
Whether the card number is valid.

luhnCheck

protected boolean luhnCheck(String cardNumber)
Checks for a valid credit card number.
Parameters:
cardNumber - Credit Card Number.
Returns:
Whether the card number passes the luhnCheck.

Copyright (c) 2001-2004 Apache Software Foundation