public class CatalogMaintenanceService
extends atg.commerce.catalog.StandardCatalogMaintenance
This service extends the standard catalog maintenance to provide processing specific to custom catalogs.
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
mJobId
SERVICE_INFO_KEY
AGS_GENANCESTORS, AGS_GENANCESTORS_FOR_CATEGORY, AGS_GENANCESTORS_FOR_PRODUCT, AGS_GENCATALOGS, AGS_GENCATALOGS_FOR_CATEGORY, AGS_GENCATALOGS_FOR_PRODUCT, AGS_GENCATALOGS_FOR_SKU, AGS_GENPARENTCATS, AGS_GENPROPERTIES, AGS_GENPROPERTIES_FOR_CATEGORY, AGS_GENPROPERTIES_FOR_PRODUCT, ANCESTORS_GENERATED, CATALOGS_UPDATED, CATALOGS_VERIFIED, CATEGORIES_VERIFIED, CUS_INVALID_PARENT_BRANCH, CUS_NAME_ALREADY_IN_USE, CUS_UNABLE_TO_GET_WS, CUS_UPDATECATALOGS, CUS_USING_CHECKED_IN_WS, CUS_VM_NOT_SET, CUS_WS_NOT_CREATED, CUS_WS_NOT_CREATED_INVALID_PARENT_BRANCH, CUS_WS_REQUIRED, CVS_VERIFYCATALOGS, CVS_VERIFYCATEGORIES, CVS_VERIFYPRODUCTS, CVS_VERIFYSKUS, DEFAULT_CATALOG_FOLDER_ITEM_TYPE, DEFAULT_CATALOG_ITEM_TYPE, DEFAULT_MAP_SIZE, GENERATED_ANCESTORS_MAP, INFOS_GENERATED, IS_ANCESTORS_GENERATED_MAP, LEVEL_DEBUG, LEVEL_ERROR, LEVEL_INFO, LEVEL_WARNING, MY_RESOURCE_NAME, NO_PATH, NOT_GENERATOR, sResourceBundle, TYPE_ANCESTOR, TYPE_CATALOGMAINTENANCE, TYPE_CUSTOM_MIGRATION, TYPE_MIGRATION, TYPE_UPDATE, TYPE_VERIFY, VALID_PATH
DEFAULT_LOG_TRACE_STATUS
DEFAULT_LOG_DEBUG_STATUS, DEFAULT_LOG_ERROR_STATUS, DEFAULT_LOG_INFO_STATUS, DEFAULT_LOG_WARNING_STATUS
Constructor and Description |
---|
CatalogMaintenanceService() |
Modifier and Type | Method and Description |
---|---|
void |
doScheduledTask(Scheduler pScheduler,
ScheduledJob pScheudledJob)
Callback method for the SingletonSchedulableService.
|
AncestorGeneratorService |
getAncestorGeneratorService()
This service will generate the ancestorCategories for categories and products
|
java.lang.String[] |
getCatalogIdsToUpdate()
The list of catalogs ids that will be updated the next time this
service runs
|
CatalogProperties |
getCatalogProperties()
A helper class that holds commonly accessed reposority property
and item names
|
CustomCatalogTools |
getCatalogTools()
Returns property catalogTools
|
CatalogVerificationService |
getCatalogVerificationService()
This class will verify that catalog only refers to items within the catalog
|
boolean |
isPerformCategoryVerification()
Deprecated.
- category verification is always part of catalog verification
|
boolean |
isPerformInfoVerification()
If true, the CatalogVerificationService will execute by default.
|
void |
performMaintenance()
Perform the maintenance in this order (the last step only happens if
performInfoVerification is true.
|
void |
performMaintenance(boolean pGetLock)
Perform the maintenance in this order (the last step only happens if
performInfoVerification is true.
|
void |
performMaintenance(boolean pGetLock,
Repository pCatalogRepository,
java.util.Collection pCatalogIds,
boolean pRunAncestors,
boolean pRunInfoVerification)
Perform the maintenance on the given catalogs within the given repository.
|
void |
performMaintenance(java.util.Collection pCatalogIds)
Perform the maintenance on the given catalogs in this order (the
last step only happens if performInfoVerification is true.
|
void |
performMaintenance(java.util.Collection pCatalogIds,
boolean pRunAncestors,
boolean pRunInfoVerification)
Perform the maintenance on the given catalogs in the following order.
|
void |
performMaintenance(Repository pCatalogRepository,
java.util.Collection pCatalogIds)
Perform the maintenance on the given catalogs within the given repository.
|
void |
performMaintenance(Repository pCatalogRepository,
java.util.Collection pCatalogIds,
boolean pRunAncestors,
boolean pRunInfoVerification)
Perform the maintenance on the given catalogs within the given repository.
|
void |
postService(boolean pPerformServiceReturn,
Repository pRepository,
java.util.Collection pCatalogIds,
java.util.List pServiceFunctions)
Method called after maintenance completed.
|
boolean |
preService(Repository pRepository,
java.util.Collection pCatalogIds,
java.util.List pServiceFunctions)
Method called prior to start of maintenance.
|
void |
setCatalogIdsToUpdate(java.lang.String[] pCatalogIdsToUpdate) |
void |
setCatalogProperties(CatalogProperties pCatalogProperties) |
void |
setCatalogTools(CustomCatalogTools pCatalogTools)
Sets property catalogTools
|
void |
setPerformCategoryVerification(boolean pPerformCategoryVerification) |
void |
setPerformInfoVerification(boolean pPerformInfoVerification) |
void |
showMessages()
dumps out all current messages to the dynamo log
|
addCatalogMaintenanceListener, addServiceToMap, clearMessages, createServicesFunctions, getAllMessages, getAvailableFunctions, getAvailableServices, getCatalogMaintenanceListeners, getLastExecutionFinishTime, getLastExecutionStartTime, getLastRepository, getLastServicesPerformed, getService, getServiceName, getServices, getServicesMap, getServiceWithFunction, getStandardCatalogTools, getTotalNumberOfErrorMessages, getTotalNumberOfInfoMessages, getTotalNumberOfMessages, getTotalNumberOfWarningMessages, isFirstPhase, isFullDeployment, isSaveMessages, notifyListeners, performMaintenance, performService, removeCatalogMaintenanceListener, setAvailableFunctions, setAvailableServices, setCatalogMaintenanceListeners, setFirstPhase, setFullDeployment, setLastExecutionFinishTime, setLastExecutionStartTime, setLastRepository, setLastServicesPerformed, setSaveMessages, setStandardCatalogTools, stringIt, stringIt
addErrorMessage, addInfoMessage, addWarningMessage, clearBookkeepingForThread, createCMSMessage, doService, getBookkeepingForThread, getCurrentMessages, getErrorMessages, getFunctionsToPerformByDefault, getInfoMessages, getServiceLock, getTransactionManager, getWarningMessages, hasFunction, logDebug, logError, logInfo, logWarning, performService, removeServiceLock, setFunctionsToPerformByDefault, setTransactionManager
acquireLock, getClientLockManager, getLockName, getLockTimeOut, performScheduledTask, releaseLock, setClientLockManager, setLockName, setLockTimeOut
doStartService, doStopService, getJobDescription, getJobId, getJobName, getSchedule, getScheduler, getThreadMethod, getThreadMethodString, isTransactional, setJobDescription, setJobName, setSchedule, setScheduler, setThreadMethod, setThreadMethodString, setTransactional, startScheduledJob, stopScheduledJob
addLogListener, createAdminServlet, getAbsoluteName, getAdminServlet, getAdminServletOutputStreamEncoding, getLoggingForVlogging, getLogListenerCount, getLogListeners, getName, getNameContext, getNucleus, getRoot, getServiceConfiguration, getServiceInfo, isAdminServletUseServletOutputStream, isLoggingDebug, isLoggingError, isLoggingInfo, isLoggingTrace, isLoggingWarning, isRunning, logDebug, logDebug, logError, logError, logInfo, logInfo, logTrace, logTrace, logTrace, logWarning, logWarning, nameContextElementBound, nameContextElementUnbound, removeLogListener, reResolveThis, resolveName, resolveName, resolveName, resolveName, sendLogEvent, setAdminServletOutputStreamEncoding, setAdminServletUseServletOutputStream, setLoggingDebug, setLoggingError, setLoggingInfo, setLoggingTrace, setLoggingWarning, setNucleus, setServiceInfo, startService, stopService
vlogDebug, vlogDebug, vlogDebug, vlogDebug, vlogDebugTrace, vlogError, vlogError, vlogError, vlogError, vlogInfo, vlogInfo, vlogInfo, vlogInfo, vlogTrace, vlogTrace, vlogTrace, vlogTrace, vlogWarning, vlogWarning, vlogWarning, vlogWarning
public AncestorGeneratorService getAncestorGeneratorService()
public CatalogVerificationService getCatalogVerificationService()
public void setCatalogIdsToUpdate(java.lang.String[] pCatalogIdsToUpdate)
public java.lang.String[] getCatalogIdsToUpdate()
public void setCatalogProperties(CatalogProperties pCatalogProperties)
public CatalogProperties getCatalogProperties()
public void setCatalogTools(CustomCatalogTools pCatalogTools)
public CustomCatalogTools getCatalogTools()
public void setPerformCategoryVerification(boolean pPerformCategoryVerification)
public boolean isPerformCategoryVerification()
public void setPerformInfoVerification(boolean pPerformInfoVerification)
public boolean isPerformInfoVerification()
public void doScheduledTask(Scheduler pScheduler, ScheduledJob pScheudledJob)
doScheduledTask
in class atg.commerce.catalog.CMSService
public void performMaintenance()
performMaintenance
in class atg.commerce.catalog.StandardCatalogMaintenance
isPerformInfoVerification()
,
TreeWalkUpdateService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
,
CatalogVerificationService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
public void performMaintenance(boolean pGetLock)
SingletonScheduledService
if pGetLock is true.
Catalogs processed is limited to the preconfigured value specified by getCatalogIdsToUpdate() If no preconfigured catalogs, then all catalogs are processed.
performMaintenance
in class atg.commerce.catalog.StandardCatalogMaintenance
pGetLock
- If true, then the lock used by the SingletonScheduledService
must be acquired before the maintenance is run.
If false, no lock is acquired.isPerformInfoVerification()
,
TreeWalkUpdateService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
,
CatalogVerificationService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
public void performMaintenance(java.util.Collection pCatalogIds)
pCatalogIds
- The list of catalogs to update. If this is null, all catalogs are
updated.isPerformInfoVerification()
,
TreeWalkUpdateService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
,
CatalogVerificationService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
public void performMaintenance(java.util.Collection pCatalogIds, boolean pRunAncestors, boolean pRunInfoVerification)
pCatalogIds
- The list of catalogs to update. If this is null, all catalogs are
updated.pRunAncestors
- If true, then the AncestorGeneratorService is run. If false, it is notpRunInfoVerification
- If true, then the CatalogVerificationService is run.TreeWalkUpdateService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
,
CatalogVerificationService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
public void performMaintenance(Repository pCatalogRepository, java.util.Collection pCatalogIds)
pCatalogRepository
- The catalog repository to updatepCatalogIds
- The list of catalogs to update. If this is null, all catalogs
in the given repository are updated.isPerformInfoVerification()
,
TreeWalkUpdateService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
,
CatalogVerificationService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
public void performMaintenance(Repository pCatalogRepository, java.util.Collection pCatalogIds, boolean pRunAncestors, boolean pRunInfoVerification)
pCatalogRepository
- The catalog repository to updatepCatalogIds
- The list of catalogs to update. If this is null, all catalogs
in the given repository are updated.pRunAncestors
- If true, then the AncestorGeneratorService is run. If false, it is notpRunInfoVerification
- boolean to control the execution of CatalogVerificationService. If true, the
verification service is executed.TreeWalkUpdateService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
,
CatalogVerificationService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
public void performMaintenance(boolean pGetLock, Repository pCatalogRepository, java.util.Collection pCatalogIds, boolean pRunAncestors, boolean pRunInfoVerification)
pGetLock
- If true the service locked must be obtained before executionpCatalogRepository
- The catalog repository to updatepCatalogIds
- The list of catalogs to update. If this is null, all catalogs
in the given repository are updated.pRunAncestors
- If true, then the AncestorGeneratorService is run. If false, it is notpRunInfoVerification
- boolean to control the execution of CatalogVerificationService. If true, the
verification service is executed.TreeWalkUpdateService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
,
CatalogVerificationService.performService(atg.repository.Repository, java.util.Collection, java.util.List)
public boolean preService(Repository pRepository, java.util.Collection pCatalogIds, java.util.List pServiceFunctions)
preService
in class atg.commerce.catalog.StandardCatalogMaintenance
pRepository
- the catalogs repositorypCatalogIds
- the catalog item ids. note this is only relevent for
custom catalog servicespublic void postService(boolean pPerformServiceReturn, Repository pRepository, java.util.Collection pCatalogIds, java.util.List pServiceFunctions)
postService
in class atg.commerce.catalog.StandardCatalogMaintenance
pRepository
- the catalogs repositorypCatalogIds
- the catalog item ids. note this is only relevent for
custom catalog servicespublic void showMessages()
showMessages
in class atg.commerce.catalog.StandardCatalogMaintenance