com.konakartadmin.bl

Class KKBatchBase

java.lang.Object

com.konakartadmin.bl.KKBatchBase

Direct Known Subclasses:

ExecuteBatchDirectEE, ExecuteBatchEE, ExecuteMultiStoreBatchDirectEE, ExecuteMultiStoreBatchEE

public class KKBatchBase
extends java.lang.Object

Base Class for KonaKart Batch controller classes

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	PARAM_KEY_PREFIX parameter key prefix constant

Constructor Summary

Constructors

Constructor and Description
KKBatchBase()

Method Summary

Modifier and Type	Method and Description
protected int	countParameters(org.quartz.JobDataMap jobData) Count the parameters which are names param0, param1 etc...
protected KKAdminIf	getAdminEngine(java.lang.String kkAdminEngineClassName, AdminEngineConfig adEngConf) Get an Admin Engine for execution of the KonaKart Batch Jobs from Quartz
protected static KKAdminIf	getAdminEngineDirect(java.lang.String kkAdminEngineClassName, AdminEngineConfig adEngConf) Get an Admin Engine for Direct execution of the KonaKart Batch Jobs
protected java.lang.String	getEngConfStr(KKAdminIf adminEng)
protected static java.lang.String	getEngConfStrDirect(KKAdminIf adminEng)
protected static java.lang.String	getStoreId(KKAdminIf adminEng) Get the storeId
protected java.lang.String	login(KKAdminIf adminEng, java.lang.String user, java.lang.String password) Log in to the Admin Engine and return a session Id
protected static java.lang.String	loginDirect(KKAdminIf adminEng, java.lang.String user, java.lang.String password) Log in to the Admin Engine and return a session Id
protected static void	logout(KKAdminIf adminEng, java.lang.String sessId) Logout of the Admin Engine

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

PARAM_KEY_PREFIX

protected static final java.lang.String PARAM_KEY_PREFIX

parameter key prefix constant

See Also:

Constant Field Values

Constructor Detail

KKBatchBase

public KKBatchBase()

Method Detail

countParameters

protected int countParameters(org.quartz.JobDataMap jobData)

Count the parameters which are names param0, param1 etc...

Parameters:

jobData - the jobData

Returns:

a count of the parameters defined for the job

logout

protected static void logout(KKAdminIf adminEng,
                             java.lang.String sessId)

Logout of the Admin Engine

Parameters:

adminEng - an Admin Engine

sessId - a session Id

login

protected java.lang.String login(KKAdminIf adminEng,
                                 java.lang.String user,
                                 java.lang.String password)
                          throws org.quartz.JobExecutionException

Log in to the Admin Engine and return a session Id

Parameters:

adminEng - an Admin Engine

user - username

password - password

Returns:

a session Id

Throws:

org.quartz.JobExecutionException - an unexpected JobExecutionException exception

loginDirect

protected static java.lang.String loginDirect(KKAdminIf adminEng,
                                              java.lang.String user,
                                              java.lang.String password)
                                       throws java.lang.Exception

Log in to the Admin Engine and return a session Id

Parameters:

adminEng - an Admin Engine

user - username

password - password

Returns:

a session Id

Throws:

java.lang.Exception - an unexpected exception

org.quartz.JobExecutionException - an unexpected JobExecutionException exception

getAdminEngine

protected KKAdminIf getAdminEngine(java.lang.String kkAdminEngineClassName,
                                   AdminEngineConfig adEngConf)
                            throws org.quartz.JobExecutionException

Get an Admin Engine for execution of the KonaKart Batch Jobs from Quartz

Parameters:

kkAdminEngineClassName - the kkAdminEngineClassName

adEngConf - the adEngConf

Returns:

a KKAdminIf engine

Throws:

org.quartz.JobExecutionException - if there's a problem creating the KKAdminIf engine

getAdminEngineDirect

protected static KKAdminIf getAdminEngineDirect(java.lang.String kkAdminEngineClassName,
                                                AdminEngineConfig adEngConf)
                                         throws java.lang.Exception

Get an Admin Engine for Direct execution of the KonaKart Batch Jobs

Parameters:

kkAdminEngineClassName - the kkAdminEngineClassName

adEngConf - the adEngConf

Returns:

a KKAdminIf engine

Throws:

java.lang.Exception - an unexpected exception if there's a problem creating the KKAdminIf engine

getEngConfStr

protected java.lang.String getEngConfStr(KKAdminIf adminEng)

getEngConfStrDirect

protected static java.lang.String getEngConfStrDirect(KKAdminIf adminEng)

getStoreId

protected static java.lang.String getStoreId(KKAdminIf adminEng)

Get the storeId

Parameters:

adminEng - the adminEng

Returns:

a String containing the storeId from the AdminEngingeConfig