com.konakartadmin.bl

Class KKAdminBase

java.lang.Object

com.konakartadmin.bl.KKAdminBase

Direct Known Subclasses:

KKAdmin

public class KKAdminBase
extends java.lang.Object

This implements the server side of the KonaKart Admin Application. The BaseClass contains initialization and utility methods.

Field Summary

Fields

Modifier and Type	Field and Description
protected KKAdmin	adminEng The KKAdmin engine
protected static org.apache.commons.configuration2.Configuration	allConfig Holds all the properties from the properties file
protected static java.lang.String	configFile Config File as a String
protected static java.net.URL	configFileURL Config File as a URL
private static java.lang.String	dbVersion The Database version according to the ConfigData
protected static java.util.Set<java.lang.String>	emailReportingExclusions Exclusions for Email reporting of Exceptions
protected AdminEngineConfig	engConf Configuration parameter passed when the engine is instantiated
protected AdminEngineCacheMgrIf	engineCacheMgr KK Engine Mgr to manage KKEng engines for different stores
protected static boolean	globalInit
protected static boolean	kkCartInit
protected static org.apache.commons.configuration2.Configuration	kkConfig Used to read the KonaKart properties from the properties file
protected static java.lang.String	kkInstanceId The KonaKart Instance - read from the properties file
protected java.lang.String	konakartAdminPropsFileName
protected java.lang.String	konakartAdminPropsFilePath
protected static org.apache.commons.logging.Log	log Log
protected static com.konakart.clientlogging.LogMgr	logMgr Log Manager
protected AdminMgrFactory	mgrFactory Factory for creating managers
protected java.lang.String	mutex
protected static org.apache.commons.configuration2.Configuration	torqueConfig Used to read the Torque properties from the properties file
protected static boolean	torqueInit

Constructor Summary

Constructors

Constructor and Description
KKAdminBase()

Method Summary

Modifier and Type	Method and Description
protected void	auditDeletes(int userId, int objectId, java.lang.String methodName) Auditing for deletes of a single object
protected void	auditDeletes(int userId, java.lang.Object obj, int objectId, java.lang.String methodName) Auditing for deletes of a single object
protected void	auditDeletes(int userId, java.lang.Object obj, java.lang.String methodName) Auditing for deletes of a single object when there is no objectId to specify
protected void	auditDeletes(int userId, java.lang.String objAsString, java.lang.String methodName) Auditing for deletes of a single object, when the object has no integer id
protected void	auditDeletesForArray(int userId, java.lang.Object[] objArray, int objectId, java.lang.String methodName) Auditing for deletes of an array of objects
protected void	auditEdits(int userId, java.lang.Object obj, int objectId, java.lang.String methodName) Auditing for edits
protected void	auditEdits(int userId, java.lang.Object obj, int objectId, java.lang.String key, java.lang.String methodName) Auditing for edits
protected void	auditEdits(int userId, java.lang.Object obj, java.lang.String methodName) Auditing for edits
protected void	auditEdits(int userId, java.lang.Object obj, java.lang.String key, java.lang.String methodName) Auditing for edits
protected void	auditEdits(int userId, java.lang.String methodName, java.lang.String data) Auditing for updates
protected void	auditInserts(int userId, java.lang.Object[] objs, java.lang.String methodName, int newId) Auditing for inserts for an array of products
protected void	auditInserts(int userId, java.lang.Object obj, java.lang.String methodName, int newId) Auditing for inserts
protected void	auditInserts(int userId, java.lang.String methodName, java.lang.Object obj) Auditing for inserts for an array of products
protected void	auditInserts(int userId, java.lang.String methodName, java.lang.String data) Auditing for inserts where we just insert ids
protected void	auditReads(int userId, int objectId, java.lang.String methodName) Auditing for reads
protected void	auditReads(int userId, java.lang.String object, java.lang.String methodName) Auditing for reads
void	checkConfig(AdminEngineConfig engConf) Checks the integrity of the engine mode parameters
protected void	checkEnterpriseForCatalog() Catalogs require the enterprise version to be present.
protected void	checkEnterpriseForExtPriceOrExtQuantity(AdminProductMgrOptions mgrOptions) External prices and quantity require the enterprise version to be present.
protected boolean	checkLicense() Check that the Mago License is valid - if it's a Mago system.
protected void	checkManagerExists(java.lang.Object mgr, java.lang.String functionalityName) Common code to check for optional managers
protected boolean	excludedException(java.lang.String message) Should the exception message be excluded from reporting by email?
AdminAddressMgrIf	getAdminAddressMgr()
AdminAuditMgrIf	getAdminAuditMgr()
AdminBillingMgrIf	getAdminBillingMgr()
AdminBookableProductMgrIf	getAdminBookableProductMgr()
AdminCategoryMgrIf	getAdminCategoryMgr()
AdminConfigurationMgrIf	getAdminConfigurationMgr()
AdminContentMgrIf	getAdminContentMgr()
AdminCurrencyMgrIf	getAdminCurrencyMgr()
AdminCustomerMgrIf	getAdminCustomerMgr()
AdminCustomerPwdHistMgrIf	getAdminCustomerPwdHistMgr()
AdminCustomerTagMgrIf	getAdminCustomerTagMgr()
AdminDataIntegrityMgrIf	getAdminDataIntegrityMgr()
AdminEmailMgrIf	getAdminEmailMgr()
KKAdmin	getAdminEng()
AdminEventMgrIf	getAdminEventMgr()
AdminExecuteMgrIf	getAdminExecuteMgr()
AdminFileMgrIf	getAdminFileMgr()
AdminFilterMgrIf	getAdminFilterMgr()
AdminHtmlMgrIf	getAdminHtmlMgr()
AdminLanguageMgrIf	getAdminLanguageMgr()
AdminManufacturerMgrIf	getAdminManufacturerMgr()
AdminMessageMgrIf	getAdminMessageMgr()
AdminMiscItemMgrIf	getAdminMiscItemMgr()
AdminMiscPriceMgrIf	getAdminMiscPriceMgr()
AdminOrderMgrIf	getAdminOrderMgr()
AdminPdfMgrIf	getAdminPdfMgr()
AdminProdAttrMgrIf	getAdminProdAttrMgr()
AdminProductMgrIf	getAdminProductMgr()
AdminPromotionMgrIf	getAdminPromotionMgr()
AdminRemoteAccessMgrIf	getAdminRemoteAccessMgr()
AdminReportMgrIf	getAdminReportMgr()
AdminReviewMgrIf	getAdminReviewMgr()
AdminRewardPointMgrIf	getAdminRewardPointMgr()
AdminSchedulerMgrIf	getAdminSchedulerMgr()
protected AdminSearchRuleMgrIf	getAdminSearchRuleMgr()
AdminSecurityMgrIf	getAdminSecurityMgr()
AdminShipmentMgrIf	getAdminShipmentMgr()
AdminSolrMgrIf	getAdminSolrMgr()
AdminStoreMgrIf	getAdminStoreMgr()
AdminSuggestionMgrIf	getAdminSuggestionMgr()
AdminTagMgrIf	getAdminTagMgr()
AdminTaxMgrIf	getAdminTaxMgr()
AdminValidationMgrIf	getAdminValidationMgr()
AdminWishListMgrIf	getAdminWishListMgr()
protected static java.lang.String	getConfigFile()
java.lang.String	getDbVersion()
java.util.Set<java.lang.String>	getEmailReportingExclusions()
AdminEngineConfig	getEngConf()
protected java.lang.String	getEngineId()
protected java.lang.String	getEngineModeStr()
protected java.lang.String	getEngineShareMode()
protected java.lang.String	getExceptionMessage(java.lang.Throwable e) Returns a string containing the stack trace of the exception and its cause
protected java.lang.String	getKkInstanceId() Get the instance Id from the properties file
java.lang.String	getKonakartAdminPropsFileName()
java.lang.String	getKonakartAdminPropsFilePath()
java.lang.String	getKonaKartBuildDate() Get the KonaKart Build Date from the properties file
java.lang.String	getKonakartPropertyValue(java.lang.String section, java.lang.String propertyName) Returns the property value from the properties file in the specified section
boolean	getKonakartPropertyValueAsBoolWithDefault(java.lang.String section, java.lang.String propertyName, boolean def) Returns the property boolean value from the properties file in the specified section or the default if the property isn't found
long	getKonakartPropertyValueAsLongWithDefault(java.lang.String section, java.lang.String propertyName, long def) Returns the property long value from the properties file in the specified section or the default if the property isn't found or isn't a legal long value
java.lang.String	getKonakartPropertyValueWithDefault(java.lang.String section, java.lang.String propertyName, java.lang.String def) Returns the property value from the properties file in the specified section or the default if the property isn't found
static java.util.Calendar	getKonakartTimeStamp()
static java.util.Date	getKonakartTimeStampDate()
java.lang.String	getKonaKartVersion() Get the KonaKart Version Number from the properties file
static com.konakart.clientlogging.LogMgr	getLogMgr()
AdminModulesMgrIf	getModulesMgr()
protected java.lang.String	getStoreName(AdminConfigurationMgrIf adminConfMgr) Get the value of the STORE_NAME configuration parameter.
protected void	init(KKAdmin eng, java.lang.String propsFileName) Initialization code
protected void	initKonakart() Initialise KonaKart from the properties file
protected void	initMultiStoreMultiDB()
protected void	initMultiStoreSingleDB() Initialisation for MultiStore Single Database.
protected void	initSingleStore() Initialisation and start-up checks for the Single Store Mode
protected void	initTorque() The initialisation of Torque is synchronised.
boolean	isSingleStoreMode()
static boolean	isTorqueInit()
protected KKAdminException	manageThrowable(java.lang.Throwable e) Common code to manage exceptions in the KKAdmin engine
protected KKAdminException	manageThrowable(java.lang.Throwable e, boolean notifyByEmail) Common code to manage exceptions in the KKAdmin engine
void	setAdminEng(KKAdmin adminEng)
void	setEngConf(AdminEngineConfig engConf)
void	setKonakartAdminPropsFileName(java.lang.String konakartAdminPropsFileName)
void	setKonakartAdminPropsFilePath(java.lang.String konakartAdminPropsFilePath)

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

Log

logMgr

protected static com.konakart.clientlogging.LogMgr logMgr

Log Manager

adminEng

protected KKAdmin adminEng

The KKAdmin engine

engConf

protected AdminEngineConfig engConf

Configuration parameter passed when the engine is instantiated

globalInit

protected static boolean globalInit

torqueInit

protected static boolean torqueInit

kkCartInit

protected static boolean kkCartInit

dbVersion

private static java.lang.String dbVersion

The Database version according to the ConfigData

mutex

protected java.lang.String mutex

engineCacheMgr

protected AdminEngineCacheMgrIf engineCacheMgr

KK Engine Mgr to manage KKEng engines for different stores

konakartAdminPropsFilePath

protected java.lang.String konakartAdminPropsFilePath

konakartAdminPropsFileName

protected java.lang.String konakartAdminPropsFileName

configFile

protected static java.lang.String configFile

Config File as a String

configFileURL

protected static java.net.URL configFileURL

Config File as a URL

mgrFactory

protected AdminMgrFactory mgrFactory

Factory for creating managers

allConfig

protected static org.apache.commons.configuration2.Configuration allConfig

Holds all the properties from the properties file

kkConfig

protected static org.apache.commons.configuration2.Configuration kkConfig

Used to read the KonaKart properties from the properties file

torqueConfig

protected static org.apache.commons.configuration2.Configuration torqueConfig

Used to read the Torque properties from the properties file

kkInstanceId

protected static java.lang.String kkInstanceId

The KonaKart Instance - read from the properties file

emailReportingExclusions

protected static java.util.Set<java.lang.String> emailReportingExclusions

Exclusions for Email reporting of Exceptions

Constructor Detail

KKAdminBase

public KKAdminBase()

Method Detail

init

protected void init(KKAdmin eng,
                    java.lang.String propsFileName)
             throws java.lang.Exception

Initialization code

Parameters:

eng - the eng

propsFileName - the propsFileName

Throws:

java.lang.Exception - an unexpected exception

checkConfig

public void checkConfig(AdminEngineConfig engConf)
                 throws KKAdminException

Checks the integrity of the engine mode parameters

Parameters:

engConf - Engine Configuration to check

Throws:

KKAdminException - if the mode isn't supported

initSingleStore

protected void initSingleStore()
                        throws KKAdminException

Initialisation and start-up checks for the Single Store Mode

Throws:

KKAdminException - an unexpected KKAdminException exception

initMultiStoreSingleDB

protected void initMultiStoreSingleDB()
                               throws KKAdminException

Initialisation for MultiStore Single Database.

Throws:

KKAdminException - an unexpected KKAdminException exception

initMultiStoreMultiDB

protected void initMultiStoreMultiDB()
                              throws KKAdminException

Throws:

KKAdminException - an unexpected KKAdminException exception

initTorque

protected void initTorque()
                   throws KKAdminException,
                          org.apache.torque.TorqueException

The initialisation of Torque is synchronised.

Throws:

KKAdminException - an unexpected KKAdminException exception

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

initKonakart

protected void initKonakart()
                     throws KKAdminException

Initialise KonaKart from the properties file

Throws:

KKAdminException - an unexpected KKAdminException exception

getDbVersion

public java.lang.String getDbVersion()

Returns:

a String representing the Database version currently installed

getKonakartPropertyValue

public java.lang.String getKonakartPropertyValue(java.lang.String section,
                                                 java.lang.String propertyName)
                                          throws KKAdminException

Returns the property value from the properties file in the specified section

Parameters:

section - Properties file section e.g. the first part of the property name ("konakart" or "torque"). Use constants in KonakartAdminConstants, eg. KonakartAdminConstants.PROPERTY_FILE_SECTION_KONAKART or KonakartAdminConstants.PROPERTY_FILE_SECTION_TORQUE etc

propertyName - property name

Returns:

Returns the value of the specified property as a String

Throws:

KKAdminException - if there were problems with the arguments of the KonaKart configuration information isn't available.

getKonakartPropertyValueWithDefault

public java.lang.String getKonakartPropertyValueWithDefault(java.lang.String section,
                                                            java.lang.String propertyName,
                                                            java.lang.String def)
                                                     throws KKAdminException

Returns the property value from the properties file in the specified section or the default if the property isn't found

Parameters:

section - Properties file section e.g. the first part of the property name ("konakart" or "torque"). Use constants in KonakartAdminConstants, eg. KonakartAdminConstants.PROPERTY_FILE_SECTION_KONAKART or KonakartAdminConstants.PROPERTY_FILE_SECTION_TORQUE etc

propertyName - property name

def - default value to use if the property isn't found

Returns:

Returns the value of the specified property as a String or the default value if the property isn't found

Throws:

KKAdminException - if there were problems with the arguments of the KonaKart configuration information isn't available.

getKonakartPropertyValueAsBoolWithDefault

public boolean getKonakartPropertyValueAsBoolWithDefault(java.lang.String section,
                                                         java.lang.String propertyName,
                                                         boolean def)
                                                  throws KKAdminException

Returns the property boolean value from the properties file in the specified section or the default if the property isn't found

Parameters:

section - Properties file section e.g. the first part of the property name ("konakart" or "torque"). Use constants in KonakartAdminConstants, eg. KonakartAdminConstants.PROPERTY_FILE_SECTION_KONAKART or KonakartAdminConstants.PROPERTY_FILE_SECTION_TORQUE etc

propertyName - property name

def - default value to use if the property isn't found

Returns:

Returns the value of the specified property as a boolean or the default value if the property isn't found

Throws:

KKAdminException - if there were problems with the arguments of the KonaKart configuration information isn't available.

getKonakartPropertyValueAsLongWithDefault

public long getKonakartPropertyValueAsLongWithDefault(java.lang.String section,
                                                      java.lang.String propertyName,
                                                      long def)
                                               throws KKAdminException

Returns the property long value from the properties file in the specified section or the default if the property isn't found or isn't a legal long value

Parameters:

section - Properties file section e.g. the first part of the property name ("konakart" or "torque"). Use constants in KonakartAdminConstants, eg. KonakartAdminConstants.PROPERTY_FILE_SECTION_KONAKART or KonakartAdminConstants.PROPERTY_FILE_SECTION_TORQUE etc

propertyName - property name

def - default value to use if the property isn't found

Returns:

Returns the value of the specified property as a long or the default value if the property isn't found or isn't a legal long value

Throws:

KKAdminException - if there were problems with the arguments of the KonaKart configuration information isn't available.

getKonaKartVersion

public java.lang.String getKonaKartVersion()
                                    throws KKAdminException

Get the KonaKart Version Number from the properties file

Returns:

the KonaKart Version number as a String

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getKonaKartBuildDate

public java.lang.String getKonaKartBuildDate()
                                      throws KKAdminException

Get the KonaKart Build Date from the properties file

Returns:

the KonaKart Build Date number as a String

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getKonakartTimeStamp

public static java.util.Calendar getKonakartTimeStamp()

Returns:

get a Konakart timestamp

getKonakartTimeStampDate

public static java.util.Date getKonakartTimeStampDate()

Returns:

get a Konakart timestamp

getExceptionMessage

protected java.lang.String getExceptionMessage(java.lang.Throwable e)

Returns a string containing the stack trace of the exception and its cause

Parameters:

e - the e

Returns:

Returns a string containing the stack trace

auditInserts

protected void auditInserts(int userId,
                            java.lang.Object obj,
                            java.lang.String methodName,
                            int newId)
                     throws java.lang.Exception

Auditing for inserts

Parameters:

userId - the userId

obj - the obj

methodName - the methodName

newId - the newId

Throws:

java.lang.Exception - an unexpected exception

auditInserts

protected void auditInserts(int userId,
                            java.lang.Object[] objs,
                            java.lang.String methodName,
                            int newId)
                     throws java.lang.Exception

Auditing for inserts for an array of products

Parameters:

userId - the userId

objs - the objs

methodName - the methodName

newId - the newId

Throws:

java.lang.Exception - an unexpected exception

auditInserts

protected void auditInserts(int userId,
                            java.lang.String methodName,
                            java.lang.Object obj)
                     throws java.lang.Exception

Auditing for inserts for an array of products

Parameters:

userId - the userId

methodName - the methodName

obj - the obj

Throws:

java.lang.Exception - an unexpected exception

auditInserts

protected void auditInserts(int userId,
                            java.lang.String methodName,
                            java.lang.String data)
                     throws java.lang.Exception

Auditing for inserts where we just insert ids

Parameters:

userId - the userId

methodName - the methodName

data - the data

Throws:

java.lang.Exception - an unexpected exception

auditEdits

protected void auditEdits(int userId,
                          java.lang.String methodName,
                          java.lang.String data)
                   throws java.lang.Exception

Auditing for updates

Parameters:

userId - the userId

methodName - the methodName

data - the data

Throws:

java.lang.Exception - an unexpected exception

auditEdits

protected void auditEdits(int userId,
                          java.lang.Object obj,
                          java.lang.String methodName)
                   throws java.lang.Exception

Auditing for edits

Parameters:

userId - the userId

obj - the obj

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditEdits

protected void auditEdits(int userId,
                          java.lang.Object obj,
                          int objectId,
                          java.lang.String methodName)
                   throws java.lang.Exception

Auditing for edits

Parameters:

userId - the userId

obj - the obj

objectId - the objectId

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditEdits

protected void auditEdits(int userId,
                          java.lang.Object obj,
                          java.lang.String key,
                          java.lang.String methodName)
                   throws java.lang.Exception

Auditing for edits

Parameters:

userId - the userId

obj - the obj

key - any String key

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditEdits

protected void auditEdits(int userId,
                          java.lang.Object obj,
                          int objectId,
                          java.lang.String key,
                          java.lang.String methodName)
                   throws java.lang.Exception

Auditing for edits

Parameters:

userId - the userId

obj - the obj

objectId - the objectId

key - any String key

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditReads

protected void auditReads(int userId,
                          int objectId,
                          java.lang.String methodName)
                   throws java.lang.Exception

Auditing for reads

Parameters:

userId - the userId

objectId - the objectId

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditReads

protected void auditReads(int userId,
                          java.lang.String object,
                          java.lang.String methodName)
                   throws java.lang.Exception

Auditing for reads

Parameters:

userId - the userId

object - the object

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditDeletes

protected void auditDeletes(int userId,
                            java.lang.Object obj,
                            java.lang.String methodName)
                     throws java.lang.Exception

Auditing for deletes of a single object when there is no objectId to specify

Parameters:

userId - the userId

obj - the obj

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditDeletes

protected void auditDeletes(int userId,
                            java.lang.Object obj,
                            int objectId,
                            java.lang.String methodName)
                     throws java.lang.Exception

Auditing for deletes of a single object

Parameters:

userId - the userId

obj - the obj

objectId - the objectId

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditDeletes

protected void auditDeletes(int userId,
                            int objectId,
                            java.lang.String methodName)
                     throws java.lang.Exception

Auditing for deletes of a single object

Parameters:

userId - the userId

objectId - the objectId

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditDeletes

protected void auditDeletes(int userId,
                            java.lang.String objAsString,
                            java.lang.String methodName)
                     throws java.lang.Exception

Auditing for deletes of a single object, when the object has no integer id

Parameters:

userId - the userId

objAsString - the objAsString

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

auditDeletesForArray

protected void auditDeletesForArray(int userId,
                                    java.lang.Object[] objArray,
                                    int objectId,
                                    java.lang.String methodName)
                             throws java.lang.Exception

Auditing for deletes of an array of objects

Parameters:

userId - the userId

objArray - the objArray

objectId - the objectId

methodName - the methodName

Throws:

java.lang.Exception - an unexpected exception

checkManagerExists

protected void checkManagerExists(java.lang.Object mgr,
                                  java.lang.String functionalityName)
                           throws KKAdminException

Common code to check for optional managers

Parameters:

mgr - the mgr

functionalityName - the functionalityName

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getLogMgr

public static com.konakart.clientlogging.LogMgr getLogMgr()

Returns:

Returns the logMgr creating it if it doesn't exist already.

getAdminProductMgr

public AdminProductMgrIf getAdminProductMgr()
                                     throws java.lang.Exception

Returns:

an AdminProductMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminMiscPriceMgr

public AdminMiscPriceMgrIf getAdminMiscPriceMgr()
                                         throws java.lang.Exception

Returns:

an AdminMiscPriceMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getModulesMgr

public AdminModulesMgrIf getModulesMgr()
                                throws java.lang.Exception

Returns:

the modulesMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminLanguageMgr

public AdminLanguageMgrIf getAdminLanguageMgr()
                                       throws java.lang.Exception

Returns:

an AdminLanguageMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminCurrencyMgr

public AdminCurrencyMgrIf getAdminCurrencyMgr()
                                       throws java.lang.Exception

Returns:

Returns the adminCurrencyMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminCategoryMgr

public AdminCategoryMgrIf getAdminCategoryMgr()
                                       throws java.lang.Exception

Returns:

Returns the adminCategoryMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminManufacturerMgr

public AdminManufacturerMgrIf getAdminManufacturerMgr()
                                               throws java.lang.Exception

Returns:

Returns the adminManufacturerMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminHtmlMgr

public AdminHtmlMgrIf getAdminHtmlMgr()
                               throws java.lang.Exception

Returns:

Returns the adminHtmlMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminPdfMgr

public AdminPdfMgrIf getAdminPdfMgr()
                             throws java.lang.Exception

Returns:

Returns the adminPdfMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminFileMgr

public AdminFileMgrIf getAdminFileMgr()
                               throws java.lang.Exception

Returns:

Returns the adminFileMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminFilterMgr

public AdminFilterMgrIf getAdminFilterMgr()
                                   throws java.lang.Exception

Returns:

Returns the adminFilterMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminReportMgr

public AdminReportMgrIf getAdminReportMgr()
                                   throws java.lang.Exception

Returns:

Returns the adminReportMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminEventMgr

public AdminEventMgrIf getAdminEventMgr()
                                 throws java.lang.Exception

Returns:

Returns the adminEventMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminSearchRuleMgr

protected AdminSearchRuleMgrIf getAdminSearchRuleMgr()
                                              throws java.lang.Exception

Returns:

Returns the AdminSearchRuleMg.

Throws:

java.lang.Exception - an unexpected exception

getAdminReviewMgr

public AdminReviewMgrIf getAdminReviewMgr()
                                   throws java.lang.Exception

Returns:

Returns the adminReviewMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminEmailMgr

public AdminEmailMgrIf getAdminEmailMgr()
                                 throws java.lang.Exception

Returns:

Returns a new adminEmailMgr

Throws:

java.lang.Exception - an unexpected exception

getAdminMessageMgr

public AdminMessageMgrIf getAdminMessageMgr()
                                     throws java.lang.Exception

Returns:

Returns the adminMessageMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminValidationMgr

public AdminValidationMgrIf getAdminValidationMgr()
                                           throws java.lang.Exception

Returns:

Returns the adminValidationMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminPromotionMgr

public AdminPromotionMgrIf getAdminPromotionMgr()
                                         throws java.lang.Exception

Returns:

Returns the adminPromotionMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminRemoteAccessMgr

public AdminRemoteAccessMgrIf getAdminRemoteAccessMgr()
                                               throws java.lang.Exception

Returns:

Returns the adminRemoteAccessMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminAuditMgr

public AdminAuditMgrIf getAdminAuditMgr()
                                 throws java.lang.Exception

Returns:

an AdminAuditMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminSecurityMgr

public AdminSecurityMgrIf getAdminSecurityMgr()
                                       throws java.lang.Exception

Returns:

an AdminSecurityMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminStoreMgr

public AdminStoreMgrIf getAdminStoreMgr()
                                 throws KKAdminException

Returns:

an AdminStoreMgr creating one if it didn't previously exist

Throws:

KKAdminException - unexpected exception in the KonaKart Admin Engine

getAdminConfigurationMgr

public AdminConfigurationMgrIf getAdminConfigurationMgr()
                                                 throws java.lang.Exception

Returns:

an AdminConfigurationMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminContentMgr

public AdminContentMgrIf getAdminContentMgr()
                                     throws java.lang.Exception

Returns:

an AdminContentMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminOrderMgr

public AdminOrderMgrIf getAdminOrderMgr()
                                 throws java.lang.Exception

Returns:

an AdminOrdersMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminTaxMgr

public AdminTaxMgrIf getAdminTaxMgr()
                             throws java.lang.Exception

Returns:

an AdminTaxMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminTagMgr

public AdminTagMgrIf getAdminTagMgr()
                             throws java.lang.Exception

Returns:

an AdminTagMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminWishListMgr

public AdminWishListMgrIf getAdminWishListMgr()
                                       throws java.lang.Exception

Returns:

an AdminWishListMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminCustomerTagMgr

public AdminCustomerTagMgrIf getAdminCustomerTagMgr()
                                             throws java.lang.Exception

Returns:

an AdminCustomerMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminProdAttrMgr

public AdminProdAttrMgrIf getAdminProdAttrMgr()
                                       throws java.lang.Exception

Returns:

an AdminProdAttrMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminRewardPointMgr

public AdminRewardPointMgrIf getAdminRewardPointMgr()
                                             throws java.lang.Exception

Returns:

an AdminRewardPointMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminAddressMgr

public AdminAddressMgrIf getAdminAddressMgr()
                                     throws java.lang.Exception

Returns:

an AdminAddressMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminBillingMgr

public AdminBillingMgrIf getAdminBillingMgr()
                                     throws java.lang.Exception

Returns:

an AdminBillingMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminSchedulerMgr

public AdminSchedulerMgrIf getAdminSchedulerMgr()
                                         throws java.lang.Exception

Returns:

an AdminSchedulerMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminDataIntegrityMgr

public AdminDataIntegrityMgrIf getAdminDataIntegrityMgr()
                                                 throws java.lang.Exception

Returns:

an AdminDataIntegrityMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminCustomerMgr

public AdminCustomerMgrIf getAdminCustomerMgr()
                                       throws java.lang.Exception

Returns:

an AdminCustomerMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminCustomerPwdHistMgr

public AdminCustomerPwdHistMgrIf getAdminCustomerPwdHistMgr()
                                                     throws java.lang.Exception

Returns:

an AdminCustomerPwdHistMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminSolrMgr

public AdminSolrMgrIf getAdminSolrMgr()
                               throws java.lang.Exception

Returns:

an AdminSolrMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminBookableProductMgr

public AdminBookableProductMgrIf getAdminBookableProductMgr()
                                                     throws java.lang.Exception

Returns:

an AdminBookableProductMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminMiscItemMgr

public AdminMiscItemMgrIf getAdminMiscItemMgr()
                                       throws java.lang.Exception

Returns:

an AdminMiscItemMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminShipmentMgr

public AdminShipmentMgrIf getAdminShipmentMgr()
                                       throws java.lang.Exception

Returns:

an AdminShipmentMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminSuggestionMgr

public AdminSuggestionMgrIf getAdminSuggestionMgr()
                                           throws java.lang.Exception

Returns:

an AdminSuggestionMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getAdminExecuteMgr

public AdminExecuteMgrIf getAdminExecuteMgr()
                                     throws java.lang.Exception

Returns:

an AdminExecuteMgr creating one if it didn't previously exist

Throws:

java.lang.Exception - an unexpected exception

getKonakartAdminPropsFilePath

public java.lang.String getKonakartAdminPropsFilePath()

Returns:

Returns the konakartAdminPropsFilePath.

setKonakartAdminPropsFilePath

public void setKonakartAdminPropsFilePath(java.lang.String konakartAdminPropsFilePath)

Parameters:

konakartAdminPropsFilePath - The konakartAdminPropsFilePath to set.

getKonakartAdminPropsFileName

public java.lang.String getKonakartAdminPropsFileName()

Returns:

Returns the konakartAdminPropsFileName.

setKonakartAdminPropsFileName

public void setKonakartAdminPropsFileName(java.lang.String konakartAdminPropsFileName)

Parameters:

konakartAdminPropsFileName - The konakartAdminPropsFileName to set.

isSingleStoreMode

public boolean isSingleStoreMode()

Returns:

Returns the engConf.

getEngConf

public AdminEngineConfig getEngConf()

Returns:

Returns the engConf.

getEngineId

protected java.lang.String getEngineId()

Returns:

Returns the engineId ("E", "B", "C" or "?")

getEngineModeStr

protected java.lang.String getEngineModeStr()

Returns:

Returns a String representing the engine Mode ("0", "1", "2" or "?"). Returns "-" if the EngineConfig is set but the mode is not recognised.

getEngineShareMode

protected java.lang.String getEngineShareMode()

Returns:

Returns a String representing the sharing mode of the engine. "-" for nothing shared to "CPT" for Customers, Products and categories shared. Returns "?" if there's no engine config.

setEngConf

public void setEngConf(AdminEngineConfig engConf)

Parameters:

engConf - The engConf to set.

getAdminEng

public KKAdmin getAdminEng()

Returns:

Returns the adminEng.

setAdminEng

public void setAdminEng(KKAdmin adminEng)

Parameters:

adminEng - The adminEng to set.

getConfigFile

protected static java.lang.String getConfigFile()

Returns:

the configFile

isTorqueInit

public static boolean isTorqueInit()

Returns:

the torqueInit

manageThrowable

protected KKAdminException manageThrowable(java.lang.Throwable e)

Common code to manage exceptions in the KKAdmin engine

Parameters:

e - the e

Returns:

Either the exception specified if it's already a KKAdminException or a new KKAdminException that wraps the specified exception

manageThrowable

protected KKAdminException manageThrowable(java.lang.Throwable e,
                                           boolean notifyByEmail)

Common code to manage exceptions in the KKAdmin engine

Parameters:

e - the e

notifyByEmail - If true notify the exception by email if the config value is set. If false we never notify the exception by email.

Returns:

Either the exception specified if it's already a KKAdminException or a new KKAdminException that wraps the specified exception

getStoreName

protected java.lang.String getStoreName(AdminConfigurationMgrIf adminConfMgr)

Get the value of the STORE_NAME configuration parameter. Exceptions are logged but ignored.

Parameters:

adminConfMgr - An AdminConfigurationMgr

Returns:

the Store Name

getKkInstanceId

protected java.lang.String getKkInstanceId()
                                    throws KKAdminException

Get the instance Id from the properties file

Returns:

the kkInstanceId

Throws:

KKAdminException - an unexpected KKAdminException exception

checkEnterpriseForExtPriceOrExtQuantity

protected void checkEnterpriseForExtPriceOrExtQuantity(AdminProductMgrOptions mgrOptions)
                                                throws KKAdminException

External prices and quantity require the enterprise version to be present.

Parameters:

mgrOptions - the mgrOptions

Throws:

KKAdminException - an unexpected KKAdminException exception

checkEnterpriseForCatalog

protected void checkEnterpriseForCatalog()
                                  throws KKAdminException

Catalogs require the enterprise version to be present.

Throws:

KKAdminException - an unexpected KKAdminException exception

excludedException

protected boolean excludedException(java.lang.String message)

Should the exception message be excluded from reporting by email?

Parameters:

message - the exception message

Returns:

true if the exception message should be excluded

getEmailReportingExclusions

public java.util.Set<java.lang.String> getEmailReportingExclusions()

Returns:

the emailReportingExclusions

checkLicense

protected boolean checkLicense()
                        throws KKAdminException

Check that the Mago License is valid - if it's a Mago system.

Returns:

true if the Mago License is valid or not a Mago system. A Mago license is considered valid if the serial number is bad but we are still within the grace period.

Throws:

KKAdminException - if the license is not valid