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

public abstract class AbstractSystemSetup extends Object
Base class for system setup spring bean. Provides support for importing impex files and managing sync jobs.
  • Field Details

  • Constructor Details

    • AbstractSystemSetup

      public AbstractSystemSetup()
  • Method Details

    • getInitializationOptions

      public abstract List<SystemSetupParameter> getInitializationOptions()
      Abstract method to be implemented in subclasses.
      Returns:
      the list of SystemSetupParameters for the SystemSetup class.
    • logInfo

      public void logInfo(SystemSetupContext context, String message)
      Log an info message in to the jsp context
      Parameters:
      context - the system setup context
      message - the message to log
    • logError

      public void logError(SystemSetupContext context, String message, Throwable throwable)
      Log an error message in to the jsp context
      Parameters:
      context - the system setup context
      message - the message to log
      throwable - 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

      public boolean getBooleanSystemSetupParameter(SystemSetupContext context, String key)
      Helper method for checking setting of a Boolean setup parameter.
      Parameters:
      context -
      key -
      Returns:
      true if parameter is set to Yes
    • getDefaultValueForBooleanSystemSetupParameter

      public boolean getDefaultValueForBooleanSystemSetupParameter(String key)
      Helper method for getting default value of a Boolean setup parameter
      Parameters:
      key -
      Returns:
      the default value
    • getCatalogSyncJob

      public List<SyncItemJobModel> getCatalogSyncJob(String catalogId) throws UnknownIdentifierException
      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

      public PerformResult executeCatalogSyncJob(SystemSetupContext context, String catalogId)
    • importImpexFile

      public void importImpexFile(SystemSetupContext context, String file)
    • importImpexFile

      public void importImpexFile(SystemSetupContext context, String file, boolean errorIfMissing)
    • importImpexFile

      public void importImpexFile(SystemSetupContext context, String file, boolean errorIfMissing, boolean legacyMode)
    • createProductCatalogSyncJob

      public void createProductCatalogSyncJob(SystemSetupContext context, String catalogId)
    • createContentCatalogSyncJob

      public void createContentCatalogSyncJob(SystemSetupContext context, String catalogId)
    • createSolrIndexerCronJobs

      public void createSolrIndexerCronJobs(String solrFacetSearchConfigName)
    • executeSolrIndexerCronJob

      public void executeSolrIndexerCronJob(String solrFacetSearchConfigName, boolean fullReIndex)
    • activateSolrIndexerCronJobs

      public void activateSolrIndexerCronJobs(String solrFacetSearchConfigName)
    • isSyncRerunNeeded

      public boolean isSyncRerunNeeded(PerformResult syncCronJobResult)
    • getSetupImpexService

      public SetupImpexService getSetupImpexService()
    • setSetupImpexService

      public void setSetupImpexService(SetupImpexService setupImpexService)
    • getSetupSyncJobService

      public SetupSyncJobService getSetupSyncJobService()
    • setSetupSyncJobService

      public void setSetupSyncJobService(SetupSyncJobService setupSyncJobService)
    • getSetupSolrIndexerService

      public SetupSolrIndexerService getSetupSolrIndexerService()
    • setSetupSolrIndexerService

      public void setSetupSolrIndexerService(SetupSolrIndexerService setupSolrIndexerService)
    • getCatalogVersionService

      public CatalogVersionService getCatalogVersionService()
    • setCatalogVersionService

      public void setCatalogVersionService(CatalogVersionService catalogVersionService)
    • getEventService

      public EventService getEventService()
    • setEventService

      public void setEventService(EventService eventService)