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/interfaces inherited from class com.konakartadmin.bl.AdminBaseMgr

AdminBaseMgr.StaticData

Field Summary

protected static org.apache.commons.logging.Log

log the log

Fields inherited from class com.konakartadmin.bl.AdminBaseMgr

adminEng, baseMgrMutex, baseStaticDataHM, cDataEnd, cDataStart, kkConf, kkInstanceId, mgrFactory, STORE_ID, templateBaseDir

Constructor Summary

AdminConfigurationMgr(KKAdminIf eng)
Constructor

Method Summary

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
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
boolean	getConfigurationValueAsBool(java.lang.String key, boolean defaultVal) Returns a Configuration Value for the specified key as a boolean - or the specified default value
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	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	updateConfigCaches() Updates any caches we have made of the configuration variables
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, checkIntIsSet, checkRequired, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminHtmlMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminPublishProdMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getExportXMLData, getIntFromString, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getPostSearchText, getPreSearchText, getPropertyValue, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, manageException, refreshConfigs, removeCData, setAdminEng, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr

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

Constructor Detail

AdminConfigurationMgr

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

Constructor

Parameters:

eng -

Throws:

java.lang.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

com.workingdogs.village.DataSetException

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

com.workingdogs.village.DataSetException

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

com.workingdogs.village.DataSetException

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

com.workingdogs.village.DataSetException

KKAdminException

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

com.workingdogs.village.DataSetException

KKAdminException

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 -

Returns:

A Configuration object

Throws:

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

KKAdminException

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

com.workingdogs.village.DataSetException

KKAdminException

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

com.workingdogs.village.DataSetException

KKAdminException

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

com.workingdogs.village.DataSetException

KKAdminException

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

com.workingdogs.village.DataSetException

KKAdminException

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

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

removeConfigs

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

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

removeConfigsByIds

public void removeConfigsByIds(int[] configIds)
                        throws org.apache.torque.TorqueException

Remove one or more configuration parameters

Specified by:

removeConfigsByIds in interface AdminConfigurationMgrIf

Parameters:

configIds - an array of configuration Id ints to remove

Throws:

org.apache.torque.TorqueException

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

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

KKAdminException

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

KKAdminException

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

com.workingdogs.village.DataSetException

KKAdminException

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

com.workingdogs.village.DataSetException

KKAdminException

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 -

Returns:

An array of AdminConfigurationGroup objects

Throws:

org.apache.torque.TorqueException

com.workingdogs.village.DataSetException

KKAdminException

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

com.workingdogs.village.DataSetException

KKAdminException