Package com.hybris.cockpitng.modules.impl

Class AbstractCockpitModuleConnector

java.lang.Object

com.hybris.cockpitng.modules.impl.AbstractCockpitModuleConnector

All Implemented Interfaces:

CockpitModuleConnector

Direct Known Subclasses:

EmptyCockpitModuleConnector

public abstract class AbstractCockpitModuleConnector
extends java.lang.Object
implements CockpitModuleConnector

Implementation of AbstractCockpitModuleConnector capable of getting cockpit modules from different locations. Implement the getModuleInfo(String, boolean) to fetch the module info from given URL in the extending class.

Field Summary

Fields

Modifier and Type	Field	Description
protected java.util.Map<java.lang.String,CockpitModuleInfo>	moduleCache

Constructor Summary

Constructors

Constructor	Description
AbstractCockpitModuleConnector()

Method Summary

Modifier and Type	Method	Description
java.util.List<java.lang.String>	getCockpitModuleUrls()
protected CockpitProperties	getCockpitProperties()
java.util.List<java.lang.String>	getCustomModuleUrls()
java.util.List<ModuleEntry>	getDefaultModules()
LibraryHandler	getLibraryHandler(java.lang.String uri)	Returns the library handler for the protocol in the given url. Examples: "http://modules.cockpitng.com/somewebapp/rest/cockpitng/module" for remote modules "extension://myBackofficeExt" for hybris extensions with a backoffice module
CockpitModuleInfo	getModuleInfo(java.lang.String moduleUrl)
abstract CockpitModuleInfo	getModuleInfo(java.lang.String moduleUrl, boolean cached)	Implement this method to fetch the module info from given URL in the extending class.
java.lang.String	getWidgetTreeContent(java.lang.String moduleUrl)
boolean	isCustomModulesPermitted()
void	setCockpitProperties(CockpitProperties cockpitProperties)
void	setCustomModuleUrls(java.util.List<java.lang.String> customModuleUrls)	See CockpitModuleConnector.getCustomModuleUrls().
void	setDefaultModules(java.util.List<ModuleEntry> defaultModules)	See CockpitModuleConnector.getDefaultModules().
void	setLibraryHandlers(java.util.Map<java.lang.String,LibraryHandler> libHandlers)
void	updateApplicationContextUri(ModuleInfo moduleInfo, java.lang.String contextUri)	Updates specified modules application context extension uri.
void	updateWidgetsExtension(ModuleInfo moduleInfo, java.lang.String widgetsExtension)	Updates specified modules widget's mesh-up extension.

Methods inherited from class java.lang.Object

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

Field Detail

moduleCache

protected final java.util.Map<java.lang.String,CockpitModuleInfo> moduleCache

Constructor Detail

AbstractCockpitModuleConnector

public AbstractCockpitModuleConnector()

Method Detail

getModuleInfo

public abstract CockpitModuleInfo getModuleInfo(java.lang.String moduleUrl,
                                                boolean cached)

Implement this method to fetch the module info from given URL in the extending class.

Parameters:

moduleUrl - URL of the module to fetch

cached - should return cached one if present.

Returns:

module info from given URL

isCustomModulesPermitted

public boolean isCustomModulesPermitted()

Specified by:

isCustomModulesPermitted in interface CockpitModuleConnector

Returns:

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

getCockpitModuleUrls

public java.util.List<java.lang.String> getCockpitModuleUrls()

Specified by:

getCockpitModuleUrls in interface CockpitModuleConnector

Returns:

All module urls currently defined in the system.

getWidgetTreeContent

public java.lang.String getWidgetTreeContent(java.lang.String moduleUrl)

Specified by:

getWidgetTreeContent in interface CockpitModuleConnector

Returns:

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

getModuleInfo

public CockpitModuleInfo getModuleInfo(java.lang.String moduleUrl)

Specified by:

getModuleInfo in interface CockpitModuleConnector

Returns:

The module info registered for the give moduleUrl.

setCustomModuleUrls

public void setCustomModuleUrls(java.util.List<java.lang.String> customModuleUrls)

Description copied from interface: CockpitModuleConnector

See CockpitModuleConnector.getCustomModuleUrls().

Specified by:

setCustomModuleUrls in interface CockpitModuleConnector

getDefaultModules

public java.util.List<ModuleEntry> getDefaultModules()

Specified by:

getDefaultModules in interface CockpitModuleConnector

Returns:

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

setDefaultModules

public void setDefaultModules(java.util.List<ModuleEntry> defaultModules)

Description copied from interface: CockpitModuleConnector

See CockpitModuleConnector.getDefaultModules().

Specified by:

setDefaultModules in interface CockpitModuleConnector

getCustomModuleUrls

public java.util.List<java.lang.String> getCustomModuleUrls()

Specified by:

getCustomModuleUrls in interface CockpitModuleConnector

Returns:

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

getLibraryHandler

public LibraryHandler getLibraryHandler(java.lang.String uri)

Returns the library handler for the protocol in the given url.
Examples:
"http://modules.cockpitng.com/somewebapp/rest/cockpitng/module" for remote modules
"extension://myBackofficeExt" for hybris extensions with a backoffice module

Specified by:

getLibraryHandler in interface CockpitModuleConnector

Returns:

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

setLibraryHandlers

public void setLibraryHandlers(java.util.Map<java.lang.String,LibraryHandler> libHandlers)

updateWidgetsExtension

public void updateWidgetsExtension(ModuleInfo moduleInfo,
                                   java.lang.String widgetsExtension)

Description copied from interface: CockpitModuleConnector

Updates specified modules widget's mesh-up extension.

Specified by:

updateWidgetsExtension in interface CockpitModuleConnector

Parameters:

moduleInfo - module info to be updated

widgetsExtension - widget's mesh-up extension

See Also:

ModuleInfo.getWidgetsExtension()

updateApplicationContextUri

public void updateApplicationContextUri(ModuleInfo moduleInfo,
                                        java.lang.String contextUri)

Description copied from interface: CockpitModuleConnector

Updates specified modules application context extension uri.

Specified by:

updateApplicationContextUri in interface CockpitModuleConnector

Parameters:

moduleInfo - module info to be updated

contextUri - uri to application context extension

See Also:

ModuleInfo.getApplicationContextUri()

getCockpitProperties

protected CockpitProperties getCockpitProperties()

setCockpitProperties

public void setCockpitProperties(CockpitProperties cockpitProperties)