Package com.hybris.backoffice.config.impl

Class 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

      Fields 
      Modifier and Type Field Description
      protected static java.lang.String BACKOFFICE_URL
      Backoffice URL as root module does not have an url - it's items have null url.
      static java.lang.String ERROR_PROCESSING_WIDGETS_CONFIG  
      protected static java.lang.String TEXT_XML_MIME_TYPE  
      protected static java.lang.String WIDGET_CONFIG_MEDIA  

      • Fields inherited from class com.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService

        COCKPITNG_WIDGETS_STORING_ENABLED

      • Fields inherited from class com.hybris.cockpitng.core.persistence.impl.XMLWidgetPersistenceService

        DEFAULT_FILE_NAME_WIDGETS_XML, IMPORT_ROOT_FILE

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void deleteWidgetTree​(com.hybris.cockpitng.core.Widget widget)  
      protected void deleteWidgetTreeInternal​(com.hybris.cockpitng.core.Widget widget)  
      protected java.util.List<com.hybris.cockpitng.core.persistence.impl.jaxb.WidgetExtension> extractWidgetExtensions​(com.hybris.cockpitng.core.persistence.impl.jaxb.Widgets root)  
      protected BackofficeConfigurationMediaHelper getBackofficeConfigurationMediaHelper()  
      protected java.io.InputStream getDefaultWidgetsConfigInputStream()  
      MediaService getMediaService()  
      protected MediaModel getOrCreateWidgetsConfigMedia()  
      protected boolean isLocalWidgetsFileExisting()  
      protected boolean isWidgetsConfigStoredInMedia()  
      com.hybris.cockpitng.core.Widget loadWidgetTree​(java.lang.String widgetId)  
      protected void putDefaultWidgetsConfig​(MediaModel mediaModel)  
      void resetToDefaults()  
      void setBackofficeConfigurationMediaHelper​(DefaultBackofficeConfigurationMediaHelper backofficeConfigurationMediaHelper)  
      void setMediaService​(MediaService mediaService)  
      protected <T> java.util.List<T> sortByCockpitModulesLoadOrder​(java.util.List<T> items, java.util.function.Function<T,​java.lang.String> moduleUrlExtractor)
      Sorts given items by loading order of cockpit modules - using moduleUrlExtractor to item's module url.
      protected void sortWidgetConnections​(com.hybris.cockpitng.core.persistence.impl.jaxb.Widgets root)  
      void storeWidgetTree​(com.hybris.cockpitng.core.Widget widget)  
      protected void storeWidgetTreeInternal​(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, updateWidgetConnections

      • Methods 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, 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, setMarshaller, setStoreAsExtension, setTemplateEngine, setUnmarshaller, setWidgetAccessResolver, setWidgetDefinitionService, setWidgetLibUtils, setWidgetService, storeWidgetTree, storeWidgetTree, validateMove

      • Methods inherited from class java.lang.Object

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

    • Field Detail

      • ERROR_PROCESSING_WIDGETS_CONFIG

        public static final java.lang.String ERROR_PROCESSING_WIDGETS_CONFIG
        See Also:
        Constant Field Values

      • WIDGET_CONFIG_MEDIA

        protected static final java.lang.String WIDGET_CONFIG_MEDIA
        See Also:
        Constant Field Values

      • TEXT_XML_MIME_TYPE

        protected static final java.lang.String TEXT_XML_MIME_TYPE
        See Also:
        Constant Field Values

      • BACKOFFICE_URL

        protected static final java.lang.String BACKOFFICE_URL
        Backoffice URL as root module does not have an url - it's items have null url.

    • Constructor Detail

      • BackofficeWidgetPersistenceService

        public BackofficeWidgetPersistenceService()

    • Method Detail

      • loadWidgetTree

        public com.hybris.cockpitng.core.Widget loadWidgetTree​(java.lang.String widgetId)
        Specified by:
        loadWidgetTree in interface com.hybris.cockpitng.core.persistence.WidgetPersistenceService
        Overrides:
        loadWidgetTree in class com.hybris.cockpitng.core.persistence.impl.XMLWidgetPersistenceService

      • storeWidgetTree

        public void storeWidgetTree​(com.hybris.cockpitng.core.Widget widget)
        Specified by:
        storeWidgetTree in interface com.hybris.cockpitng.core.persistence.WidgetPersistenceService
        Overrides:
        storeWidgetTree in class com.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:
        deleteWidgetTree in interface com.hybris.cockpitng.core.persistence.WidgetPersistenceService
        Overrides:
        deleteWidgetTree in class com.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService

      • deleteWidgetTreeInternal

        protected void deleteWidgetTreeInternal​(com.hybris.cockpitng.core.Widget widget)

      • resetToDefaults

        public void resetToDefaults()
        Specified by:
        resetToDefaults in interface com.hybris.cockpitng.core.persistence.WidgetPersistenceService
        Overrides:
        resetToDefaults in class com.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService

      • isLocalWidgetsFileExisting

        protected boolean isLocalWidgetsFileExisting()
        Overrides:
        isLocalWidgetsFileExisting in class com.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService

      • isWidgetsConfigStoredInMedia

        protected boolean isWidgetsConfigStoredInMedia()

      • getOrCreateWidgetsConfigMedia

        protected MediaModel getOrCreateWidgetsConfigMedia()

      • putDefaultWidgetsConfig

        protected void putDefaultWidgetsConfig​(MediaModel mediaModel)

      • extractWidgetExtensions

        protected java.util.List<com.hybris.cockpitng.core.persistence.impl.jaxb.WidgetExtension> extractWidgetExtensions​(com.hybris.cockpitng.core.persistence.impl.jaxb.Widgets root)
        Overrides:
        extractWidgetExtensions in class com.hybris.cockpitng.core.persistence.impl.XMLWidgetPersistenceService
        Parameters:
        root - Widgets component holding all the items to be applied
        Returns:
        list of WidgetExtension objects sorted in order of dependencies defined in extensioninfo.xml

      • sortWidgetConnections

        protected void sortWidgetConnections​(com.hybris.cockpitng.core.persistence.impl.jaxb.Widgets root)
        Parameters:
        root - Widgets component holding all the connections

      • sortByCockpitModulesLoadOrder

        protected <T> java.util.List<T> sortByCockpitModulesLoadOrder​(java.util.List<T> items,
                                                              java.util.function.Function<T,​java.lang.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 sorted
        moduleUrlExtractor - 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

        protected java.io.InputStream getDefaultWidgetsConfigInputStream()

      • setMediaService

        public void setMediaService​(MediaService mediaService)