com.konakartadmin.bl

Class AdminCustomerBatchMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminBatchBaseMgr

com.konakartadmin.bl.AdminCustomerBatchMgr

Direct Known Subclasses:

AdminApsisBatchMgr

public class AdminCustomerBatchMgr
extends AdminBatchBaseMgr

The AdminCustomerBatchMgr

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminCustomerBatchMgr.CustRetList A return object containing a list of Customers and the last customer Id processed

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

AdminBatchBaseMgr.CustTagCounter

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

AdminBaseMgr.StaticData

Field Summary

Fields inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

log

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
AdminCustomerBatchMgr(KKAdminIf eng)

Method Summary

Modifier and Type	Method and Description
void	countCustomersBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String sessId) This batch is a simple example that can be used to demonstrate how the ExecuteMultiStoreBatch class can be used to execute batch jobs for each store.
protected int	deleteCustomer(AdminCustomer cust, com.konakart.db.KKCriteria sessionCrit, com.konakart.db.KKCriteria sessionDelCrit, AdminCustomerMgrIf custMgr)
void	deleteTemporaryDataBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String numDaysStr, java.lang.String cookieBlockSizeStr) This batch is used to delete temporary data in order to keep your KonaKart store running efficiently.
void	expiredRewardPointBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String numDaysStr) This batch is used to expire reward points after a certain time limit, which is entered as a number of days in the numDays parameter.
protected com.konakart.db.KKCriteria	getCustomerCriteria(int size, int[] permanentCustTypes) Get the criteria object to search for customers
protected AdminCustomerBatchMgr.CustRetList	getCustomers(com.konakart.db.KKCriteria c, int custId) The method returns a null list within the return object when all of the customers have been read.
protected java.util.HashMap<java.lang.String,AdminCustomerTag>	getCustomerTagsHash(int customerId, java.util.Set<java.lang.String> tagsToUpdate, AdminCustomerTagMgrIf tagMgr) Get the customer tags for the specified customerId.
protected java.lang.String	getGenderValueFromCustomer(AdminCustomer cust, java.io.BufferedWriter bw)
protected com.konakart.db.KKCriteria	getLiteCustomerCriteria(int size) Get the criteria object to retrieve customers
protected java.lang.String	getNewsletterValue(AdminCustomer cust)
protected com.konakart.db.KKCriteria	getSessionCriteria() Get the criteria object to search for a customer's session
protected java.util.HashMap<java.lang.String,java.lang.String>	getTagsFromAllOrders(AdminCustomer cust)
protected java.util.HashMap<java.lang.String,java.lang.String>	getTagsFromLastOrder(AdminCustomer cust)
int	getTimeInSecs() Utility method to return the current time in seconds
protected java.util.List<AdminOrder>	getUnpaidOrders(com.konakart.db.KKCriteria c) The method returns null when all of the orders have been read.
protected boolean	hasSessionExpired(int expiryInSecs)
protected void	insertOrUpdateCustomerTag(java.lang.String tagName, java.lang.String tagValue, AdminCustomer cust, AdminBatchBaseMgr.CustTagCounter count, AdminCustomerTagMgrIf tagMgr, java.io.BufferedWriter bw)
java.lang.String	removeExpiredCustomersBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr, java.lang.String permanentCustTypesStr) Each existing customer is read from the database in a loop, and for each customer object we detect whether it has one or more expired session records and no non expired record.
java.lang.String	resetAggregateOrderTotalCustomerTag(java.lang.String logName, java.lang.String appendLogStr) This batch job should be run at regular intervals (e.g.
java.lang.String	updateCustomerTagsBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr) This is an example of how you might update Customer Tags in a batch job.
java.lang.String	updateSummaryCustomerTagsBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr) This is an example of how you might update Summary Customer Tags in a batch job.

Methods inherited from class com.konakartadmin.bl.AdminBatchBaseMgr

ensureCustomerTagIsPresent, getAdEngConf, getAdminJsonEngine, getBatchLogName, getBoolean, getCustomerTagsHash, getInt, getIntArray, getIntArray, getLiteCustomers, getLogName, getOrders, getSkuForProduct, insertOrUpdateCustomerTag, trimMultiTag, validateTemplate

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

Constructor Detail

AdminCustomerBatchMgr

public AdminCustomerBatchMgr(KKAdminIf eng)
                      throws java.lang.Exception

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

removeExpiredCustomersBatch

public java.lang.String removeExpiredCustomersBatch(java.lang.String logName,
                                                    java.lang.String appendLogStr,
                                                    java.lang.String recordFetchSizeStr,
                                                    java.lang.String permanentCustTypesStr)
                                             throws java.lang.Exception

Each existing customer is read from the database in a loop, and for each customer object we detect whether it has one or more expired session records and no non expired record. If this is the case, the customer and the session records are deleted. If no session records exist, then the creation time of the customer is read and the customer is deleted if it has existed for a few seconds, in order to avoid deleting customers that are in the process of being created and registered. This batch is used for the case where KonaKart mustn't store customer information so this information is stored only temporarily to allow a customer to place an order and then is deleted.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

permanentCustTypesStr - An array of customer types that won't be deleted. They are in a format "3-6-8" where "-" is a delimiter between the integers.

Returns:

Returns the number of customers removed

Throws:

java.lang.Exception - an unexpected exception

deleteCustomer

protected int deleteCustomer(AdminCustomer cust,
                             com.konakart.db.KKCriteria sessionCrit,
                             com.konakart.db.KKCriteria sessionDelCrit,
                             AdminCustomerMgrIf custMgr)
                      throws java.lang.Exception

Throws:

java.lang.Exception

hasSessionExpired

protected boolean hasSessionExpired(int expiryInSecs)

getCustomers

protected AdminCustomerBatchMgr.CustRetList getCustomers(com.konakart.db.KKCriteria c,
                                                         int custId)
                                                  throws java.lang.Exception

The method returns a null list within the return object when all of the customers have been read. The caller can stop looping when he receives null.

Parameters:

c - the c

custId - the customerId (only customers with customerId greater than this will be returned)

Returns:

Returns a list of AdminCustomers and the last customer Id

Throws:

java.lang.Exception - an unexpected exception

getSessionCriteria

protected com.konakart.db.KKCriteria getSessionCriteria()

Get the criteria object to search for a customer's session

Returns:

Returns a criteria object

getCustomerCriteria

protected com.konakart.db.KKCriteria getCustomerCriteria(int size,
                                                         int[] permanentCustTypes)

Get the criteria object to search for customers

Parameters:

size - the size

permanentCustTypes - the permanentCustTypes

Returns:

Returns a criteria object

expiredRewardPointBatch

public void expiredRewardPointBatch(java.lang.String logName,
                                    java.lang.String appendLogStr,
                                    java.lang.String numDaysStr)
                             throws java.lang.Exception

This batch is used to expire reward points after a certain time limit, which is entered as a number of days in the numDays parameter. The expired attribute of each expired reward points record is set to non zero by the batch.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

numDaysStr - If current time - numDays is greater than the date when the reward point transaction was added, then the points added in that transaction are expired.

Throws:

java.lang.Exception - an unexpected exception

deleteTemporaryDataBatch

public void deleteTemporaryDataBatch(java.lang.String logName,
                                     java.lang.String appendLogStr,
                                     java.lang.String numDaysStr,
                                     java.lang.String cookieBlockSizeStr)
                              throws java.lang.Exception

This batch is used to delete temporary data in order to keep your KonaKart store running efficiently. It deletes :

• Expired sessions which remain in the sessions table if a customer doesn't log off the storefront application.
• Counter records.
• Data from the kk_sso table for records older than the number of days passed in as a parameter.
• KKEvents more than 4 hours old.
• KonaKart cookies from the kk_cookie table. These cookie records are used to identify temporary returning customers (i.e. returning customers that never registered) so that their cart items can be persisted. The associated customers_basket, customers_basket_attributes, kk_wishlist, kk_wishlist_item, kk_customers_to_tag records are also deleted.

By default it reads cookieBlockSizeStr kk_cookie records at a time and deletes them and associated records using delete statements with an IN clause so that up to cookieBlockSizeStr deletes are performed with one SQL statement. If the batch job is taking too long, you may try increasing this number.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

numDaysStr - kk_cookie records are deleted if current time - numDays is greater than the date when the cookie was last read or actually created (for the case when it has never been read).

cookieBlockSizeStr - The number of kk_cookie records read and deleted at a time using an IN clause. A good starting value for this parameter is 250. It can be increased in order to speed up the batch job if there are many kk_cookie records to delete.

Throws:

java.lang.Exception - an unexpected exception

getTimeInSecs

public int getTimeInSecs()

Utility method to return the current time in seconds

Returns:

Returns the time

getUnpaidOrders

protected java.util.List<AdminOrder> getUnpaidOrders(com.konakart.db.KKCriteria c)
                                              throws java.lang.Exception

The method returns null when all of the orders have been read. The caller can stop looping when he receives null.

Parameters:

c - the c

Returns:

Returns a list of AdminOrders

Throws:

java.lang.Exception - an unexpected exception

countCustomersBatch

public void countCustomersBatch(java.lang.String logName,
                                java.lang.String appendLogStr,
                                java.lang.String sessId)
                         throws java.lang.Exception

This batch is a simple example that can be used to demonstrate how the ExecuteMultiStoreBatch class can be used to execute batch jobs for each store.

It simply counts the number of customers in the store and writes out this number.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

sessId - The sessionId. The sessionId is a special parameter defined in the konakart_jobs.xml file. If a parameter is defined with value "SESSION_ID", KonaKart will replace this value with the sessionId of the logged in session.

Throws:

java.lang.Exception - an unexpected exception

updateCustomerTagsBatch

public java.lang.String updateCustomerTagsBatch(java.lang.String logName,
                                                java.lang.String appendLogStr,
                                                java.lang.String recordFetchSizeStr)
                                         throws java.lang.Exception

This is an example of how you might update Customer Tags in a batch job.

Each existing customer is read from the database in a loop, and for each customer object we update the IS_MALE customer tags if is has changed or we insert it if it isn't present.

This is a somewhat trivial example but is expected to be extended to suit specific requirements for a store.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

Returns:

Returns the number of customers updated

Throws:

java.lang.Exception - an unexpected exception

getGenderValueFromCustomer

protected java.lang.String getGenderValueFromCustomer(AdminCustomer cust,
                                                      java.io.BufferedWriter bw)
                                               throws java.io.IOException

Throws:

java.io.IOException

insertOrUpdateCustomerTag

protected void insertOrUpdateCustomerTag(java.lang.String tagName,
                                         java.lang.String tagValue,
                                         AdminCustomer cust,
                                         AdminBatchBaseMgr.CustTagCounter count,
                                         AdminCustomerTagMgrIf tagMgr,
                                         java.io.BufferedWriter bw)
                                  throws KKAdminException,
                                         org.apache.torque.TorqueException,
                                         java.text.ParseException,
                                         com.workingdogs.village.DataSetException,
                                         java.io.IOException

Throws:

KKAdminException

org.apache.torque.TorqueException

java.text.ParseException

com.workingdogs.village.DataSetException

java.io.IOException

getLiteCustomerCriteria

protected com.konakart.db.KKCriteria getLiteCustomerCriteria(int size)

Get the criteria object to retrieve customers

Overrides:

getLiteCustomerCriteria in class AdminBatchBaseMgr

Parameters:

size - the number of records to retrieve at a time

Returns:

Returns a criteria object

resetAggregateOrderTotalCustomerTag

public java.lang.String resetAggregateOrderTotalCustomerTag(java.lang.String logName,
                                                            java.lang.String appendLogStr)
                                                     throws java.lang.Exception

This batch job should be run at regular intervals (e.g. monthly) to reset the customer tag that contains the order value total for a customer for a period of time. After a default installation the name of this tag is B2B_AGGREGATE_ORDER_TOTAL. It is used in a B2B environment to manage the quota of a corporate buyer over a time period. For example, a buyer may only be allowed to spend $x.xx / month which is information contained in another tag called B2B_AGGREGATE_ORDER_LIMIT. The tag that is reset contains the running total spent for the month and so must be reset at the end of the month by this batch job.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

Returns:

Returns the number of tags updated

Throws:

java.lang.Exception - an unexpected exception

updateSummaryCustomerTagsBatch

public java.lang.String updateSummaryCustomerTagsBatch(java.lang.String logName,
                                                       java.lang.String appendLogStr,
                                                       java.lang.String recordFetchSizeStr)
                                                throws java.lang.Exception

This is an example of how you might update Summary Customer Tags in a batch job.

Each existing customer is read from the database in a loop, and for each customer object we update a number of summary customer tags.

Parameters:

logName - The name of the log which shouldn't include the path or extension. i.e. It should be myLog rather than /logs/myLog.txt.

appendLogStr - If set to false, a new log will be created every time the batch job is run. Otherwise new data will be appended to the existing log. It defaults to false.

recordFetchSizeStr - It the batch involves reading many records in a loop, this determines the maximum number read in any one loop. It defaults to 100.

Returns:

Returns the number of customer tags updated

Throws:

java.lang.Exception - an unexpected exception

getNewsletterValue

protected java.lang.String getNewsletterValue(AdminCustomer cust)

getTagsFromLastOrder

protected java.util.HashMap<java.lang.String,java.lang.String> getTagsFromLastOrder(AdminCustomer cust)
                                                                             throws java.lang.Exception

Throws:

java.lang.Exception

getTagsFromAllOrders

protected java.util.HashMap<java.lang.String,java.lang.String> getTagsFromAllOrders(AdminCustomer cust)
                                                                             throws java.lang.Exception

Throws:

java.lang.Exception

getCustomerTagsHash

protected java.util.HashMap<java.lang.String,AdminCustomerTag> getCustomerTagsHash(int customerId,
                                                                                   java.util.Set<java.lang.String> tagsToUpdate,
                                                                                   AdminCustomerTagMgrIf tagMgr)
                                                                            throws org.apache.torque.TorqueException,
                                                                                   KKAdminException,
                                                                                   com.workingdogs.village.DataSetException

Get the customer tags for the specified customerId.

Parameters:

customerId - the customerId

tagsToUpdate - a set of tag names that we wish to update

tagMgr - the AdminCustomerTagMgr

Returns:

a HashMap containing the customers tags that are in the set of customer tags we wish to update.

Throws:

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

KKAdminException - an unexpected exception in the KKAdmin engine

com.workingdogs.village.DataSetException - an unexpected exception in the database layer