atg.payment.creditcard

Class CreditCardTools

java.lang.Object

atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

atg.nucleus.GenericService

atg.payment.creditcard.CreditCardTools

All Implemented Interfaces:

PaymentTypeProvider, atg.core.logging.Logging, atg.core.logging.TraceLogging, atg.naming.AbsoluteNameable, NameContextBindingListener, NameContextElement, atg.naming.NameContextParentable, NameResolver, AdminableService, atg.nucleus.Configured, ApplicationLogging, atg.nucleus.logging.ApplicationLoggingSender, atg.nucleus.logging.TraceApplicationLogging, VariableArgumentApplicationLogging, ComponentNameResolver, Service, ServiceListener, java.util.EventListener

public class CreditCardTools
extends GenericService
implements PaymentTypeProvider

This class contains methods which contain functionality useful in dealing with credit cards.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CARD_EXP_DATE_NOT_VALID
static int	CARD_EXPIRED
static int	CARD_INFO_NOT_VALID
static int	CARD_LENGTH_NOT_VALID
static int	CARD_NUMBER_DOESNT_MATCH_TYPE
static int	CARD_NUMBER_HAS_INVALID_CHARS
static int	CARD_NUMBER_NOT_VALID
static int	CARD_TYPE_NOT_VALID
static java.lang.String	CLASS_VERSION Class version string
protected java.util.Map<java.lang.String,PaymentType>	mSupportedPaymentTypesByVariation
static int	SUCCESS
static java.lang.String	SUPPORTED_PAYMENT_GROUP

Fields inherited from class atg.nucleus.GenericService

SERVICE_INFO_KEY

Fields inherited from interface atg.nucleus.logging.TraceApplicationLogging

DEFAULT_LOG_TRACE_STATUS

Fields inherited from interface atg.nucleus.logging.ApplicationLogging

DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS

Constructor Summary

Constructors

Constructor and Description
CreditCardTools()

Method Summary

Modifier and Type	Method and Description
protected static java.lang.String	Code(java.lang.String iName) Get a code, given a name
protected java.lang.String	createCreditCardResourceKey(java.lang.String pFirstPartOfResourceName, java.lang.String pSecondPartOfResourceName) Creates the resource name for a credit card payment type.
protected java.util.Map<java.lang.String,PaymentType>	createSupportedPaymentTypesMap() Creates a map of payment types (keyed by the payment type variation) supported by this class.
void	doStartService() This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values.
java.util.Properties	getCardCodesMap()
java.util.Properties	getCardLengthsMap()
java.util.Properties	getCardPrefixesMap()
java.util.Properties	getCardTypesMap()
atg.payment.creditcard.ExtendableCreditCardTools	getCreditCardTools()
java.util.Map<java.lang.String,java.lang.String>	getPaymentGroupSubstitutionMap() Return the map which allows one payment group identifier to be mapped to another.
protected PaymentType	getPaymentType(java.lang.String pPaymentGroupIdentifier, java.lang.String pPaymentTypeVariation) Given a payment group identifier and an optional payment type variation, choose a matching payment type.
PaymentType	getPaymentTypeForPaymentGroup(PaymentGroup pPaymentGroup) Get a payment type object for a specific payment group which has a payment amount greater than zero.
PaymentType	getPaymentTypeForString(java.lang.String pPaymentGroupIdentifier, java.lang.String pPaymentTypeString) Create a payment type object based upon a formatted string.
static java.lang.String	getStatusCodeMessage(int pCode) This method returns an error string which maps to the supplied status code.
static java.lang.String	getStatusCodeMessage(int pCode, java.util.Locale pLocale) This method returns an error string which maps to the supplied status code.
java.lang.String	getSupportedPaymentGroup() Get the payment group identifier which this class manages the payment types for.
java.util.Set<PaymentType>	getSupportedPaymentTypes(java.lang.String pPaymentGroupIdentifier) Get payment type objects for all payment type variations associated with the payment group identifier passed in.
protected static boolean	isNumber(java.lang.String pNumber) Check to see if this is a number
protected static boolean	isValidCardNumberLength(java.lang.String iTypeName, java.lang.String iNumber) Check the length of a credit card number against it's card type.
protected static boolean	isValidCardType(java.lang.String iTypeName, java.lang.String iNumber) Check a credit card number against it's card type.
protected static java.lang.String	Name(java.lang.String iCode) Get a name, given a code
void	setCardCodesMap(java.util.Properties pCardCodesMap)
void	setCardLengthsMap(java.util.Properties pCardLengthsMap)
void	setCardPrefixesMap(java.util.Properties pCardPrefixesMap)
void	setCardTypesMap(java.util.Properties pCardTypesMap)
void	setCreditCardTools(atg.payment.creditcard.ExtendableCreditCardTools pCreditCardTools)
void	setPaymentGroupSubstitutionMap(java.util.Map<java.lang.String,java.lang.String> pPaymentGroupSubstitutionMap) Set the map which allows one payment group identifier to be mapped to another.
void	setSupportedPaymentGroup(java.lang.String pSupportedPaymentGroup) Set the payment group identifier which this class acts as a payment type provider for.
protected java.lang.String	substitutePaymentGroupIdentifier(java.lang.String pPaymentGroupIdentifier) Swap one payment group identifier for another.
protected static boolean	validateCheckDigit(java.lang.String iNumber) Validate a credit card number's checksum.
static int	verifyCreditCard(CreditCardInfo pCreditCard) This method does basic credit card verification, such as comparing the expiration date to the current date and verifying that the credit card number conforms to simple algorithm.
static int	verifyCreditCard(CreditCardInfo pCreditCard, boolean pCheckExpired) This method does basic credit card verification, such as comparing the expiration date to the current date and verifying that the credit card number conforms to simple algorithm.
protected static int	verifyCreditCard(CreditCardInfo pCreditCard, java.lang.String number, java.lang.String type)
protected static int	verifyCreditCardDate(CreditCardInfo pCreditCard, java.lang.String pExpMonth, java.lang.String pExpDayOfMonth, java.lang.String pExpYear)

Methods inherited from class atg.nucleus.GenericService

addLogListener, createAdminServlet, doStopService, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logDebug, logError, logError, logError, logInfo, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService, toString

Methods inherited from class atg.nucleus.logging.VariableArgumentApplicationLoggingImpl

vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CLASS_VERSION

public static java.lang.String CLASS_VERSION

Class version string

SUCCESS

public static final int SUCCESS

See Also:

Constant Field Values

CARD_EXPIRED

public static final int CARD_EXPIRED

See Also:

Constant Field Values

CARD_NUMBER_HAS_INVALID_CHARS

public static final int CARD_NUMBER_HAS_INVALID_CHARS

See Also:

Constant Field Values

CARD_NUMBER_DOESNT_MATCH_TYPE

public static final int CARD_NUMBER_DOESNT_MATCH_TYPE

See Also:

Constant Field Values

CARD_LENGTH_NOT_VALID

public static final int CARD_LENGTH_NOT_VALID

See Also:

Constant Field Values

CARD_NUMBER_NOT_VALID

public static final int CARD_NUMBER_NOT_VALID

See Also:

Constant Field Values

CARD_INFO_NOT_VALID

public static final int CARD_INFO_NOT_VALID

See Also:

Constant Field Values

CARD_EXP_DATE_NOT_VALID

public static final int CARD_EXP_DATE_NOT_VALID

See Also:

Constant Field Values

CARD_TYPE_NOT_VALID

public static final int CARD_TYPE_NOT_VALID

See Also:

Constant Field Values

SUPPORTED_PAYMENT_GROUP

public static final java.lang.String SUPPORTED_PAYMENT_GROUP

See Also:

Constant Field Values

mSupportedPaymentTypesByVariation

protected java.util.Map<java.lang.String,PaymentType> mSupportedPaymentTypesByVariation

Constructor Detail

CreditCardTools

public CreditCardTools()

Method Detail

getCreditCardTools

public atg.payment.creditcard.ExtendableCreditCardTools getCreditCardTools()

setCreditCardTools

public void setCreditCardTools(atg.payment.creditcard.ExtendableCreditCardTools pCreditCardTools)

getCardTypesMap

public java.util.Properties getCardTypesMap()

setCardTypesMap

public void setCardTypesMap(java.util.Properties pCardTypesMap)

getSupportedPaymentGroup

public java.lang.String getSupportedPaymentGroup()

Get the payment group identifier which this class manages the payment types for.

Returns:

A payment group identifier if one was set, otherwise null.

setSupportedPaymentGroup

public void setSupportedPaymentGroup(java.lang.String pSupportedPaymentGroup)

Set the payment group identifier which this class acts as a payment type provider for.

Parameters:

pSupportedPaymentGroup -

getCardCodesMap

public java.util.Properties getCardCodesMap()

setCardCodesMap

public void setCardCodesMap(java.util.Properties pCardCodesMap)

getCardPrefixesMap

public java.util.Properties getCardPrefixesMap()

setCardPrefixesMap

public void setCardPrefixesMap(java.util.Properties pCardPrefixesMap)

getCardLengthsMap

public java.util.Properties getCardLengthsMap()

setCardLengthsMap

public void setCardLengthsMap(java.util.Properties pCardLengthsMap)

getPaymentGroupSubstitutionMap

public java.util.Map<java.lang.String,java.lang.String> getPaymentGroupSubstitutionMap()

Return the map which allows one payment group identifier to be mapped to another. For example, 'tokenizedCreditCard' is by default mapped to 'creditCard' meaning that all callers who request a payment type for 'tokenizedCreditCard' will receive the payment type for 'creditCard'. This allows 'tokenizedCreditCard' and 'creditCard' to differ at lower levels, but for operations such as tender type promotion evaluation to be considered as the same payment type.

Returns:

The map which can be used to substitute one payment group identifier for another.

setPaymentGroupSubstitutionMap

public void setPaymentGroupSubstitutionMap(java.util.Map<java.lang.String,java.lang.String> pPaymentGroupSubstitutionMap)

Set the map which allows one payment group identifier to be mapped to another.

See Also:

getPaymentGroupSubstitutionMap()

getStatusCodeMessage

public static java.lang.String getStatusCodeMessage(int pCode)

This method returns an error string which maps to the supplied status code. The default locale is used for loading the message.

Parameters:

pCode - the status code returned from a method in this class

Returns:

an error string which maps to the status code supplied

getStatusCodeMessage

public static java.lang.String getStatusCodeMessage(int pCode,
                                                    java.util.Locale pLocale)

This method returns an error string which maps to the supplied status code. The supplied Locale is used for loading the message.

Parameters:

pCode - the status code returned from a method in this class

Returns:

an error string which maps to the status code supplied

verifyCreditCard

public static int verifyCreditCard(CreditCardInfo pCreditCard,
                                   boolean pCheckExpired)

This method does basic credit card verification, such as comparing the expiration date to the current date and verifying that the credit card number conforms to simple algorithm.

Parameters:

pCreditCard - the credit card data

pCheckExpired - whether to check if the card has expired

Returns:

a status code

verifyCreditCard

public static int verifyCreditCard(CreditCardInfo pCreditCard)

This method does basic credit card verification, such as comparing the expiration date to the current date and verifying that the credit card number conforms to simple algorithm.

Parameters:

pCreditCard - the credit card data

Returns:

a status code

verifyCreditCardDate

protected static int verifyCreditCardDate(CreditCardInfo pCreditCard,
                                          java.lang.String pExpMonth,
                                          java.lang.String pExpDayOfMonth,
                                          java.lang.String pExpYear)

verifyCreditCard

protected static int verifyCreditCard(CreditCardInfo pCreditCard,
                                      java.lang.String number,
                                      java.lang.String type)

validateCheckDigit

protected static boolean validateCheckDigit(java.lang.String iNumber)

Validate a credit card number's checksum. This is kinda neat. The last digit of all credit cards is acutally a "check digit", and can be determined by performing a checksum on all the digits that precede it. The checksum is referred to in the credit card industry as a "MOD 10 check digit routine".

Each digit,except the last is multipled by a "weight", to produce a digit "value". The weight alternates between 2 and 1, starting with 2 for the last (right most) digit. The resulting values are summed. To sum the results, single digit values are simply added to the total. For two digit values the tens and the ones digits are added separately, so 14 = 1+4 = 5. Then to test the check digit take the total MOD 10 and subtract it from ten. This should equal the check digit.

isNumber

protected static boolean isNumber(java.lang.String pNumber)

Check to see if this is a number

Code

protected static java.lang.String Code(java.lang.String iName)

Get a code, given a name

Parameters:

iName - credit card type name

Name

protected static java.lang.String Name(java.lang.String iCode)

Get a name, given a code

Parameters:

iCode - two letter credit card type code

isValidCardType

protected static boolean isValidCardType(java.lang.String iTypeName,
                                         java.lang.String iNumber)

Check a credit card number against it's card type. Different types of cards have different allowable prefixes in their numbers. This check currently allows a few Type II errors, but can never havea Type I error, i.e. we can let a few bougs numbers slip by (cuz they'll get caught later), but we cannot reject any valid numbers.

Parameters:

iTypeName - full name of card type (Visa, MasterCard)

iNumber - normalized card number

isValidCardNumberLength

protected static boolean isValidCardNumberLength(java.lang.String iTypeName,
                                                 java.lang.String iNumber)

Check the length of a credit card number against it's card type. Different types of cards have different allowable lengths. Actually all of them have exactly one allowable length, except for Visa cards, which can either be 13 or 16 digits.

Parameters:

iTypeName - full name of card type (Visa, MasterCard)

iNumber - normalized card number

getSupportedPaymentTypes

public java.util.Set<PaymentType> getSupportedPaymentTypes(java.lang.String pPaymentGroupIdentifier)
                                                    throws InvalidParameterException

Get payment type objects for all payment type variations associated with the payment group identifier passed in.

Specified by:

getSupportedPaymentTypes in interface PaymentTypeProvider

Parameters:

pPaymentGroupIdentifier - An identifier for the group we're going to get payment types for.

Returns:

A set of payment types corresponding to the payment group identifier passed in.

Throws:

InvalidParameterException - if the payment group identifier passed in was deemed invalid.

substitutePaymentGroupIdentifier

protected java.lang.String substitutePaymentGroupIdentifier(java.lang.String pPaymentGroupIdentifier)

Swap one payment group identifier for another. This is intended to support the idea of considering multiple payment groups as ultimately representing the same payment types. The standard example of this is tokenized credit card versus traditional credit card. There are differences at a certain level, which mean at lower levels they must be represented by different payment groups, but once we're at the higher level of, for example, evaluating promotions, there is no meaningful difference. Hence this method method can be used to help say "If the identifier is X then treat it as if it was Y".

Returns:

A string containing the new payment group identifier if a substitute was found, or the original identifier if no substitute was found.

getPaymentTypeForPaymentGroup

public PaymentType getPaymentTypeForPaymentGroup(PaymentGroup pPaymentGroup)
                                          throws InvalidParameterException

Get a payment type object for a specific payment group which has a payment amount greater than zero.

Specified by:

getPaymentTypeForPaymentGroup in interface PaymentTypeProvider

Parameters:

pPaymentGroup - The payment group whose payment type we're interested in.

Returns:

A single payment type object representing the payment group passed in.

Throws:

InvalidParameterException - if the payment group identifier passed in was deemed invalid.

getPaymentTypeForString

public PaymentType getPaymentTypeForString(java.lang.String pPaymentGroupIdentifier,
                                           java.lang.String pPaymentTypeString)
                                    throws InvalidParameterException

Create a payment type object based upon a formatted string.

Specified by:

getPaymentTypeForString in interface PaymentTypeProvider

Parameters:

pPaymentGroupIdentifier - An identifier for the payment group which the payment type will related to.

pPaymentTypeString - The original payment string will have consisted of the group identifier followed by other info specific to that payment type. So this is the rest of the string minus the group identifier (and first delimiter). It will be up to individual providers what to do with this information, but one expected use will be that it denotes a variation of a payment group type.

Returns:

A payment type object representing the strings passed in.

Throws:

InvalidParameterException - if the payment group identifier passed in was deemed invalid.

getPaymentType

protected PaymentType getPaymentType(java.lang.String pPaymentGroupIdentifier,
                                     java.lang.String pPaymentTypeVariation)
                              throws InvalidParameterException

Given a payment group identifier and an optional payment type variation, choose a matching payment type.

Parameters:

pPaymentGroupIdentifier - The identifier for the payment group e.g. creditCard.

pPaymentTypeVariation - The specific variation of the payment type e.g. visa

Returns:

An appropriate payment type object if one was found. Otherwise, null.

Throws:

InvalidParameterException - if the payment group identifier is unknown.

createCreditCardResourceKey

protected java.lang.String createCreditCardResourceKey(java.lang.String pFirstPartOfResourceName,
                                                       java.lang.String pSecondPartOfResourceName)

Creates the resource name for a credit card payment type.

Parameters:

pFirstPartOfResourceName - The first part of the resource's name

pSecondPartOfResourceName - The second part of the resource's name

Returns:

A correctly formatted resource name based upon the two parameters passed in.

createSupportedPaymentTypesMap

protected java.util.Map<java.lang.String,PaymentType> createSupportedPaymentTypesMap()

Creates a map of payment types (keyed by the payment type variation) supported by this class.

Returns:

a map, keyed by variation, of all payment types supported by this payment type provider.

doStartService

public void doStartService()
                    throws ServiceException

This is called after a Service has been created, placed into the naming hierarchy, and initialized with its configured property values. The Service should override this method to start any processes it requires.

Overrides:

doStartService in class GenericService

Throws:

ServiceException - if the Service had a problem starting up