com.hybris.cockpitng.modules

Interface CockpitModuleConnector

All Known Implementing Classes:

AbstractCockpitModuleConnector, EmptyCockpitModuleConnector

public interface CockpitModuleConnector

Connector for cockpit modules, used by CockpitModuleComponentDefinitionService and XmlModuleAwarePersistenceService to access remote widgets and mashups.

Method Summary

Modifier and Type	Method and Description
List<String>	getCockpitModuleUrls()
List<String>	getCustomModuleUrls()
List<ModuleEntry>	getDefaultModules() Deprecated. since 1808, use CockpitApplicationContext.getLoadedModulesNames()
LibraryHandler	getLibraryHandler(String moduleUrl)
CockpitModuleInfo	getModuleInfo(String moduleUrl)
String	getWidgetTreeContent(String moduleUrl)
boolean	isCustomModulesPermitted()
void	setCustomModuleUrls(List<String> customModuleUrls) See getCustomModuleUrls().
void	setDefaultModules(List<ModuleEntry> defaultModules) Deprecated. since 1808, not available anymore
default void	updateApplicationContextUri(ModuleInfo moduleInfo, String contextUri) Updates specified modules application context extension uri.
default void	updateWidgetsExtension(ModuleInfo moduleInfo, String widgetsExtension) Updates specified modules widget's mesh-up extension.

Method Detail

getCockpitModuleUrls

List<String> getCockpitModuleUrls()

Returns:

All module urls currently defined in the system.

getModuleInfo

CockpitModuleInfo getModuleInfo(String moduleUrl)

Returns:

The module info registered for the give moduleUrl.

getLibraryHandler

LibraryHandler getLibraryHandler(String moduleUrl)

Returns:

The library handler for the given moduleUrl, which is responsible for loading the widget module library.

getWidgetTreeContent

String getWidgetTreeContent(String moduleUrl)

Returns:

The additional widget mashup provided by the the module with the given moduleUrl.

getDefaultModules

@Deprecated
List<ModuleEntry> getDefaultModules()

Deprecated. since 1808, use CockpitApplicationContext.getLoadedModulesNames()

Returns:

Default cockpit modules. They are usually provided by the host of the cockpit ng webapp.

getCustomModuleUrls

List<String> getCustomModuleUrls()

Returns:

URLs for custom cockpit modules. They can be added during runtime by a cockpit admininstrator.

isCustomModulesPermitted

boolean isCustomModulesPermitted()

Returns:

True, if administrator is allowed to add custom modules during runtime.

setDefaultModules

@Deprecated
void setDefaultModules(List<ModuleEntry> defaultModules)

Deprecated. since 1808, not available anymore

See getDefaultModules().

setCustomModuleUrls

void setCustomModuleUrls(List<String> customModuleUrls)

See getCustomModuleUrls().

updateWidgetsExtension

default void updateWidgetsExtension(ModuleInfo moduleInfo,
                                    String widgetsExtension)

Updates specified modules widget's mesh-up extension.

Parameters:

moduleInfo - module info to be updated

widgetsExtension - widget's mesh-up extension

See Also:

ModuleInfo.getWidgetsExtension()

updateApplicationContextUri

default void updateApplicationContextUri(ModuleInfo moduleInfo,
                                         String contextUri)

Updates specified modules application context extension uri.

Parameters:

moduleInfo - module info to be updated

contextUri - uri to application context extension

See Also:

ModuleInfo.getApplicationContextUri()