com.hybris.backoffice.config.impl

Class BackofficeWidgetPersistenceService

java.lang.Object

XmlModuleAwarePersistenceService

com.hybris.backoffice.config.impl.BackofficeWidgetPersistenceService

Direct Known Subclasses:

TestingBackofficeWidgetPersistenceService

public class BackofficeWidgetPersistenceService
extends XmlModuleAwarePersistenceService

Backoffice extension of the XmlModuleAwarePersistenceService. The implementation uses MediaModel to persist the xml content.

Field Summary

Fields

Modifier and Type	Field and 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

Constructor Summary

Constructors

Constructor and Description
BackofficeWidgetPersistenceService()

Method Summary

Modifier and Type	Method and Description
void	deleteWidgetTree(Widget widget)
protected void	deleteWidgetTreeInternal(Widget widget)
protected java.util.List<WidgetExtension>	extractWidgetExtensions(Widgets root)
protected BackofficeConfigurationMediaHelper	getBackofficeConfigurationMediaHelper()
protected java.io.InputStream	getDefaultWidgetsConfigInputStream()
MediaService	getMediaService()
protected MediaModel	getOrCreateWidgetsConfigMedia()
protected boolean	isLocalWidgetsFileExisting()
protected boolean	isWidgetsConfigStoredInMedia()
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(Widgets root)
void	storeWidgetTree(Widget widget)
protected void	storeWidgetTreeInternal(Widget widget)

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 Widget loadWidgetTree(java.lang.String widgetId)

storeWidgetTree

public void storeWidgetTree(Widget widget)

storeWidgetTreeInternal

protected void storeWidgetTreeInternal(Widget widget)

deleteWidgetTree

public void deleteWidgetTree(Widget widget)

deleteWidgetTreeInternal

protected void deleteWidgetTreeInternal(Widget widget)

resetToDefaults

public void resetToDefaults()

isLocalWidgetsFileExisting

protected boolean isLocalWidgetsFileExisting()

isWidgetsConfigStoredInMedia

protected boolean isWidgetsConfigStoredInMedia()

getOrCreateWidgetsConfigMedia

protected MediaModel getOrCreateWidgetsConfigMedia()

putDefaultWidgetsConfig

protected void putDefaultWidgetsConfig(MediaModel mediaModel)

extractWidgetExtensions

protected java.util.List<WidgetExtension> extractWidgetExtensions(Widgets root)

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(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()

getMediaService

public MediaService getMediaService()

setMediaService

public void setMediaService(MediaService mediaService)

getBackofficeConfigurationMediaHelper

protected BackofficeConfigurationMediaHelper getBackofficeConfigurationMediaHelper()

setBackofficeConfigurationMediaHelper

public void setBackofficeConfigurationMediaHelper(DefaultBackofficeConfigurationMediaHelper backofficeConfigurationMediaHelper)