com.konakartadmin.bl

Class AdminConfigurationMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminConfigurationMgr

All Implemented Interfaces:

AdminConfigurationMgrIf

public class AdminConfigurationMgr
extends AdminBaseMgr
implements AdminConfigurationMgrIf

The AdminConfigurationMgr - for Managing Configurations for the Admin Application

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminConfigurationMgr.StaticData Static Data Object

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.commons.logging.Log	log the log
protected static java.lang.String	mutex Mutex for this manager
private long	refreshCacheRequest Timestamp of the last refresh Cache Request.
protected static java.util.Map<java.lang.String,AdminConfigurationMgr.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
AdminConfigurationMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
protected int	findKeyInConfig(KKConfiguration[] configs, java.lang.String key)
AdminConfigurationGroup[]	getAllConfigurationGroups() Returns an array of all the Configuration Group objects
KKConfiguration[]	getAllConfigurations() Returns an array of all the Configuration objects
AdminConfigData[]	getConfigData(java.lang.String key) Returns the AdminConfigData items with the specified key or all AdminConfigData items if the key is null.
KKConfiguration	getConfiguration(java.lang.String key) Returns a Configuration object referenced by the specified key
KKConfiguration	getConfigurationFromDb(java.lang.String key) Returns a Configuration object from the database referenced by the specified key
AdminConfigurationGroup[]	getConfigurationGroupsByTitle(java.lang.String title) Returns an array of AdminConfigurationGroup objects with the specified title
java.lang.String[]	getConfigurationInfo(java.lang.String[] validationKeys) Get the configuration values for the given keys
int	getConfigurationIntValue(java.lang.String key) Returns a Configuration Value for the specified key as an integer
int	getConfigurationIntValueOrDefault(java.lang.String key, int defaultVal) Returns a Configuration Value for the specified key as an integer - or a default value
KKConfiguration[]	getConfigurationsByGroup(int configGroup) Returns an array of Configuration objects for the specified configuration group id
java.lang.String	getConfigurationValue(java.lang.String key) Returns a Configuration Value for the specified key
java.lang.String	getConfigurationValue(java.lang.String key, java.lang.String def) Returns a Configuration Value for the specified key or the default if the configuration key can't be found
boolean	getConfigurationValueAsBool(java.lang.String key, boolean defaultVal) Returns a Configuration Value for the specified key as a boolean - or the specified default value
java.lang.String	getPropertyValue(java.lang.String propKey)
java.lang.String	getPropertyValue(java.lang.String propKey, java.lang.String def) Get the property value as a String if found, otherwise return the default
boolean	getPropertyValueAsBool(java.lang.String propKey, boolean def) Get the property value as a boolean if found, otherwise return the default
int	getPropertyValueAsInt(java.lang.String propKey, int def) Get the property value as an int if found, otherwise return the default
long	getPropertyValueAsLong(java.lang.String propKey, long def) Get the property value as a long if found, otherwise return the default
long	getRefreshCacheRequest()
protected int	insertConfigData(AdminConfigData config) Insert the AdminConfigData item.
int[]	insertConfigData(AdminConfigData[] configs) Insert the AdminConfigData item.
void	insertConfigs(KKConfiguration[] config) Insert one or more new configuration parameters
int	insertConfiguration(KKConfiguration config) Insert a configuration object
int	insertConfigurationGroup(AdminConfigurationGroup configGroup) Insert a configuration group
void	refreshConfigs() Clear the configuration cache
void	removeConfigData(int id) Remove the AdminConfigData item from the Database.
void	removeConfigs(java.lang.String[] configKeys) Remove one or more configuration parameters
void	removeConfigsByIds(int[] configIds) Remove one or more configuration parameters
void	saveConfigs(KKConfiguration[] configs, KKConfiguration[] origConfigs) Saves an array of KKConfiguration objects to the database.
boolean	setConfigurationValue(java.lang.String key, java.lang.String value) Sets a Configuration Value for the specified key
void	setRefreshCacheRequest(long refreshCacheRequest)
void	updateConfigCaches() Updates any caches we have made of the configuration variables
protected void	updateConfigData(AdminConfigData config) Update the AdminConfigData item.
void	updateConfigData(AdminConfigData[] configs) Update the AdminConfigData items.
void	updateConfiguration(KKConfiguration newConf) Updates a KKConfiguration object
void	updateConfigurationGroup(AdminConfigurationGroup newConf) Updates an AdminConfigurationGroup object

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

the log

mutex

protected static java.lang.String mutex

Mutex for this manager

staticDataHM

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

Hash Map that contains the static data

refreshCacheRequest

private long refreshCacheRequest

Timestamp of the last refresh Cache Request. This is used to determine whether or not to refresh our cache.

Constructor Detail

AdminConfigurationMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

getConfigurationsByGroup

public KKConfiguration[] getConfigurationsByGroup(int configGroup)
                                           throws org.apache.torque.TorqueException,
                                                  com.workingdogs.village.DataSetException

Returns an array of Configuration objects for the specified configuration group id

Specified by:

getConfigurationsByGroup in interface AdminConfigurationMgrIf

Parameters:

configGroup - the Configuration GroupId

Returns:

An array of Configuration objects in the specified Config Group

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getAllConfigurations

public KKConfiguration[] getAllConfigurations()
                                       throws org.apache.torque.TorqueException,
                                              com.workingdogs.village.DataSetException

Returns an array of all the Configuration objects

Specified by:

getAllConfigurations in interface AdminConfigurationMgrIf

Returns:

An array of Configuration objects

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getAllConfigurationGroups

public AdminConfigurationGroup[] getAllConfigurationGroups()
                                                    throws org.apache.torque.TorqueException,
                                                           com.workingdogs.village.DataSetException

Returns an array of all the Configuration Group objects

Specified by:

getAllConfigurationGroups in interface AdminConfigurationMgrIf

Returns:

An array of Configuration Group objects

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

getConfigurationInfo

public java.lang.String[] getConfigurationInfo(java.lang.String[] validationKeys)
                                        throws org.apache.torque.TorqueException,
                                               com.workingdogs.village.DataSetException,
                                               KKAdminException

Get the configuration values for the given keys

Specified by:

getConfigurationInfo in interface AdminConfigurationMgrIf

Parameters:

validationKeys - an array of configuration keys

Returns:

Returns an array of Configuration key values - typically used for validation on the UI

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfiguration

public KKConfiguration getConfiguration(java.lang.String key)
                                 throws org.apache.torque.TorqueException,
                                        com.workingdogs.village.DataSetException,
                                        KKAdminException

Returns a Configuration object referenced by the specified key

Specified by:

getConfiguration in interface AdminConfigurationMgrIf

Parameters:

key - thConfiguration Key

Returns:

The KKConfiguration object if the key is found, otherwise it returns null

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfigurationFromDb

public KKConfiguration getConfigurationFromDb(java.lang.String key)
                                       throws org.apache.torque.TorqueException,
                                              com.workingdogs.village.DataSetException,
                                              KKAdminException

Returns a Configuration object from the database referenced by the specified key

Specified by:

getConfigurationFromDb in interface AdminConfigurationMgrIf

Parameters:

key - thConfiguration Key

Returns:

The KKConfiguration object if the key is found, otherwise it returns null

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfigurationValue

public java.lang.String getConfigurationValue(java.lang.String key)
                                       throws org.apache.torque.TorqueException,
                                              com.workingdogs.village.DataSetException,
                                              KKAdminException

Returns a Configuration Value for the specified key

Specified by:

getConfigurationValue in interface AdminConfigurationMgrIf

Parameters:

key - the Configuration key

Returns:

The String value of the specified configuration key's value or null if the key is not found.

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfigurationValue

public java.lang.String getConfigurationValue(java.lang.String key,
                                              java.lang.String def)
                                       throws org.apache.torque.TorqueException,
                                              com.workingdogs.village.DataSetException,
                                              KKAdminException

Returns a Configuration Value for the specified key or the default if the configuration key can't be found

Specified by:

getConfigurationValue in interface AdminConfigurationMgrIf

Parameters:

key - the Configuration key

def - the default to use if the configuration key can't be found

Returns:

The String value of the specified configuration key's value or the default if the configuration key can't be found.

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfigurationIntValue

public int getConfigurationIntValue(java.lang.String key)
                             throws org.apache.torque.TorqueException,
                                    com.workingdogs.village.DataSetException,
                                    KKAdminException

Returns a Configuration Value for the specified key as an integer

Specified by:

getConfigurationIntValue in interface AdminConfigurationMgrIf

Parameters:

key - the configuration key

Returns:

the value of the key as an integer - or KonakartAdminConstants.NOT_SET if the key isn't found

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfigurationIntValueOrDefault

public int getConfigurationIntValueOrDefault(java.lang.String key,
                                             int defaultVal)
                                      throws org.apache.torque.TorqueException,
                                             com.workingdogs.village.DataSetException,
                                             KKAdminException

Returns a Configuration Value for the specified key as an integer - or a default value

Specified by:

getConfigurationIntValueOrDefault in interface AdminConfigurationMgrIf

Parameters:

key - the configuration key

defaultVal - the default value to be returned if the key isn't found

Returns:

the value of the key as an integer - or the specified default if the key isn't found

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfigurationValueAsBool

public boolean getConfigurationValueAsBool(java.lang.String key,
                                           boolean defaultVal)
                                    throws org.apache.torque.TorqueException,
                                           com.workingdogs.village.DataSetException,
                                           KKAdminException

Description copied from interface: AdminConfigurationMgrIf

Returns a Configuration Value for the specified key as a boolean - or the specified default value

Specified by:

getConfigurationValueAsBool in interface AdminConfigurationMgrIf

Parameters:

key - the configuration key

defaultVal - the default value to be returned if the key isn't found

Returns:

the value of the key as a boolean - or the specified default if the key isn't found

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

setConfigurationValue

public boolean setConfigurationValue(java.lang.String key,
                                     java.lang.String value)
                              throws org.apache.torque.TorqueException,
                                     com.workingdogs.village.DataSetException,
                                     KKAdminException

Sets a Configuration Value for the specified key

Specified by:

setConfigurationValue in interface AdminConfigurationMgrIf

Parameters:

key - key whose value will be set

value - value to set

Returns:

returns true if the value is set correctly, false if the key wasn't found

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

saveConfigs

public void saveConfigs(KKConfiguration[] configs,
                        KKConfiguration[] origConfigs)
                 throws java.lang.Exception

Saves an array of KKConfiguration objects to the database.

Specified by:

saveConfigs in interface AdminConfigurationMgrIf

Parameters:

configs - Configuration array to save. For optimum performance, any records to insert should be placed at the end of the array and marked with the status KonakartAdminConstants.STATUS_INSERTED. Any records to be deleted should be marked with the KonakartAdminConstants.STATUS_DELETED status.

origConfigs - Original Configuration array to compare against

Throws:

java.lang.Exception - an unexpected exception

findKeyInConfig

protected int findKeyInConfig(KKConfiguration[] configs,
                              java.lang.String key)

insertConfigs

public void insertConfigs(KKConfiguration[] config)
                   throws org.apache.torque.TorqueException

Insert one or more new configuration parameters

Specified by:

insertConfigs in interface AdminConfigurationMgrIf

Parameters:

config - an array of KKConfiguration objects to insert

Throws:

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

removeConfigs

public void removeConfigs(java.lang.String[] configKeys)
                   throws org.apache.torque.TorqueException,
                          java.lang.Exception

Remove one or more configuration parameters

Specified by:

removeConfigs in interface AdminConfigurationMgrIf

Parameters:

configKeys - an array of configuration key Strings to remove

Throws:

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

java.lang.Exception - an unexpected exception

removeConfigsByIds

public void removeConfigsByIds(int[] configIds)
                        throws org.apache.torque.TorqueException,
                               java.lang.Exception

Remove one or more configuration parameters

Specified by:

removeConfigsByIds in interface AdminConfigurationMgrIf

Parameters:

configIds - an array of configuration Id ints to remove

Throws:

java.lang.Exception - an unexpected exception

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

updateConfigCaches

public void updateConfigCaches()
                        throws java.lang.Exception

Updates any caches we have made of the configuration variables

Specified by:

updateConfigCaches in interface AdminConfigurationMgrIf

Throws:

java.lang.Exception - an unexpected exception

insertConfigurationGroup

public int insertConfigurationGroup(AdminConfigurationGroup configGroup)
                             throws org.apache.torque.TorqueException,
                                    KKAdminException

Insert a configuration group

Specified by:

insertConfigurationGroup in interface AdminConfigurationMgrIf

Parameters:

configGroup - an AdminConfigurationGroup object to insert

Returns:

Returns the primary key of the configuration group that was inserted

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

insertConfiguration

public int insertConfiguration(KKConfiguration config)
                        throws org.apache.torque.TorqueException,
                               KKAdminException

Insert a configuration object

Specified by:

insertConfiguration in interface AdminConfigurationMgrIf

Parameters:

config - a KKConfiguration object to insert

Returns:

Returns the primary key of the configuration object that was inserted

Throws:

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

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateConfiguration

public void updateConfiguration(KKConfiguration newConf)
                         throws org.apache.torque.TorqueException,
                                com.workingdogs.village.DataSetException,
                                KKAdminException

Updates a KKConfiguration object

Specified by:

updateConfiguration in interface AdminConfigurationMgrIf

Parameters:

newConf - the KKConfiguration to update

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateConfigurationGroup

public void updateConfigurationGroup(AdminConfigurationGroup newConf)
                              throws org.apache.torque.TorqueException,
                                     com.workingdogs.village.DataSetException,
                                     KKAdminException

Updates an AdminConfigurationGroup object

Specified by:

updateConfigurationGroup in interface AdminConfigurationMgrIf

Parameters:

newConf - the AdminConfigurationGroup to update

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfigurationGroupsByTitle

public AdminConfigurationGroup[] getConfigurationGroupsByTitle(java.lang.String title)
                                                        throws org.apache.torque.TorqueException,
                                                               com.workingdogs.village.DataSetException,
                                                               KKAdminException

Returns an array of AdminConfigurationGroup objects with the specified title

Specified by:

getConfigurationGroupsByTitle in interface AdminConfigurationMgrIf

Parameters:

title - the title

Returns:

An array of AdminConfigurationGroup objects

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

getConfigData

public AdminConfigData[] getConfigData(java.lang.String key)
                                throws org.apache.torque.TorqueException,
                                       com.workingdogs.village.DataSetException,
                                       KKAdminException

Description copied from interface: AdminConfigurationMgrIf

Returns the AdminConfigData items with the specified key or all AdminConfigData items if the key is null.

Specified by:

getConfigData in interface AdminConfigurationMgrIf

Parameters:

key - Only return the AdminConfigData items with this key (if null all AdminConfigData items are returned)

Returns:

Returns an array of AdminConfigData items with the specified key or all AdminConfigData items if the key is null ordered by date added

Throws:

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

com.workingdogs.village.DataSetException - an unexpected exception due to data in Torque (the database layer)

KKAdminException - an unexpected exception in the KonaKart Admin engine

updateConfigData

public void updateConfigData(AdminConfigData[] configs)
                      throws KKAdminException,
                             org.apache.torque.TorqueException

Update the AdminConfigData items.

Specified by:

updateConfigData in interface AdminConfigurationMgrIf

Parameters:

configs - The AdminConfigData items to update

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

updateConfigData

protected void updateConfigData(AdminConfigData config)
                         throws KKAdminException,
                                org.apache.torque.TorqueException

Update the AdminConfigData item.

Parameters:

config - The AdminConfigData item to update

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

insertConfigData

public int[] insertConfigData(AdminConfigData[] configs)
                       throws KKAdminException,
                              org.apache.torque.TorqueException

Insert the AdminConfigData item.

Specified by:

insertConfigData in interface AdminConfigurationMgrIf

Parameters:

configs - The AdminConfigData items to insert

Returns:

Return an array containing the Ids of the inserted AdminConfigData objects

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

insertConfigData

protected int insertConfigData(AdminConfigData config)
                        throws KKAdminException,
                               org.apache.torque.TorqueException

Insert the AdminConfigData item.

Parameters:

config - The AdminConfigData item to insert

Returns:

Return the Id of the inserted AdminConfigData object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

removeConfigData

public void removeConfigData(int id)
                      throws KKAdminException,
                             org.apache.torque.TorqueException

Remove the AdminConfigData item from the Database.

Specified by:

removeConfigData in interface AdminConfigurationMgrIf

Parameters:

id - The id of the AdminConfigData items to remove

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String propKey)
                                  throws KKAdminException

Specified by:

getPropertyValue in interface AdminConfigurationMgrIf

Overrides:

getPropertyValue in class AdminBaseMgr

Parameters:

propKey - the propKey

Returns:

the property value for the specified key in the konakart configuration which was derived from the konakart properties file

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getPropertyValue

public java.lang.String getPropertyValue(java.lang.String propKey,
                                         java.lang.String def)
                                  throws KKAdminException

Get the property value as a String if found, otherwise return the default

Specified by:

getPropertyValue in interface AdminConfigurationMgrIf

Overrides:

getPropertyValue in class AdminBaseMgr

Parameters:

propKey - the property key

def - the default to use if the key isn't found

Returns:

the property value, as a String, for the specified key in the konakart configuration which was derived from the konakartadmin properties file

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getPropertyValueAsInt

public int getPropertyValueAsInt(java.lang.String propKey,
                                 int def)
                          throws KKAdminException

Get the property value as an int if found, otherwise return the default

Specified by:

getPropertyValueAsInt in interface AdminConfigurationMgrIf

Overrides:

getPropertyValueAsInt in class AdminBaseMgr

Parameters:

propKey - the property key

def - the default to use if the key isn't found

Returns:

the property value, as an int, for the specified key in the konakart configuration which was derived from the konakartadmin properties file

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getPropertyValueAsLong

public long getPropertyValueAsLong(java.lang.String propKey,
                                   long def)
                            throws KKAdminException

Get the property value as a long if found, otherwise return the default

Specified by:

getPropertyValueAsLong in interface AdminConfigurationMgrIf

Overrides:

getPropertyValueAsLong in class AdminBaseMgr

Parameters:

propKey - the property key

def - the default to use if the key isn't found

Returns:

the property value, as a long, for the specified key in the konakart configuration which was derived from the konakartadmin properties file

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getPropertyValueAsBool

public boolean getPropertyValueAsBool(java.lang.String propKey,
                                      boolean def)
                               throws KKAdminException

Get the property value as a boolean if found, otherwise return the default

Specified by:

getPropertyValueAsBool in interface AdminConfigurationMgrIf

Overrides:

getPropertyValueAsBool in class AdminBaseMgr

Parameters:

propKey - the property key

def - the default to use if the key isn't found

Returns:

the property value, as a boolean, for the specified key in the konakart configuration which was derived from the konakartadmin properties file

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getRefreshCacheRequest

public long getRefreshCacheRequest()

Specified by:

getRefreshCacheRequest in interface AdminConfigurationMgrIf

Returns:

the refreshCacheRequest

setRefreshCacheRequest

public void setRefreshCacheRequest(long refreshCacheRequest)

Specified by:

setRefreshCacheRequest in interface AdminConfigurationMgrIf

Parameters:

refreshCacheRequest - the refreshCacheRequest to set

refreshConfigs

public void refreshConfigs()
                    throws KKAdminException

Clear the configuration cache

Specified by:

refreshConfigs in interface AdminConfigurationMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine