Class BackofficeWidgetPersistenceService
java.lang.Object
com.hybris.cockpitng.core.persistence.impl.XMLWidgetPersistenceService
com.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService
com.hybris.backoffice.config.impl.BackofficeWidgetPersistenceService
- All Implemented Interfaces:
com.hybris.cockpitng.core.persistence.WidgetPersistenceService,org.springframework.beans.factory.Aware,org.springframework.context.ApplicationContextAware
- Direct Known Subclasses:
TestingBackofficeWidgetPersistenceService
public class BackofficeWidgetPersistenceService
extends com.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService
Backoffice extension of the
XmlModuleAwarePersistenceService. The implementation uses MediaModel to
persist the xml content.-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected static final StringBackoffice URL as root module does not have an url - it's items have null url.static final Stringprotected static final Stringprotected static final StringFields inherited from class com.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService
COCKPITNG_WIDGETS_STORING_ENABLEDFields inherited from class com.hybris.cockpitng.core.persistence.impl.XMLWidgetPersistenceService
DEFAULT_FILE_NAME_WIDGETS_XML, IMPORT_ROOT_FILE -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionvoiddeleteWidgetTree(com.hybris.cockpitng.core.Widget widget) protected voiddeleteWidgetTreeInternal(com.hybris.cockpitng.core.Widget widget) protected List<com.hybris.cockpitng.core.persistence.impl.jaxb.WidgetExtension>extractWidgetExtensions(com.hybris.cockpitng.core.persistence.impl.jaxb.Widgets root) protected BackofficeConfigurationMediaHelperprotected InputStreamprotected MediaModelprotected booleanprotected booleancom.hybris.cockpitng.core.WidgetloadWidgetTree(String widgetId) protected voidputDefaultWidgetsConfig(MediaModel mediaModel) voidvoidsetBackofficeConfigurationMediaHelper(DefaultBackofficeConfigurationMediaHelper backofficeConfigurationMediaHelper) voidsetMediaService(MediaService mediaService) protected <T> List<T>sortByCockpitModulesLoadOrder(List<T> items, Function<T, String> moduleUrlExtractor) Sorts given items by loading order of cockpit modules - using moduleUrlExtractor to item's module url.protected voidsortWidgetConnections(com.hybris.cockpitng.core.persistence.impl.jaxb.Widgets root) voidstoreWidgetTree(com.hybris.cockpitng.core.Widget widget) protected voidstoreWidgetTreeInternal(com.hybris.cockpitng.core.Widget widget) Methods inherited from class com.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService
addAdditionalWidgets, applyExtensions, deleteWidgetTree, getApplicationContext, getCockpitModuleConnector, getCockpitProperties, getWidgetConnectionsRemover, getWidgetsFileAsStream, isStoringEnabled, loadWidgets, loadWidgetsForModule, setApplicationContext, setCockpitModuleConnector, setCockpitProperties, setStoringEnabled, setWidgetConnectionsRemover, storeWidgets, updateWidgetConnectionsMethods inherited from class com.hybris.cockpitng.core.persistence.impl.XMLWidgetPersistenceService
applyExtension, applyExtensionAdd, applyExtensionMove, applyExtensionRemove, applyExtensionVirtualSockets, applyImport, applyImports, applyImports, applyImports, checkRequirements, deleteConnections, deleteOrphanedConnections, deleteWidgetTreeRecursive, extractWidgetConnections, getAccessRestrictions, getDefaultWidgetConfig, getImportRootFile, getImportSupport, getTemplateEngine, getUndefinedParameters, getWidgetAccessResolver, getWidgetById, getWidgetDefinitionService, getWidgetLibUtils, getWidgetsFile, getWidgetsInSlot, getWidgetTreeAsString, hasDefaultConfig, isChildWidget, isStubWidget, loadImports, loadImports, loadWidgetsInternal, loadWidgetTree, mergeWidgets, mergeWidgets, releaseReadLock, releaseWriteLock, removeWidgets, requestReadLock, requestWriteLock, resolveResource, resolveResourcePath, setContextId, setDefaultWidgetConfig, setDefaultWidgetConfigSpring, setImportSupport, setMarshaller, setStoreAsExtension, setTemplateEngine, setUnmarshaller, setWidgetAccessResolver, setWidgetDefinitionService, setWidgetLibUtils, setWidgetService, storeWidgetTree, storeWidgetTree, validateMove
-
Field Details
-
ERROR_PROCESSING_WIDGETS_CONFIG
- See Also:
-
WIDGET_CONFIG_MEDIA
- See Also:
-
TEXT_XML_MIME_TYPE
- See Also:
-
BACKOFFICE_URL
Backoffice URL as root module does not have an url - it's items have null url.
-
-
Constructor Details
-
BackofficeWidgetPersistenceService
public BackofficeWidgetPersistenceService()
-
-
Method Details
-
loadWidgetTree
- Specified by:
loadWidgetTreein interfacecom.hybris.cockpitng.core.persistence.WidgetPersistenceService- Overrides:
loadWidgetTreein classcom.hybris.cockpitng.core.persistence.impl.XMLWidgetPersistenceService
-
storeWidgetTree
public void storeWidgetTree(com.hybris.cockpitng.core.Widget widget) - Specified by:
storeWidgetTreein interfacecom.hybris.cockpitng.core.persistence.WidgetPersistenceService- Overrides:
storeWidgetTreein classcom.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService
-
storeWidgetTreeInternal
protected void storeWidgetTreeInternal(com.hybris.cockpitng.core.Widget widget) -
deleteWidgetTree
public void deleteWidgetTree(com.hybris.cockpitng.core.Widget widget) - Specified by:
deleteWidgetTreein interfacecom.hybris.cockpitng.core.persistence.WidgetPersistenceService- Overrides:
deleteWidgetTreein classcom.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService
-
deleteWidgetTreeInternal
protected void deleteWidgetTreeInternal(com.hybris.cockpitng.core.Widget widget) -
resetToDefaults
public void resetToDefaults()- Specified by:
resetToDefaultsin interfacecom.hybris.cockpitng.core.persistence.WidgetPersistenceService- Overrides:
resetToDefaultsin classcom.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService
-
isLocalWidgetsFileExisting
protected boolean isLocalWidgetsFileExisting()- Overrides:
isLocalWidgetsFileExistingin classcom.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService
-
isWidgetsConfigStoredInMedia
protected boolean isWidgetsConfigStoredInMedia() -
getOrCreateWidgetsConfigMedia
-
putDefaultWidgetsConfig
-
extractWidgetExtensions
protected List<com.hybris.cockpitng.core.persistence.impl.jaxb.WidgetExtension> extractWidgetExtensions(com.hybris.cockpitng.core.persistence.impl.jaxb.Widgets root) - Overrides:
extractWidgetExtensionsin classcom.hybris.cockpitng.core.persistence.impl.XMLWidgetPersistenceService- Parameters:
root-Widgetscomponent holding all the items to be applied- Returns:
- list of
WidgetExtensionobjects sorted in order of dependencies defined in extensioninfo.xml
-
sortWidgetConnections
protected void sortWidgetConnections(com.hybris.cockpitng.core.persistence.impl.jaxb.Widgets root) - Parameters:
root-Widgetscomponent holding all the connections
-
sortByCockpitModulesLoadOrder
protected <T> List<T> sortByCockpitModulesLoadOrder(List<T> items, Function<T, String> moduleUrlExtractor) Sorts given items by loading order of cockpit modules - using moduleUrlExtractor to item's module url.- Type Parameters:
T- type of items.- Parameters:
items- items to be sortedmoduleUrlExtractor- extracts url of module from which item comes. If item is from backoffice (the root) it will be null.- Returns:
- sorted list of items by load modules load order.
-
getDefaultWidgetsConfigInputStream
-
getMediaService
-
setMediaService
-
getBackofficeConfigurationMediaHelper
-
setBackofficeConfigurationMediaHelper
public void setBackofficeConfigurationMediaHelper(DefaultBackofficeConfigurationMediaHelper backofficeConfigurationMediaHelper)
-