Package com.hybris.cockpitng.modules.persistence.impl

Class XmlModuleAwarePersistenceService

java.lang.Object

com.hybris.cockpitng.core.persistence.impl.XMLWidgetPersistenceService

com.hybris.cockpitng.modules.persistence.impl.XmlModuleAwarePersistenceService

All Implemented Interfaces:

WidgetPersistenceService, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

public class XmlModuleAwarePersistenceService
extends XMLWidgetPersistenceService
implements org.springframework.context.ApplicationContextAware

Extends XMLWidgetPersistenceService by the feature of adding additional widget.xml snippets to the widget tree.

Field Summary

Fields

Modifier and Type	Field	Description
static java.lang.String	COCKPITNG_WIDGETS_STORING_ENABLED

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

DEFAULT_FILE_NAME_WIDGETS_XML, IMPORT_ROOT_FILE

Constructor Summary

Constructors

Constructor	Description
XmlModuleAwarePersistenceService()

Method Summary

Modifier and Type	Method	Description
protected void	addAdditionalWidgets(Widgets baseWidgets, Widgets additionalWidgets)
protected void	applyExtensions(Widgets widgets)
void	deleteWidgetTree(Widget node)	Deletes widget's tree.
void	deleteWidgetTree(Widget node, java.io.File file)	Deletes widget's tree.
protected CockpitApplicationContext	getApplicationContext()
CockpitModuleConnector	getCockpitModuleConnector()
CockpitProperties	getCockpitProperties()
WidgetConnectionsRemover	getWidgetConnectionsRemover()
protected java.io.InputStream	getWidgetsFileAsStream()
protected boolean	isLocalWidgetsFileExisting()
boolean	isStoringEnabled()
protected Widgets	loadWidgets(java.io.InputStream inputStream)
protected void	loadWidgetsForModule(Widgets baseWidgets, java.lang.String moduleUrl)
void	resetToDefaults()	Resets to defaults
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
void	setCockpitModuleConnector(CockpitModuleConnector cockpitModuleConnector)
void	setCockpitProperties(CockpitProperties cockpitProperties)
void	setStoringEnabled(boolean storingEnabled)
void	setWidgetConnectionsRemover(WidgetConnectionsRemover widgetConnectionsRemover)
protected void	storeWidgets(Widgets widgets, java.io.OutputStream outputStream)
void	storeWidgetTree(Widget widget)	Stores widget's tree in file
protected void	updateWidgetConnections(Widgets baseWidgets, Widgets additionalWidgets)	Deprecated, for removal: This API element is subject to removal in a future version. since 1811, not used anymore

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, extractWidgetExtensions, getAccessRestrictions, getDefaultWidgetConfig, getImportRootFile, getImportSupport, getTemplateEngine, getUndefinedParameters, getWidgetAccessResolver, getWidgetById, getWidgetDefinitionService, getWidgetLibUtils, getWidgetsFile, getWidgetsInSlot, getWidgetTreeAsString, hasDefaultConfig, isChildWidget, isStubWidget, loadImports, loadImports, loadWidgetsInternal, loadWidgetTree, loadWidgetTree, mergeWidgets, mergeWidgets, releaseReadLock, releaseWriteLock, removeWidgets, requestReadLock, requestWriteLock, resolveResource, resolveResourcePath, setContextId, setDefaultWidgetConfig, setImportSupport, 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

COCKPITNG_WIDGETS_STORING_ENABLED

public static final java.lang.String COCKPITNG_WIDGETS_STORING_ENABLED

See Also:

Constant Field Values

Constructor Detail

XmlModuleAwarePersistenceService

public XmlModuleAwarePersistenceService()

Method Detail

storeWidgets

protected void storeWidgets(Widgets widgets,
                            java.io.OutputStream outputStream)

Overrides:

storeWidgets in class XMLWidgetPersistenceService

storeWidgetTree

public void storeWidgetTree(Widget widget)

Description copied from interface: WidgetPersistenceService

Stores widget's tree in file

Specified by:

storeWidgetTree in interface WidgetPersistenceService

Overrides:

storeWidgetTree in class XMLWidgetPersistenceService

Parameters:

widget - tree to store

deleteWidgetTree

public void deleteWidgetTree(Widget node)

Description copied from interface: WidgetPersistenceService

Deletes widget's tree.

Specified by:

deleteWidgetTree in interface WidgetPersistenceService

Overrides:

deleteWidgetTree in class XMLWidgetPersistenceService

Parameters:

node - tree to delete

deleteWidgetTree

public void deleteWidgetTree(Widget node,
                             java.io.File file)
                      throws java.io.FileNotFoundException

Description copied from class: XMLWidgetPersistenceService

Deletes widget's tree.

Overrides:

deleteWidgetTree in class XMLWidgetPersistenceService

Parameters:

node - root node of the widget's tree

file - where tree is stored

Throws:

java.io.FileNotFoundException - thrown if specified widgets file cannot be found

getWidgetsFileAsStream

protected java.io.InputStream getWidgetsFileAsStream()
                                              throws java.io.FileNotFoundException

Overrides:

getWidgetsFileAsStream in class XMLWidgetPersistenceService

Throws:

java.io.FileNotFoundException

isLocalWidgetsFileExisting

protected boolean isLocalWidgetsFileExisting()

loadWidgets

protected Widgets loadWidgets(java.io.InputStream inputStream)

Overrides:

loadWidgets in class XMLWidgetPersistenceService

loadWidgetsForModule

protected void loadWidgetsForModule(Widgets baseWidgets,
                                    java.lang.String moduleUrl)

addAdditionalWidgets

protected void addAdditionalWidgets(Widgets baseWidgets,
                                    Widgets additionalWidgets)

updateWidgetConnections

@Deprecated(since="1811",
            forRemoval=true)
protected void updateWidgetConnections(Widgets baseWidgets,
                                       Widgets additionalWidgets)

Deprecated, for removal: This API element is subject to removal in a future version.

since 1811, not used anymore

applyExtensions

protected void applyExtensions(Widgets widgets)

Overrides:

applyExtensions in class XMLWidgetPersistenceService

isStoringEnabled

public boolean isStoringEnabled()

setStoringEnabled

public void setStoringEnabled(boolean storingEnabled)

getCockpitProperties

public CockpitProperties getCockpitProperties()

Overrides:

getCockpitProperties in class XMLWidgetPersistenceService

setCockpitProperties

@Autowired
public void setCockpitProperties(CockpitProperties cockpitProperties)

Overrides:

setCockpitProperties in class XMLWidgetPersistenceService

resetToDefaults

public void resetToDefaults()

Description copied from interface: WidgetPersistenceService

Resets to defaults

Specified by:

resetToDefaults in interface WidgetPersistenceService

Overrides:

resetToDefaults in class XMLWidgetPersistenceService

getCockpitModuleConnector

public CockpitModuleConnector getCockpitModuleConnector()

setCockpitModuleConnector

public void setCockpitModuleConnector(CockpitModuleConnector cockpitModuleConnector)

setWidgetConnectionsRemover

public void setWidgetConnectionsRemover(WidgetConnectionsRemover widgetConnectionsRemover)

getWidgetConnectionsRemover

public WidgetConnectionsRemover getWidgetConnectionsRemover()

getApplicationContext

protected CockpitApplicationContext getApplicationContext()

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware