Class AbstractSystemSetup
java.lang.Object
de.hybris.platform.commerceservices.setup.AbstractSystemSetup
- Direct Known Subclasses:
AbstractSystemSetupTest.TestSystemSetup,AcceleratorCmsSystemSetup,ApparelStoreSystemSetup,CockpitSystemSetup,CommercewebservicesTestSetup,CoreSystemSetup,DefaultAddonSampleDataImportService,DefaultAddOnSystemSetupSupport,ElectronicsStoreSystemSetup,InitialDataSystemSetup,MarketplaceaddonAddonDataSetup,MarketplaceOccAddonDataSetup,MarketplaceservicesSystemSetup,MarketplacestoreSystemSetup,MessageCenterCSOccAddonDataSetup,OrderManagementAddonSetup,PowertoolsStoreSystemSetup,ProductConfigOCCTestsSetup,ProductConfigRulesSetup,SmarteditAddonSystemSetup,TestDataSystemSetup,YCommerceWebServicesTestSetup,YFormsBackofficeSystemSetup,YFormsServicesSystemSetup
Base class for system setup spring bean. Provides support for importing impex files and managing sync jobs.
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoidactivateSolrIndexerCronJobs(String solrFacetSearchConfigName) createBooleanSystemSetupParameter(String key, String label, boolean defaultValue) Helper method for creating a Boolean setup parameter.voidcreateContentCatalogSyncJob(SystemSetupContext context, String catalogId) voidcreateProductCatalogSyncJob(SystemSetupContext context, String catalogId) voidcreateSolrIndexerCronJobs(String solrFacetSearchConfigName) executeCatalogSyncJob(SystemSetupContext context, String catalogId) voidexecuteSolrIndexerCronJob(String solrFacetSearchConfigName, boolean fullReIndex) booleangetBooleanSystemSetupParameter(SystemSetupContext context, String key) Helper method for checking setting of a Boolean setup parameter.getCatalogSyncJob(String catalogId) Searches for synchronization jobs of given catalog idbooleanHelper method for getting default value of a Boolean setup parameterabstract List<SystemSetupParameter>Abstract method to be implemented in subclasses.voidimportImpexFile(SystemSetupContext context, String file) voidimportImpexFile(SystemSetupContext context, String file, boolean errorIfMissing) voidimportImpexFile(SystemSetupContext context, String file, boolean errorIfMissing, boolean legacyMode) booleanisSyncRerunNeeded(PerformResult syncCronJobResult) voidlogError(SystemSetupContext context, String message, Throwable throwable) Log an error message in to the jsp contextvoidlogInfo(SystemSetupContext context, String message) Log an info message in to the jsp contextvoidsetCatalogVersionService(CatalogVersionService catalogVersionService) voidsetEventService(EventService eventService) voidsetSetupImpexService(SetupImpexService setupImpexService) voidsetSetupSolrIndexerService(SetupSolrIndexerService setupSolrIndexerService) voidsetSetupSyncJobService(SetupSyncJobService setupSyncJobService)
-
Field Details
-
BOOLEAN_TRUE
- See Also:
-
BOOLEAN_FALSE
- See Also:
-
-
Constructor Details
-
AbstractSystemSetup
public AbstractSystemSetup()
-
-
Method Details
-
getInitializationOptions
Abstract method to be implemented in subclasses.- Returns:
- the list of SystemSetupParameters for the SystemSetup class.
-
logInfo
Log an info message in to the jsp context- Parameters:
context- the system setup contextmessage- the message to log
-
logError
Log an error message in to the jsp context- Parameters:
context- the system setup contextmessage- the message to logthrowable- thrown exception, may be null
-
createBooleanSystemSetupParameter
public SystemSetupParameter createBooleanSystemSetupParameter(String key, String label, boolean defaultValue) Helper method for creating a Boolean setup parameter.- Parameters:
key-label-defaultValue-
-
getBooleanSystemSetupParameter
Helper method for checking setting of a Boolean setup parameter.- Parameters:
context-key-- Returns:
- true if parameter is set to Yes
-
getDefaultValueForBooleanSystemSetupParameter
Helper method for getting default value of a Boolean setup parameter- Parameters:
key-- Returns:
- the default value
-
getCatalogSyncJob
Searches for synchronization jobs of given catalog id- Parameters:
catalogId- to search synchronization jobs for.- Returns:
- list of synchronizations
- Throws:
UnknownIdentifierException- if no catalog with given id is found
-
executeCatalogSyncJob
-
importImpexFile
-
importImpexFile
-
importImpexFile
public void importImpexFile(SystemSetupContext context, String file, boolean errorIfMissing, boolean legacyMode) -
createProductCatalogSyncJob
-
createContentCatalogSyncJob
-
createSolrIndexerCronJobs
-
executeSolrIndexerCronJob
-
activateSolrIndexerCronJobs
-
isSyncRerunNeeded
-
getSetupImpexService
-
setSetupImpexService
-
getSetupSyncJobService
-
setSetupSyncJobService
-
getSetupSolrIndexerService
-
setSetupSolrIndexerService
-
getCatalogVersionService
-
setCatalogVersionService
-
getEventService
-
setEventService
-