com.konakartadmin.bl

Class AdminAuditMgr

java.lang.Object

com.konakartadmin.bl.AdminBaseMgr

com.konakartadmin.bl.AdminAuditMgr

All Implemented Interfaces:

AdminAuditMgrIf

public class AdminAuditMgr
extends AdminBaseMgr
implements AdminAuditMgrIf

The AdminUditMgr - for managing auditing

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	AdminAuditMgr.StaticData Used to store the static data of this manager

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
protected static java.util.Map<java.lang.String,AdminAuditMgr.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
AdminAuditMgr(KKAdminIf eng) Constructor

Method Summary

Modifier and Type	Method and Description
void	deleteAuditData(AdminAuditSearch delSearch) Delete a AdminAudit Objects based on search criteria
protected int	getAuditCount(com.konakart.db.KKCriteria c) This method is mainly used for paging.
AdminAuditSearchResult	getAuditData(AdminAuditSearch retSearch, int offset, int size) Returns audit data specified by the AdminAuditSearch object
int	importAudit(AdminAudit audit) Imports an audit object.
int	insertAudit(AdminAudit audit) Inserts an audit object if auditing is enabled for the action type of the audit object (i.e.
boolean	isDeleteAudit() Returns true if delete audit is enabled
boolean	isDetailedDeleteAudit() Returns true if detailed delete audit is enabled
boolean	isDetailedEditAudit() Returns true if detailed edit audit is enabled
boolean	isDetailedInsertAudit() eturns true if detailed insert audit is enabled
boolean	isDetailedReadAudit()
boolean	isEditAudit() Returns true if edit audit is enabled
boolean	isInsertAudit() Returns true if insert audit is enabled
boolean	isReadAudit() Returns true if read audit is enabled
void	refreshConfigs() Refresh the configuration of the Admin Currency Manager
private java.lang.String	truncateObjectToStringForDB(java.lang.String str)
void	updateAuditModes() Read the config variables and update the modes
protected void	validateAudit(AdminAudit audit) Used to validate an AdminAudit object before editing or inserting

Methods inherited from class com.konakartadmin.bl.AdminBaseMgr

addInsertAttr, addInsertAttr, addStringRuleConstraint, addStringRuleConstraint, checkAPICallEnabled, checkIntInRange, checkIntIsSet, checkRequired, executeQuery, executeQuery, getAdminAddressMgr, getAdminAuditMgr, getAdminBillingMgr, getAdminBookableProductMgr, getAdminCatMgr, getAdminConfigMgr, getAdminContentMgr, getAdminCurrMgr, getAdminCustMgr, getAdminCustPwdHistMgr, getAdminCustTagMgr, getAdminEmailMgr, getAdminEng, getAdminEngineCacheMgr, getAdminEventMgr, getAdminExecuteMgr, getAdminFileMgr, getAdminFilterMgr, getAdminHtmlMgr, getAdminImportMgr, getAdminLanguageMgr, getAdminManuMgr, getAdminMessageMgr, getAdminMiscItemMgr, getAdminMiscPriceMgr, getAdminModulesMgr, getAdminMultiStoreMgr, getAdminOrderMgr, getAdminPdfMgr, getAdminProdAttrMgr, getAdminProdMgr, getAdminPromMgr, getAdminReviewMgr, getAdminSearchRuleMgr, getAdminSecMgr, getAdminServletMgr, getAdminShipmentMgr, getAdminSolrMgr, getAdminStoreMgr, getAdminSuggestionMgr, getAdminTagMgr, getAdminTaxMgr, getAdminValidationMgr, getAdminVelocityContextMgr, getAdminWishListMgr, getBooleanFromString, getDebugStackTraceExclusions, getEmailThreadGracefulShutdownTimeout, getExportMgr, getExportMgr, getExportXMLData, getIntFromString, getKkAdminPropsFilePath, getKkConfig, getKkInstanceId, getMode, getModeString, getMqMgr, getNewCriteria, getNewCriteria, getNewCriteria, getNewCriteria, getOtherModuleByName, getPostSearchText, getPreSearchText, getProductsToCategoresCriteria, getPropertyValue, getPropertyValue, getPropertyValueAsBool, getPropertyValueAsInt, getPropertyValueAsLong, getRecordCount, getRecordCount, getRewardPointMgr, getSingleIntResult, getStoreId, getTemplate, getTemplateBase, getXml_io, init, insertKKEvent, insertKKEvent, isBusiness, isBusinessOrEnterprise, isCommunity, isConfigSet, isEnterprise, isMultiStoreLanguagesShared, isMultiStoreMode, isMultiStoreShareCategories, isMultiStoreShareCustomers, isMultiStoreShareCustomersOrProducts, isMultiStoreShareProducts, isMultiStoreSingleDBCSMode, isMultiStoreSingleDBMode, isMultiStoreSingleDBNonCSMode, isUnix, isWindows, manageException, manageThrowable, removeCData, sendMQMessages, setAdminEng, setDebugStackTraceExclusions, setKkAdminPropsFilePath, setupWildCardRules, setWildCardAfter, setWildCardBefore, shutdownGracefully, shutdownGracefully, timestampStr, updateStaticVariablesNow

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

log

protected static org.apache.commons.logging.Log log

the log

mutex

protected static java.lang.String mutex

staticDataHM

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

Hash Map that contains the static data

Constructor Detail

AdminAuditMgr

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

Constructor

Parameters:

eng - the eng

Throws:

java.lang.Exception - an unexpected exception

Method Detail

updateAuditModes

public void updateAuditModes()
                      throws java.lang.Exception

Read the config variables and update the modes

Specified by:

updateAuditModes in interface AdminAuditMgrIf

Throws:

java.lang.Exception - an unexpected exception

insertAudit

public int insertAudit(AdminAudit audit)
                throws KKAdminException

Inserts an audit object if auditing is enabled for the action type of the audit object (i.e. Edit, Insert, Delete, Reads)

Specified by:

insertAudit in interface AdminAuditMgrIf

Parameters:

audit - the audit

Returns:

Returns the id of the new Audit Object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

importAudit

public int importAudit(AdminAudit audit)
                throws KKAdminException

Imports an audit object. Used for loading auditing records from another system. It by-passes the normal auditing and inserts auditing records unchanged.

Specified by:

importAudit in interface AdminAuditMgrIf

Parameters:

audit - the audit

Returns:

Returns the id of the new Audit Object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

truncateObjectToStringForDB

private java.lang.String truncateObjectToStringForDB(java.lang.String str)

validateAudit

protected void validateAudit(AdminAudit audit)
                      throws KKAdminException

Used to validate an AdminAudit object before editing or inserting

Parameters:

audit - and AdminAudit object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

getAuditData

public AdminAuditSearchResult getAuditData(AdminAuditSearch retSearch,
                                           int offset,
                                           int size)
                                    throws KKAdminException,
                                           org.apache.torque.TorqueException,
                                           com.workingdogs.village.DataSetException

Description copied from interface: AdminAuditMgrIf

Returns audit data specified by the AdminAuditSearch object

Specified by:

getAuditData in interface AdminAuditMgrIf

Parameters:

retSearch - the retSearch

offset - the offset

size - the size

Returns:

Returns an AdminAuditSearchResult object

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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)

getAuditCount

protected int getAuditCount(com.konakart.db.KKCriteria c)
                     throws org.apache.torque.TorqueException,
                            com.workingdogs.village.DataSetException

This method is mainly used for paging.

Parameters:

c - the c

Returns:

The number of records present in the database matching the given criteria

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)

deleteAuditData

public void deleteAuditData(AdminAuditSearch delSearch)
                     throws KKAdminException,
                            org.apache.torque.TorqueException

Delete a AdminAudit Objects based on search criteria

Specified by:

deleteAuditData in interface AdminAuditMgrIf

Parameters:

delSearch - the delSearch

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

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

isReadAudit

public boolean isReadAudit()
                    throws KKAdminException

Description copied from interface: AdminAuditMgrIf

Returns true if read audit is enabled

Specified by:

isReadAudit in interface AdminAuditMgrIf

Returns:

Returns true if read audit is enabled

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

isDetailedReadAudit

public boolean isDetailedReadAudit()
                            throws KKAdminException

Specified by:

isDetailedReadAudit in interface AdminAuditMgrIf

Returns:

Returns true if read audit is enabled

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

isEditAudit

public boolean isEditAudit()
                    throws KKAdminException

Description copied from interface: AdminAuditMgrIf

Returns true if edit audit is enabled

Specified by:

isEditAudit in interface AdminAuditMgrIf

Returns:

Returns true if edit audit is enabled

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

isDetailedEditAudit

public boolean isDetailedEditAudit()
                            throws KKAdminException

Description copied from interface: AdminAuditMgrIf

Returns true if detailed edit audit is enabled

Specified by:

isDetailedEditAudit in interface AdminAuditMgrIf

Returns:

Returns true if detailed edit audit is enabled

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

isInsertAudit

public boolean isInsertAudit()
                      throws KKAdminException

Description copied from interface: AdminAuditMgrIf

Returns true if insert audit is enabled

Specified by:

isInsertAudit in interface AdminAuditMgrIf

Returns:

Returns true if insert audit is enabled

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

isDetailedInsertAudit

public boolean isDetailedInsertAudit()
                              throws KKAdminException

Description copied from interface: AdminAuditMgrIf

eturns true if detailed insert audit is enabled

Specified by:

isDetailedInsertAudit in interface AdminAuditMgrIf

Returns:

Returns true if detailed insert audit is enabled

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

isDeleteAudit

public boolean isDeleteAudit()
                      throws KKAdminException

Description copied from interface: AdminAuditMgrIf

Returns true if delete audit is enabled

Specified by:

isDeleteAudit in interface AdminAuditMgrIf

Returns:

Returns true if delete audit is enabled

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

isDetailedDeleteAudit

public boolean isDetailedDeleteAudit()
                              throws KKAdminException

Description copied from interface: AdminAuditMgrIf

Returns true if detailed delete audit is enabled

Specified by:

isDetailedDeleteAudit in interface AdminAuditMgrIf

Returns:

Returns true if detailed delete audit is enabled

Throws:

KKAdminException - an unexpected exception in the KonaKart Admin engine

refreshConfigs

public void refreshConfigs()
                    throws java.lang.Exception

Refresh the configuration of the Admin Currency Manager

Specified by:

refreshConfigs in interface AdminAuditMgrIf

Overrides:

refreshConfigs in class AdminBaseMgr

Throws:

java.lang.Exception - an unexpected exception