com.konakart.bl.modules.payment

Class PaymentMgr

java.lang.Object

com.konakart.bl.BaseMgr

com.konakart.bl.modules.payment.PaymentMgr

All Implemented Interfaces:

PaymentMgrIf

public class PaymentMgr
extends BaseMgr
implements PaymentMgrIf

PaymentMgr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PaymentMgr.SortOrderComparator
protected class	PaymentMgr.StaticData Used to store the static data of this manager

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	MODULE_PAYMENT_INSTALLED
protected static java.lang.String	mutex
protected static java.util.Map<java.lang.String,PaymentMgr.StaticData>	staticDataHM Hash Map that contains the static data

Fields inherited from class com.konakart.bl.BaseMgr

templateBaseDir

Constructor Summary

Constructors

Constructor and Description
PaymentMgr(KKEngIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addCurrencyToOrder(Order order) Ensure that the order has the currency object instantiated.
protected java.lang.String	getJavaModuleName(java.lang.String moduleName) Whatever the module name is, the package name is the module name in lowercase and the class name starts with an upper case character
PaymentDetails	getPaymentDetails(java.lang.String sessionId, java.lang.String moduleCode, int orderId, java.lang.String hostAndPort, int languageId) This method is called once a payment gateway has been selected and an order has been saved in the database.
PaymentDetails	getPaymentDetailsCustom(java.lang.String sessionId, java.lang.String moduleCode, NameValueIf[] parameters) Method used to return any custom information required from the payment module.
PaymentDetails	getPaymentDetailsPerOrder(java.lang.String sessionId, java.lang.String moduleCode, OrderIf order, java.lang.String hostAndPort, int languageId) This method is called once a payment gateway has been selected even if the order has not been saved in the database.
PaymentDetails	getPaymentGateway(OrderIf order, java.lang.String moduleName, int languageId) Return the PaymentDetail object for one payment gateway.
PaymentDetails[]	getPaymentGateways(OrderIf order, int languageId) Each payment module is called and asked to return a PaymentDetails object.
protected PaymentDetails[]	getPaymentGatewaysPrivate(OrderIf order, java.lang.String moduleName, int languageId)
protected PaymentInfo	getPaymentInfo(Order order, int languageId) Returns a partially filled payment info object
protected PaymentInterface	getPaymentModuleForName(java.lang.String moduleName) Called to instantiate a payment module.
protected boolean	isEnhancedVariantHandlingModeEnabled()
protected boolean	isOnlyBraintree(OrderProductIf[] products) Check if only braintree payment method is accepted.
void	refreshConfigs() Refreshes the configuration data for this manager

Methods inherited from class com.konakart.bl.BaseMgr

acquireLock, addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkRequired, escapeHTML, executeQuery, executeQuery, executeQuery, executeQuery, executeQuery, getAdminEngMgr, getBasketMgr, getBillingMgr, getBookableProductMgr, getCacheMgr, getCatMgr, getConfigMgr, getCookieMgr, getCurrMgr, getCustMgr, getCustomerIdFromSession, getCustomerStatsMgr, getCustomerTagMgr, getEmailMgr, getEng, getEventMgr, getExportMgr, getHTMLEscaper, getKonaKartConfig, getKonaKartConfig, getKonaKartConfig, getLangMgr, getManuMgr, getMiscItemMgr, getMiscPriceMgr, getMode, getModeString, getMqMgr, getMultiStoreMgr, getNewCriteria, getNewCriteria, getOrderIntegrationMgr, getOrderMgr, getOrderTotalMgr, getPaymentMgr, getProdMgr, getProductsToCategoresCriteria, getPromMgr, getPunchOutMgr, getRewardPointMgr, getSecMgr, getShippingMgr, getSolrMgr, getStoreId, getStoreMgr, getStoreTime, getSuggestionMgr, getTaxMgr, getTemplate, getTemplateRoot, getVelocityContextMgr, getWishListMgr, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isClassPresent, isCommunity, isDeadlockException, isEnterprise, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreSharedDb, isMultiStoreShareProducts, isMultiVendor, isUnix, manageThrowable, releaseLock, updateStaticVariablesNow

Methods inherited from class java.lang.Object

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

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

mutex

protected static java.lang.String mutex

staticDataHM

protected static java.util.Map<java.lang.String,PaymentMgr.StaticData> staticDataHM

Hash Map that contains the static data

MODULE_PAYMENT_INSTALLED

protected static final java.lang.String MODULE_PAYMENT_INSTALLED

See Also:

Constant Field Values

Constructor Detail

PaymentMgr

public PaymentMgr(KKEngIf eng)
           throws java.lang.Exception

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Description copied from interface: PaymentMgrIf

Refreshes the configuration data for this manager

Specified by:

refreshConfigs in interface PaymentMgrIf

Throws:

java.lang.Exception - an unexpected exception

getJavaModuleName

protected java.lang.String getJavaModuleName(java.lang.String moduleName)

Whatever the module name is, the package name is the module name in lowercase and the class name starts with an upper case character

Parameters:

moduleName - the moduleName

Returns:

Returns the java compatible name

getPaymentGateways

public PaymentDetails[] getPaymentGateways(OrderIf order,
                                           int languageId)
                                    throws java.lang.Exception

Each payment module is called and asked to return a PaymentDetails object. This method is called during the checkout process before the order has been saved and confirmed by the user. Therefore it does not require the exact details for the payment (i.e. the parameters passed to a payment gateway) since this will be done later for the selected payment module. The returned PaymentDetails object contains the information required for the user to select it and based on the zone of the billing address the module may decide that it cannot process payment for that zone and so not even return a PaymentDetails object.

Specified by:

getPaymentGateways in interface PaymentMgrIf

Parameters:

order - the order

languageId - the languageId

Returns:

Returns an array of PaymentDetail objects

Throws:

java.lang.Exception - an unexpected exception

getPaymentGateway

public PaymentDetails getPaymentGateway(OrderIf order,
                                        java.lang.String moduleName,
                                        int languageId)
                                 throws java.lang.Exception

Return the PaymentDetail object for one payment gateway.

Specified by:

getPaymentGateway in interface PaymentMgrIf

Parameters:

order - the order

moduleName - can be module name on its own or it can be "moduleName~~moduleSubCode" if the module has a subCode

languageId - the languageId

Returns:

Returns an array of PaymentDetail objects

Throws:

java.lang.Exception - an unexpected exception

getPaymentGatewaysPrivate

protected PaymentDetails[] getPaymentGatewaysPrivate(OrderIf order,
                                                     java.lang.String moduleName,
                                                     int languageId)
                                              throws java.lang.Exception

Parameters:

order - the order

moduleName - the moduleName

languageId - the languageId

Returns:

Returns an array of PaymentDetail objects

Throws:

java.lang.Exception - an unexpected exception

getPaymentDetails

public PaymentDetails getPaymentDetails(java.lang.String sessionId,
                                        java.lang.String moduleCode,
                                        int orderId,
                                        java.lang.String hostAndPort,
                                        int languageId)
                                 throws java.lang.Exception

This method is called once a payment gateway has been selected and an order has been saved in the database. The order is read from the database and the details of the payment are retrieved from the order. This ensures that the payment request matches the order exactly.

The module matching the module code is called in order to get a fully populated PaymentDetails object containing all of the required parameters etc. for the payment gateway.

Specified by:

getPaymentDetails in interface PaymentMgrIf

Parameters:

sessionId - the sessionId

moduleCode - the moduleCode

orderId - the orderId

hostAndPort - the hostAndPort

languageId - the languageId

Returns:

Returns a PaymentDetails object

Throws:

java.lang.Exception - an unexpected exception

getPaymentDetailsPerOrder

public PaymentDetails getPaymentDetailsPerOrder(java.lang.String sessionId,
                                                java.lang.String moduleCode,
                                                OrderIf order,
                                                java.lang.String hostAndPort,
                                                int languageId)
                                         throws java.lang.Exception

This method is called once a payment gateway has been selected even if the order has not been saved in the database. The details of the payment are retrieved from the order.

The module matching the module code is called in order to get a fully populated PaymentDetails object containing all of the required parameters etc. for the payment gateway.

Specified by:

getPaymentDetailsPerOrder in interface PaymentMgrIf

Parameters:

sessionId - the sessionId

moduleCode - the moduleCode

order - the order

hostAndPort - the hostAndPort

languageId - the languageId

Returns:

Returns a PaymentDetails object

Throws:

java.lang.Exception - an unexpected exception

getPaymentDetailsCustom

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

Method used to return any custom information required from the payment module.

Specified by:

getPaymentDetailsCustom in interface PaymentMgrIf

Parameters:

sessionId - the sessionId

moduleCode - the moduleCode

parameters - the parameters

Returns:

Returns a PaymentDetails object

Throws:

java.lang.Exception - an unexpected exception

getPaymentInfo

protected PaymentInfo getPaymentInfo(Order order,
                                     int languageId)
                              throws java.lang.Exception

Returns a partially filled payment info object

Parameters:

order - the order

languageId - the languageId

Returns:

Returns a PaymentInfo object

Throws:

java.lang.Exception - an unexpected exception

addCurrencyToOrder

protected void addCurrencyToOrder(Order order)
                           throws java.lang.Exception

Ensure that the order has the currency object instantiated.

Parameters:

order - the order

Throws:

java.lang.Exception - an unexpected exception

getPaymentModuleForName

protected PaymentInterface getPaymentModuleForName(java.lang.String moduleName)
                                            throws java.lang.IllegalArgumentException,
                                                   java.lang.InstantiationException,
                                                   java.lang.IllegalAccessException,
                                                   java.lang.reflect.InvocationTargetException,
                                                   java.lang.ClassNotFoundException

Called to instantiate a payment module. It determines whether the module has a constructor where KKEng is passed in and if it does, then this constructor is used. Otherwise the empty constructor is used.

Parameters:

moduleName - the moduleName

Returns:

Returns an instantiated Payment Module

Throws:

java.lang.IllegalArgumentException - an unexpected IllegalArgumentException exception

java.lang.InstantiationException - an unexpected InstantiationException exception

java.lang.IllegalAccessException - an unexpected IllegalAccessException exception

java.lang.reflect.InvocationTargetException - an unexpected InvocationTargetException exception

java.lang.ClassNotFoundException - an unexpected ClassNotFoundException exception

isOnlyBraintree

protected boolean isOnlyBraintree(OrderProductIf[] products)
                           throws com.konakart.app.KKException

Check if only braintree payment method is accepted.

Parameters:

products - the array of order products

Returns:

true if should accept only braintree payment; false otherwise.

Throws:

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

isEnhancedVariantHandlingModeEnabled

protected boolean isEnhancedVariantHandlingModeEnabled()
                                                throws java.lang.Exception

Throws:

java.lang.Exception