Package com.hybris.cockpitng.modules

Interface CockpitModuleConnector

    • Method Detail

      • getCockpitModuleUrls

        java.util.List<java.lang.String> getCockpitModuleUrls()
        Returns:
        All module urls currently defined in the system.

      • getModuleInfo

        CockpitModuleInfo getModuleInfo​(java.lang.String moduleUrl)
        Returns:
        The module info registered for the give moduleUrl.

      • getLibraryHandler

        LibraryHandler getLibraryHandler​(java.lang.String moduleUrl)
        Returns:
        The library handler for the given moduleUrl, which is responsible for loading the widget module library.

      • getWidgetTreeContent

        java.lang.String getWidgetTreeContent​(java.lang.String moduleUrl)
        Returns:
        The additional widget mashup provided by the the module with the given moduleUrl.

      • getDefaultModules

        @Deprecated(since="1808",
            forRemoval=true)
java.util.List<ModuleEntry> getDefaultModules()
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 1808, use CockpitApplicationContext.getLoadedModulesNames()
        Returns:
        Default cockpit modules. They are usually provided by the host of the cockpit ng webapp.

      • getCustomModuleUrls

        java.util.List<java.lang.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(since="1808",
            forRemoval=true)
void setDefaultModules​(java.util.List<ModuleEntry> defaultModules)
        Deprecated, for removal: This API element is subject to removal in a future version.
        since 1808, not available anymore
        See getDefaultModules().

      • setCustomModuleUrls

        void setCustomModuleUrls​(java.util.List<java.lang.String> customModuleUrls)
        See getCustomModuleUrls().

      • updateWidgetsExtension

        default void updateWidgetsExtension​(ModuleInfo moduleInfo,
                                    java.lang.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,
                                         java.lang.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()