com.konakartadmin.bl

Class AdminApsisBatchMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminBatchBaseMgr

com.konakartadmin.bl.AdminCustomerBatchMgr

com.konakartadmin.bl.AdminApsisBatchMgr

public class AdminApsisBatchMgr
extends AdminCustomerBatchMgr

The AdminApsisBatchMgr

Nested Class Summary

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

AdminCustomerBatchMgr.CustRetList

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

Method Summary

Modifier and Type	Method and Description
protected int	createSubscriber(java.util.List<com.konakart.bl.modules.others.apsismail.Subscriber> subscribersToCreate, int mailingListId, AdminCustomer cust, java.util.HashMap<java.lang.String,AdminCustomerTag> currentKKCustTags, com.konakart.bl.modules.others.apsismail.ApsisMail apsisMail) Create a new APSIS subscriber.
protected int	createSubscribers(java.util.List<com.konakart.bl.modules.others.apsismail.Subscriber> subscribersToCreate, int mailingListId, com.konakart.bl.modules.others.apsismail.ApsisMail apsisMail) Create a batch of new APSIS subscribers.
protected boolean	customerExcluded(AdminCustomer cust, java.lang.String[] excludedEmails) Should we exclude this customer?
protected com.konakart.db.KKCriteria	getApsisCustomerCriteria(int size) Get the criteria object to retrieve customers for updating APSIS
private boolean	subscriberChangesMade(com.konakart.bl.modules.others.apsismail.SubscriberResponse sub, com.konakart.bl.modules.others.apsismail.Subscriber newSub, java.util.Set<java.lang.String> tagsToUpdate) Return true if changes have been made between the two Subscriber records
java.lang.String	updateApsisSubscribersBatch(java.lang.String logName, java.lang.String appendLogStr, java.lang.String recordFetchSizeStr, java.lang.String mailingListName, java.lang.String tagNames, java.lang.String excludedEmailsRE) This is an example of how you might update APSIS Email Subscribers in a batch job.
protected int	updateSubscriber(com.konakart.bl.modules.others.apsismail.SubscriberResponse sub, java.util.List<com.konakart.bl.modules.others.apsismail.Subscriber> subscribersToUpdate, int mailingListId, AdminCustomer cust, java.util.HashMap<java.lang.String,AdminCustomerTag> currentKKCustTags, java.util.Set<java.lang.String> tagsToUpdate, com.konakart.bl.modules.others.apsismail.ApsisMail apsisMail) Update an APSIS subscriber.
protected int	updateSubscribers(java.util.List<com.konakart.bl.modules.others.apsismail.Subscriber> subscribersToUpdate, int mailingListId, com.konakart.bl.modules.others.apsismail.ApsisMail apsisMail) Create a batch of APSIS subscriber updates.

Methods inherited from class com.konakartadmin.bl.AdminCustomerBatchMgr

countCustomersBatch, deleteCustomer, deleteTemporaryDataBatch, expiredRewardPointBatch, getCustomerCriteria, getCustomers, getCustomerTagsHash, getGenderValueFromCustomer, getLiteCustomerCriteria, getNewsletterValue, getSessionCriteria, getTagsFromAllOrders, getTagsFromLastOrder, getTimeInSecs, getUnpaidOrders, hasSessionExpired, insertOrUpdateCustomerTag, removeExpiredCustomersBatch, resetAggregateOrderTotalCustomerTag, updateCustomerTagsBatch, updateSummaryCustomerTagsBatch

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

AdminApsisBatchMgr

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

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

updateApsisSubscribersBatch

public java.lang.String updateApsisSubscribersBatch(java.lang.String logName,
                                                    java.lang.String appendLogStr,
                                                    java.lang.String recordFetchSizeStr,
                                                    java.lang.String mailingListName,
                                                    java.lang.String tagNames,
                                                    java.lang.String excludedEmailsRE)
                                             throws java.lang.Exception

This is an example of how you might update APSIS Email Subscribers in a batch job.

Each existing customer is read from the database in a loop, and for each customer object we synchronise subscriber records and KonaKart customer records.

A set of customer tags are updated. These are stored as "Demographic Data" against the subscriber in APSIS.

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.

mailingListName - The mailing list to subscribe the KonaKart customers to.

tagNames - A comma-separated set of Customer Tag names to update in APSIS against the customer's subscriber record..

excludedEmailsRE - A comma-separated set of regular expressions that define the email addresses that will not be created in APSIS

Returns:

Returns the number of customers updated

Throws:

java.lang.Exception - an unexpected exception

getApsisCustomerCriteria

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

Get the criteria object to retrieve customers for updating APSIS

Parameters:

size - the number of records to retrieve at a time

Returns:

Returns a criteria object

customerExcluded

protected boolean customerExcluded(AdminCustomer cust,
                                   java.lang.String[] excludedEmails)

Should we exclude this customer?

Parameters:

cust - the customer

excludedEmails - an array of regular expressions to define the excluded customers

Returns:

true if the customers should be excluded

createSubscriber

protected int createSubscriber(java.util.List<com.konakart.bl.modules.others.apsismail.Subscriber> subscribersToCreate,
                               int mailingListId,
                               AdminCustomer cust,
                               java.util.HashMap<java.lang.String,AdminCustomerTag> currentKKCustTags,
                               com.konakart.bl.modules.others.apsismail.ApsisMail apsisMail)
                        throws com.konakart.app.KKException

Create a new APSIS subscriber. The subscriber does not exist in APSIS.

Parameters:

subscribersToCreate - of list of Subscribers that is passed back and forth. When it reaches 10 subscribers we send it off to Apsis and clear it.

mailingListId - the mailing list Id of the Apsis mailing list to subscribe to

cust - the KonaKart customer to become the new subscriber

currentKKCustTags - the current customer tags of the KonaKart customer that are to be sent to APSIS with the new subscriber record.

apsisMail - an instance of ApsisMail for Apsis operations

Returns:

a count of the newly-created subscribers in APSIS

Throws:

com.konakart.app.KKException - If something unexpected happened in the KonaKart Engine or in the Apsis module

createSubscribers

protected int createSubscribers(java.util.List<com.konakart.bl.modules.others.apsismail.Subscriber> subscribersToCreate,
                                int mailingListId,
                                com.konakart.bl.modules.others.apsismail.ApsisMail apsisMail)
                         throws com.konakart.app.KKException

Create a batch of new APSIS subscribers. The subscribers do not exist in APSIS.

Parameters:

subscribersToCreate - of list of Subscribers to send to Apsis.

mailingListId - the mailing list Id of the Apsis mailing list to subscribe to

apsisMail - an instance of ApsisMail for Apsis operations

Returns:

a count of the newly-created subscribers in APSIS

Throws:

com.konakart.app.KKException - If something unexpected happened in the KonaKart Engine or in the Apsis module

updateSubscriber

protected int updateSubscriber(com.konakart.bl.modules.others.apsismail.SubscriberResponse sub,
                               java.util.List<com.konakart.bl.modules.others.apsismail.Subscriber> subscribersToUpdate,
                               int mailingListId,
                               AdminCustomer cust,
                               java.util.HashMap<java.lang.String,AdminCustomerTag> currentKKCustTags,
                               java.util.Set<java.lang.String> tagsToUpdate,
                               com.konakart.bl.modules.others.apsismail.ApsisMail apsisMail)
                        throws com.konakart.app.KKException

Update an APSIS subscriber. The subscriber already exists in APSIS.

Parameters:

sub - the subscriber record returned from APSIS

subscribersToUpdate - of list of Subscribers that is passed back and forth. When it reaches 10 subscribers we send it off to Apsis and clear it.

mailingListId - the mailing list Id of the Apsis mailing list to subscribe to

cust - the KonaKart customer being updated

currentKKCustTags - the current customer tags of the KonaKart customer that are to be sent to APSIS with the updated subscriber record.

tagsToUpdate - a set of tag names that are candidates to be updated in APSIS

apsisMail - an instance of ApsisMail for Apsis operations

Returns:

a count of the updated subscribers in APSIS

Throws:

com.konakart.app.KKException - If something unexpected happened in the KonaKart Engine or in the Apsis module

subscriberChangesMade

private boolean subscriberChangesMade(com.konakart.bl.modules.others.apsismail.SubscriberResponse sub,
                                      com.konakart.bl.modules.others.apsismail.Subscriber newSub,
                                      java.util.Set<java.lang.String> tagsToUpdate)

Return true if changes have been made between the two Subscriber records

Parameters:

sub - a subcriber response

newSub - a new subscriber

tagsToUpdate - a set of tag names that are candidates to be updated in APSIS

Returns:

true if changes have been made, otherwise false

updateSubscribers

protected int updateSubscribers(java.util.List<com.konakart.bl.modules.others.apsismail.Subscriber> subscribersToUpdate,
                                int mailingListId,
                                com.konakart.bl.modules.others.apsismail.ApsisMail apsisMail)
                         throws com.konakart.app.KKException

Create a batch of APSIS subscriber updates. The subscribers already exist in APSIS.

Parameters:

subscribersToUpdate - of list of Subscribers to send to Apsis.

mailingListId - the mailing list Id of the Apsis mailing list to subscribe to

apsisMail - an instance of ApsisMail for Apsis operations

Returns:

a count of the newly-created subscribers in APSIS

Throws:

com.konakart.app.KKException - If something unexpected happened in the KonaKart Engine or in the Apsis module