com.konakart.bl.modules.payment

Class BasePaymentModule

java.lang.Object

com.konakart.bl.modules.BaseModule

com.konakart.bl.modules.payment.BasePaymentModule

Direct Known Subclasses:

BankTransfer, BarclaycardSmartPayApi, BarclaycardSmartPayHosted, Bluepay, Caledon, Cod, CommideaVanguard, CustomerCard, CyberSourceSA, Elink, Eway_au, GlobalCollect, MoneyBookers, Netpayintl, PayflowPro, Payjunction, Paypal, Usaepay, Worldpay, WorldPayXMLRedirect

public class BasePaymentModule
extends BaseModule

Base class for Payment Modules.

Field Summary

Fields

Modifier and Type	Field and Description
protected org.apache.commons.logging.Log	log The Log instance for this application.

Fields inherited from class com.konakart.bl.modules.BaseModule

basePackage, debugStackTraceExclusions

Constructor Summary

Constructors

Constructor and Description
BasePaymentModule()

Method Summary

Modifier and Type	Method and Description
protected void	addParameters(PaymentDetailsIf pd, java.util.List<NameValueIf> newParameters) Add more parameters to the PaymentDetails object.
protected void	checkZone(PaymentInfo info, int geoZoneId) Ensures that the geoZoneId is within one of the Geo Zones contained in the PaymentInfo object.
protected java.lang.String	getCustomerSessionIdByCustomerId(int customerId) Look up the sessionId for the specified customerId.
protected java.lang.String[]	getFirstAndLastNamesFromAddress(int addrId) Look up the first name and last name using the AddressId.
protected java.lang.String	getIPAddress() Return the IP address of the current machine
protected KKCriteria	getNewCriteria(boolean allStores) Gets a new KKCriteria object with the option of it being for all stores when in multi-store single db mode.
PaymentDetails	getPaymentDetailsCustom(java.lang.String sessionId, NameValueIf[] parameters) Method used to return any custom information required from the payment module.
protected java.util.HashMap<java.lang.String,java.lang.String>	hashParameters(PaymentDetailsIf pd, java.util.List<NameValueIf> ccParmList) This method is optionally called from the sub class to load up the parameters into a HashTable for efficient subsequent processing
protected boolean	isGeoZoneMappedToCountry(int geoZoneId, int countryId) In some cases no zones may be defined for a country but a geo zone may be defined to map to all zones of that country.
protected boolean	isMultiStoreShareCustomers() Returns true if we need to share customers in multi-store single db mode
protected java.lang.String[]	splitNameIntoFirstAndLastNames(java.lang.String name) Deprecated. Replaced by a more robust solution where the address is looked up splitStreetAddressIntoNumberAndStreet(String streetAddress)
protected java.lang.String[]	splitStreetAddressIntoNumberAndStreet(java.lang.String streetAddress) Split the street address into house number and street using simple logic...

Methods inherited from class com.konakart.bl.modules.BaseModule

getBasketMgr, getCatMgr, getConfigMgr, getConfiguration, getConfigurationValue, getConfigurationValueAsBigDecimalWithDefault, getConfigurationValueAsBool, getConfigurationValueAsIntWithDefault, getCurrMgr, getCustMgr, getCustTagMgr, getDebugStackTraceExclusions, getEmailMgr, getEng, getLangMgr, getModuleClassName, getMultiStoreMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getPromMgr, getRandomText, getRandomText, getResourceBundle, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getTaxMgr, getZoneCodeForZoneName, init, isAvailable, isAvailable, isMultiStoreShareCustomersOrProducts, setDebugStackTraceExclusions, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected org.apache.commons.logging.Log log

The Log instance for this application.

Constructor Detail

BasePaymentModule

public BasePaymentModule()

Method Detail

checkZone

protected void checkZone(PaymentInfo info,
                         int geoZoneId)
                  throws com.konakart.app.KKException

Ensures that the geoZoneId is within one of the Geo Zones contained in the PaymentInfo object.

Parameters:

info - the info

geoZoneId - the geoZoneId

Throws:

com.konakart.app.KKException - an unexpected KKException exception

isGeoZoneMappedToCountry

protected boolean isGeoZoneMappedToCountry(int geoZoneId,
                                           int countryId)

In some cases no zones may be defined for a country but a geo zone may be defined to map to all zones of that country. On these occasions the DeliveryGeoZoneArray in the ShippingInfo object is null so the checkZone method never returns true.

This method does a search in the zones_to_geo_zones table for any entries matching the geoZoneId, countryId and zoneId of 0 which is the id that is set when the mapping is for all zones of the country.

Parameters:

geoZoneId - the geoZoneId

countryId - the countryId

Returns:

Returns true if there is a mapping

getCustomerSessionIdByCustomerId

protected java.lang.String getCustomerSessionIdByCustomerId(int customerId)

Look up the sessionId for the specified customerId. You may need to add an index on the customer_id column for this to work efficiently if you have many records in the session table. You should also run maintenance jobs on the session table to remove old sessions.

Parameters:

customerId - the customerId

Returns:

the sessionId if found or null

isMultiStoreShareCustomers

protected boolean isMultiStoreShareCustomers()
                                      throws com.konakart.app.KKException

Returns true if we need to share customers in multi-store single db mode

Returns:

the multiStoreShareCustomers

Throws:

com.konakart.app.KKException - an unexpected KKException exception

getNewCriteria

protected KKCriteria getNewCriteria(boolean allStores)

Gets a new KKCriteria object with the option of it being for all stores when in multi-store single db mode.

Overrides:

getNewCriteria in class BaseModule

Parameters:

allStores - the allStores

Returns:

Returns a new KKCriteria object

getFirstAndLastNamesFromAddress

protected java.lang.String[] getFirstAndLastNamesFromAddress(int addrId)
                                                      throws java.lang.Exception

Look up the first name and last name using the AddressId. Return them as two Strings in an array. If there is no such address null is returned.

Parameters:

addrId - the id of the address to look up

Returns:

a String array where the first element is the first name and the second element is the surname. Returns null if the address cannot be found.

Throws:

java.lang.Exception - an unexpected exception

splitNameIntoFirstAndLastNames

@Deprecated
protected java.lang.String[] splitNameIntoFirstAndLastNames(java.lang.String name)

Deprecated. Replaced by a more robust solution where the address is looked up splitStreetAddressIntoNumberAndStreet(String streetAddress)

Split the name into first name and surname using simple logic... The surname is assumed to be the last whitespace-separated item; everything before that is used as the first name.

Parameters:

name - the name as a String to convert.

Returns:

a String array where the first element is the first name and the second element is the surname.

splitStreetAddressIntoNumberAndStreet

protected java.lang.String[] splitStreetAddressIntoNumberAndStreet(java.lang.String streetAddress)

Split the street address into house number and street using simple logic... The house number is assumed to be the number at the start of the String if present. The rest is assumed to be the street.

Parameters:

streetAddress - the streetAddress as a String to convert.

Returns:

a String array where the first element is the house number (if found) and the second element is the street address without the house number if that was found.

hashParameters

protected java.util.HashMap<java.lang.String,java.lang.String> hashParameters(PaymentDetailsIf pd,
                                                                              java.util.List<NameValueIf> ccParmList)

This method is optionally called from the sub class to load up the parameters into a HashTable for efficient subsequent processing

Parameters:

pd - PaymentDetails object

ccParmList - name value pair list of CC parameters

Returns:

a hash map containing the parameters for rapid lookup

addParameters

protected void addParameters(PaymentDetailsIf pd,
                             java.util.List<NameValueIf> newParameters)

Add more parameters to the PaymentDetails object. Normally this method would be on the PaymentDetails class but it's placed here instead because of the automatic code generation that occurs on the PaymentDetails class for web services, JSON and RMI etc.

Parameters:

pd - the PaymentDetails object

newParameters - The parameters to set.

getIPAddress

protected java.lang.String getIPAddress()
                                 throws com.konakart.app.KKException

Return the IP address of the current machine

Returns:

the IP address of the current machine as a String

Throws:

com.konakart.app.KKException - an unexpected exception from the KonaKart engine

getPaymentDetailsCustom

public PaymentDetails getPaymentDetailsCustom(java.lang.String sessionId,
                                              NameValueIf[] parameters)
                                       throws java.lang.Exception

Method used to return any custom information required from the payment module. When used, this method will typically be overridden in the module.

Parameters:

sessionId - the sessionId

parameters - the parameters

Returns:

Returns information in a PaymentDetails object

Throws:

java.lang.Exception - an unexpected exception