com.konakartadmin.bl

Class AdminImportMgrEE

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminImportMgr

com.konakartadmin.bl.AdminImportMgrEE

All Implemented Interfaces:

AdminImportMgrIf

public class AdminImportMgrEE
extends AdminImportMgr
implements AdminImportMgrIf

Manager for importing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
private class	AdminImportMgrEE.OrderDetails Used to return order information by the method getOrderIdentifier()

Nested classes/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

Fields

Modifier and Type	Field and Description
private static java.lang.String	availableChars
private java.util.HashMap<java.lang.String,AdminCountry>	countryMap
protected static org.apache.commons.logging.Log	log the log

Fields inherited from class com.konakartadmin.bl.AdminImportMgr

appEng

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, debugStackTraceExclusions, kkAdminPropsFilePath, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

Constructors

Constructor and Description
AdminImportMgrEE(KKAdminIf adminEng, com.konakart.appif.KKEngIf appEng) Constructor

Method Summary

Modifier and Type	Method and Description
AdminOption[]	createOptionsFromProductQuantityEncodedKey(java.lang.String encodedKey) Receives an encoded key from the products_quantity table in the format 3{4}4{6} and creates an array of AdminOption objects.
private boolean	doesOrderExistForId(int orderId) Determines whether an order exists for the order id passed in as a parameter
boolean	exportInvoice(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOInvoiceInMsg invoiceMsg) Allows the ERP system to associate an invoice file (typically in PDF format) with a KonaKart order with the option of having the invoice sent out to a customer in an email by KonaKart.
private AdminCountry	getCountryFromIsoCode(java.lang.String iso3Code, java.lang.String isoNumericCode) Find the country from an ISO code
AdminCustomer	getCustomerForEmail(java.lang.String emailAddr) Get customer for email
private java.util.Date	getDefaultIfEmpty(java.util.Date in) Returns a default value for an empty date
private java.lang.String	getDefaultIfEmpty(java.lang.String in) Returns a default value for an empty string
private java.lang.String	getNullIfEmpty(java.lang.String in) Returns null for an empty string
private AdminImportMgrEE.OrderDetails	getOrderIdentifier(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOMsgBase msgBase, java.lang.String orderIdStr, java.lang.String orderNumber) Common code to get an order identifier from the message
private int	getOrderIdForNumber(java.lang.String orderNumber) Get the order Id for the specified order number
private int	getProdIdFromSku(java.lang.String sku, boolean searchVariants) Get the product id from the SKU
java.lang.String	getRandomPassword() Creates a random password
void	log(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOMsgBase msgBase, java.lang.String msg) Common code for writing to the log file
boolean	matchCustomer(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOMatchCustomerInMsg matchInMsg) Method to match a customer that has been registered on the ERP
private boolean	notifyCustomer(int orderStatusId) Determines whether a customer should automatically be notified based on the orderStatusId passed in as a parameter
boolean	paymentCapture(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOPaymentCaptureInMsg captureMsg) In many cases when the customer confirms an order using his credit card, the funds are reserved and not captured until the products are actually shipped.
boolean	registerCustomer(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOCustomerInMsg custInMsg, AdminServletMgrIf servletMgr) Method to register a customer
boolean	updateOrder(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOOrderUpdateInMsg updateMsg) Update the order based on information contained in an IOOrderUpdate object.
boolean	updateProduct(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOProductUpdateInMsg updateMsg) Method to update a product quantity and / or prices.
boolean	updateProductPrices(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOProductPriceUpdateInMsg updateMsg) Method to update the prices of a product.
protected boolean	updateSingleProductPrices(java.lang.StringBuffer logSB, com.konakart.erp.jaxb.IOProductPriceUpdateInMsg updateMsg, com.konakart.erp.jaxb.IOProductPricesContainer container) Method to update the prices of a product.

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, refreshConfigs, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, 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

availableChars

private static final java.lang.String availableChars

See Also:

Constant Field Values

countryMap

private java.util.HashMap<java.lang.String,AdminCountry> countryMap

Constructor Detail

AdminImportMgrEE

public AdminImportMgrEE(KKAdminIf adminEng,
                        com.konakart.appif.KKEngIf appEng)
                 throws java.lang.Exception

Constructor

Parameters:

adminEng - the adminEng

appEng - the appEng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

updateOrder

public boolean updateOrder(java.lang.StringBuffer logSB,
                           com.konakart.erp.jaxb.IOOrderUpdateInMsg updateMsg)
                    throws java.lang.Exception

Update the order based on information contained in an IOOrderUpdate object. The method will update the state of the order and if required will insert a Shipment object with details of the products shipped for the order change.

Specified by:

updateOrder in interface AdminImportMgrIf

Overrides:

updateOrder in class AdminImportMgr

Parameters:

logSB - the logSB

updateMsg - the updateMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

notifyCustomer

private boolean notifyCustomer(int orderStatusId)
                        throws java.lang.Exception

Determines whether a customer should automatically be notified based on the orderStatusId passed in as a parameter

Parameters:

orderStatusId - the orderStatusId

Returns:

true if we need to notify the customer, otherwise false

Throws:

java.lang.Exception - an unexpected exception

doesOrderExistForId

private boolean doesOrderExistForId(int orderId)
                             throws org.apache.torque.TorqueException

Determines whether an order exists for the order id passed in as a parameter

Parameters:

orderId - the orderId

Returns:

true if the order exists, otherwise false

Throws:

org.apache.torque.TorqueException - an unexpected exception in Torque (the database layer)

getOrderIdForNumber

private int getOrderIdForNumber(java.lang.String orderNumber)
                         throws java.lang.Exception

Get the order Id for the specified order number

Parameters:

orderNumber - the order number

Returns:

the order id for the order number

Throws:

java.lang.Exception - an unexpected Exception exception

updateProductPrices

public boolean updateProductPrices(java.lang.StringBuffer logSB,
                                   com.konakart.erp.jaxb.IOProductPriceUpdateInMsg updateMsg)
                            throws java.lang.Exception

Method to update the prices of a product.

Specified by:

updateProductPrices in interface AdminImportMgrIf

Overrides:

updateProductPrices in class AdminImportMgr

Parameters:

logSB - the logSB

updateMsg - the updateMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

updateSingleProductPrices

protected boolean updateSingleProductPrices(java.lang.StringBuffer logSB,
                                            com.konakart.erp.jaxb.IOProductPriceUpdateInMsg updateMsg,
                                            com.konakart.erp.jaxb.IOProductPricesContainer container)
                                     throws java.lang.Exception

Method to update the prices of a product.

Parameters:

logSB - the logSB

updateMsg - the updateMsg

container - the IOProductPricesContainer

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

createOptionsFromProductQuantityEncodedKey

public AdminOption[] createOptionsFromProductQuantityEncodedKey(java.lang.String encodedKey)

Receives an encoded key from the products_quantity table in the format 3{4}4{6} and creates an array of AdminOption objects.

Parameters:

encodedKey - the encodedKey

Returns:

Return an array of AdminOption objects

updateProduct

public boolean updateProduct(java.lang.StringBuffer logSB,
                             com.konakart.erp.jaxb.IOProductUpdateInMsg updateMsg)
                      throws java.lang.Exception

Method to update a product quantity and / or prices. It may also disable the product.

Specified by:

updateProduct in interface AdminImportMgrIf

Overrides:

updateProduct in class AdminImportMgr

Parameters:

logSB - the logSB

updateMsg - the updateMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

getProdIdFromSku

private int getProdIdFromSku(java.lang.String sku,
                             boolean searchVariants)
                      throws java.lang.Exception

Get the product id from the SKU

Parameters:

sku - the sku

searchVariants - If true we also search the products_quantity table if we can't find the product in the products table

Returns:

the productId given the SKU. If more than one product exists with the same SKU we return the productId of the first one found.

Throws:

java.lang.Exception - an unexpected exception

registerCustomer

public boolean registerCustomer(java.lang.StringBuffer logSB,
                                com.konakart.erp.jaxb.IOCustomerInMsg custInMsg,
                                AdminServletMgrIf servletMgr)
                         throws java.lang.Exception

Method to register a customer

Specified by:

registerCustomer in interface AdminImportMgrIf

Overrides:

registerCustomer in class AdminImportMgr

Parameters:

logSB - the logSB

custInMsg - the custInMsg

servletMgr - the servletMgr

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

matchCustomer

public boolean matchCustomer(java.lang.StringBuffer logSB,
                             com.konakart.erp.jaxb.IOMatchCustomerInMsg matchInMsg)
                      throws java.lang.Exception

Method to match a customer that has been registered on the ERP

Specified by:

matchCustomer in interface AdminImportMgrIf

Overrides:

matchCustomer in class AdminImportMgr

Parameters:

logSB - the logSB

matchInMsg - the matchInMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

getNullIfEmpty

private java.lang.String getNullIfEmpty(java.lang.String in)

Returns null for an empty string

Parameters:

in - the in

Returns:

the input String or null if the input String is blank

getDefaultIfEmpty

private java.lang.String getDefaultIfEmpty(java.lang.String in)

Returns a default value for an empty string

Parameters:

in - the in

Returns:

the default value for an empty String (IOResources.N_A)

getDefaultIfEmpty

private java.util.Date getDefaultIfEmpty(java.util.Date in)

Returns a default value for an empty date

Parameters:

in - the in

Returns:

the date that was input or our default date (GregorianCalendar(0, 0, 0).getTime()) if the input date is null.

getRandomPassword

public java.lang.String getRandomPassword()
                                   throws java.lang.Exception

Creates a random password

Specified by:

getRandomPassword in interface AdminImportMgrIf

Overrides:

getRandomPassword in class AdminImportMgr

Returns:

Returns a random password

Throws:

java.lang.Exception - an unexpected exception

exportInvoice

public boolean exportInvoice(java.lang.StringBuffer logSB,
                             com.konakart.erp.jaxb.IOInvoiceInMsg invoiceMsg)
                      throws java.lang.Exception

Allows the ERP system to associate an invoice file (typically in PDF format) with a KonaKart order with the option of having the invoice sent out to a customer in an email by KonaKart. The invoice may be downloaded by a customer from the storefront after logging in.

Specified by:

exportInvoice in interface AdminImportMgrIf

Overrides:

exportInvoice in class AdminImportMgr

Parameters:

logSB - the logSB

invoiceMsg - the invoiceMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

paymentCapture

public boolean paymentCapture(java.lang.StringBuffer logSB,
                              com.konakart.erp.jaxb.IOPaymentCaptureInMsg captureMsg)
                       throws java.lang.Exception

In many cases when the customer confirms an order using his credit card, the funds are reserved and not captured until the products are actually shipped. This message, sent by the ERP, instructs KonaKart to initiate a credit card capture transaction with the payment gateway for the amount specified.

Specified by:

paymentCapture in interface AdminImportMgrIf

Overrides:

paymentCapture in class AdminImportMgr

Parameters:

logSB - the logSB

captureMsg - the captureMsg

Returns:

Returns true if successful

Throws:

java.lang.Exception - an unexpected exception

getOrderIdentifier

private AdminImportMgrEE.OrderDetails getOrderIdentifier(java.lang.StringBuffer logSB,
                                                         com.konakart.erp.jaxb.IOMsgBase msgBase,
                                                         java.lang.String orderIdStr,
                                                         java.lang.String orderNumber)
                                                  throws java.lang.Exception

Common code to get an order identifier from the message

Parameters:

logSB - the logSB

msgBase - the msgBase

orderIdStr - the orderIdStr

orderNumber - the orderNumber

Returns:

Returns an order details object or null if it fails

Throws:

java.lang.Exception - an unexpected exception

getCountryFromIsoCode

private AdminCountry getCountryFromIsoCode(java.lang.String iso3Code,
                                           java.lang.String isoNumericCode)
                                    throws java.lang.Exception

Find the country from an ISO code

Parameters:

iso3Code - the iso3Code

isoNumericCode - the isoNumericCode

Returns:

Returns the country object

Throws:

java.lang.Exception - an unexpected exception

log

public void log(java.lang.StringBuffer logSB,
                com.konakart.erp.jaxb.IOMsgBase msgBase,
                java.lang.String msg)
         throws java.io.IOException

Common code for writing to the log file

Specified by:

log in interface AdminImportMgrIf

Overrides:

log in class AdminImportMgr

Parameters:

logSB - the logSB

msgBase - the msgBase

msg - the msg

Throws:

java.io.IOException - an unexpected IOException exception

getCustomerForEmail

public AdminCustomer getCustomerForEmail(java.lang.String emailAddr)
                                  throws java.lang.Exception

Get customer for email

Specified by:

getCustomerForEmail in interface AdminImportMgrIf

Overrides:

getCustomerForEmail in class AdminImportMgr

Parameters:

emailAddr - the emailAddr

Returns:

Returns an admin customer

Throws:

java.lang.Exception - an unexpected exception