com.konakartadmin.bl

Class AdminSchedulerMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminSchedulerMgr

All Implemented Interfaces:

AdminSchedulerMgrIf

public class AdminSchedulerMgr
extends AdminBaseMgr
implements AdminSchedulerMgrIf

Manages Scheduling for KonaKart

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminSchedulerMgr.StaticData

Field Summary

Fields

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

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

Method Summary

Modifier and Type	Method and Description
AdminJobStatusResponse	getJobStatus(AdminJobStatusRequest jobStatusRequestIn) Retrieve Status Information on the Batch Jobs
protected org.quartz.Scheduler	getScheduler()
protected boolean	includeJob(org.quartz.JobKey jobKey, AdminJobStatusRequest jobStatusRequest)
void	init() Initialise the Report Manager
void	refreshConfigs() Retrieve some commonly-used properties
boolean	runBatchJob(java.lang.String group, java.lang.String name, java.lang.String[] paramArray) Executes the batch job with the specified group and name.
protected boolean	timePresent(AdminJob job)

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, 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

mutex

protected static java.lang.String mutex

staticDataHM

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

Hash Map that contains the static data

Constructor Detail

AdminSchedulerMgr

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

Constructor

Parameters:

eng - KKAdmin engine

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getJobStatus

public AdminJobStatusResponse getJobStatus(AdminJobStatusRequest jobStatusRequestIn)
                                    throws KKAdminException

Retrieve Status Information on the Batch Jobs

Specified by:

getJobStatus in interface AdminSchedulerMgrIf

Parameters:

jobStatusRequestIn - Defines the jobs to retrieve information about

Returns:

AdminJobStatusResponse an object defining the status of the jobs requested

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

includeJob

protected boolean includeJob(org.quartz.JobKey jobKey,
                             AdminJobStatusRequest jobStatusRequest)

timePresent

protected boolean timePresent(AdminJob job)

runBatchJob

public boolean runBatchJob(java.lang.String group,
                           java.lang.String name,
                           java.lang.String[] paramArray)
                    throws KKAdminException

Description copied from interface: AdminSchedulerMgrIf

Executes the batch job with the specified group and name.

The batch job must be defined as one the existing batch jobs in the system.

For Quartz jobs, the paramAray is not actually used but it is provided should these parameters be required for overriding the implementation of this method in a custom engine.

Specified by:

runBatchJob in interface AdminSchedulerMgrIf

Parameters:

group - The group of the batch job to be run

name - The name of the batch job to be executed

paramArray - A generic set of Strings that can be used for custom purposes.

Returns:

Returns true if the job was successfully started, otherwise false

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getScheduler

protected org.quartz.Scheduler getScheduler()
                                     throws KKAdminException

Throws:

KKAdminException

init

public void init()
          throws KKAdminException

Initialise the Report Manager

Specified by:

init in interface AdminSchedulerMgrIf

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Retrieve some commonly-used properties

Specified by:

refreshConfigs in interface AdminSchedulerMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception