de.hybris.platform.commerceservices.setup

Class AbstractSystemSetup

java.lang.Object

de.hybris.platform.commerceservices.setup.AbstractSystemSetup

Direct Known Subclasses:

AbstractSystemSetupTest.TestSystemSetup, AcceleratorCmsSystemSetup, ApparelStoreSystemSetup, CockpitSystemSetup, CoreSystemSetup, DataSetup, DefaultAddonSampleDataImportService, DefaultAddOnSystemSetupSupport, ElectronicsStoreSystemSetup, InitialDataSystemSetup, MarketplaceaddonAddonDataSetup, MarketplaceOccAddonDataSetup, MarketplaceservicesSystemSetup, MarketplacestoreSystemSetup, MessageCenterCSOccAddonDataSetup, OndemandSampleDataSystemSetup, OrderManagementAddonSetup, PowertoolsStoreSystemSetup, ProductConfigRulesSetup, SappostransactionaddonSystemSetup, SmarteditAddonSystemSetup, TestDataSystemSetup, YCommerceWebServicesTestSetup, YFormsBackofficeSystemSetup, YFormsServicesSystemSetup

public abstract class AbstractSystemSetup
extends java.lang.Object

Base class for system setup spring bean. Provides support for importing impex files and managing sync jobs.

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	BOOLEAN_FALSE
protected static java.lang.String	BOOLEAN_TRUE

Constructor Summary

Constructors

Constructor and Description
AbstractSystemSetup()

Method Summary

Modifier and Type	Method and Description
void	activateSolrIndexerCronJobs(java.lang.String solrFacetSearchConfigName)
SystemSetupParameter	createBooleanSystemSetupParameter(java.lang.String key, java.lang.String label, boolean defaultValue) Helper method for creating a Boolean setup parameter.
void	createContentCatalogSyncJob(SystemSetupContext context, java.lang.String catalogId)
void	createProductCatalogSyncJob(SystemSetupContext context, java.lang.String catalogId)
void	createSolrIndexerCronJobs(java.lang.String solrFacetSearchConfigName)
PerformResult	executeCatalogSyncJob(SystemSetupContext context, java.lang.String catalogId)
void	executeSolrIndexerCronJob(java.lang.String solrFacetSearchConfigName, boolean fullReIndex)
boolean	getBooleanSystemSetupParameter(SystemSetupContext context, java.lang.String key) Helper method for checking setting of a Boolean setup parameter.
java.util.List<SyncItemJobModel>	getCatalogSyncJob(java.lang.String catalogId) Searches for synchronization jobs of given catalog id
CatalogVersionService	getCatalogVersionService()
boolean	getDefaultValueForBooleanSystemSetupParameter(java.lang.String key) Helper method for getting default value of a Boolean setup parameter
EventService	getEventService()
abstract java.util.List<SystemSetupParameter>	getInitializationOptions() Abstract method to be implemented in subclasses.
SetupImpexService	getSetupImpexService()
SetupSolrIndexerService	getSetupSolrIndexerService()
SetupSyncJobService	getSetupSyncJobService()
void	importImpexFile(SystemSetupContext context, java.lang.String file)
void	importImpexFile(SystemSetupContext context, java.lang.String file, boolean errorIfMissing)
void	importImpexFile(SystemSetupContext context, java.lang.String file, boolean errorIfMissing, boolean legacyMode)
boolean	isSyncRerunNeeded(PerformResult syncCronJobResult)
void	logError(SystemSetupContext context, java.lang.String message, java.lang.Throwable throwable) Log an error message in to the jsp context
void	logInfo(SystemSetupContext context, java.lang.String message) Log an info message in to the jsp context
void	setCatalogVersionService(CatalogVersionService catalogVersionService)
void	setEventService(EventService eventService)
void	setSetupImpexService(SetupImpexService setupImpexService)
void	setSetupSolrIndexerService(SetupSolrIndexerService setupSolrIndexerService)
void	setSetupSyncJobService(SetupSyncJobService setupSyncJobService)

Methods inherited from class java.lang.Object

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

Field Detail

BOOLEAN_TRUE

protected static final java.lang.String BOOLEAN_TRUE

See Also:

Constant Field Values

BOOLEAN_FALSE

protected static final java.lang.String BOOLEAN_FALSE

See Also:

Constant Field Values

Constructor Detail

AbstractSystemSetup

public AbstractSystemSetup()

Method Detail

getInitializationOptions

public abstract java.util.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,
                    java.lang.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,
                     java.lang.String message,
                     java.lang.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(java.lang.String key,
                                                              java.lang.String label,
                                                              boolean defaultValue)

Helper method for creating a Boolean setup parameter.

Parameters:

key -

label -

defaultValue -

getBooleanSystemSetupParameter

public boolean getBooleanSystemSetupParameter(SystemSetupContext context,
                                              java.lang.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(java.lang.String key)

Helper method for getting default value of a Boolean setup parameter

Parameters:

key -

Returns:

the default value

getCatalogSyncJob

public java.util.List<SyncItemJobModel> getCatalogSyncJob(java.lang.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,
                                           java.lang.String catalogId)

importImpexFile

public void importImpexFile(SystemSetupContext context,
                            java.lang.String file)

importImpexFile

public void importImpexFile(SystemSetupContext context,
                            java.lang.String file,
                            boolean errorIfMissing)

importImpexFile

public void importImpexFile(SystemSetupContext context,
                            java.lang.String file,
                            boolean errorIfMissing,
                            boolean legacyMode)

createProductCatalogSyncJob

public void createProductCatalogSyncJob(SystemSetupContext context,
                                        java.lang.String catalogId)

createContentCatalogSyncJob

public void createContentCatalogSyncJob(SystemSetupContext context,
                                        java.lang.String catalogId)

createSolrIndexerCronJobs

public void createSolrIndexerCronJobs(java.lang.String solrFacetSearchConfigName)

executeSolrIndexerCronJob

public void executeSolrIndexerCronJob(java.lang.String solrFacetSearchConfigName,
                                      boolean fullReIndex)

activateSolrIndexerCronJobs

public void activateSolrIndexerCronJobs(java.lang.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)