Package com.adobe.granite.contexthub.api

Interface ContextHub

@ProviderType public interface ContextHub

  • Method Details

    • getPath

      String getPath(SlingHttpServletRequest request)
      Returns Path to ContextHub
      Parameters:
      request - request
      Returns:
      URL to contexthub

    • getPath

      String getPath(SlingHttpServletRequest request, boolean checkRequestResource)
      Returns Path to ContextHub
      Parameters:
      request - request
      checkRequestResource - indicates whether request resource should be used to resolve ContextHub path
      Returns:
      URL to contexthub

    • getRunModes

      Set<String> getRunModes()
      Returns instance's run modes.
      Returns:
      list of run modes

    • findStores

      List<Store> findStores(Resource contextHub)
      Given a ContextHub configuration resource, return the corresponding Stores as list
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      list of stores

    • findModules

      List<Module> findModules(Resource contextHub)
      Given a ContextHub configuration resource, return the corresponding Modules as list
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      list of modules

    • findModes

      List<Mode> findModes(Resource contextHub)
      Given a ContextHub configuration resource, return the corresponding Modes as list
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      list of modes

    • filterStores

      List<Store> filterStores(Resource contextHub, EnumSet<ContextHub.StoreStatus> flags)
      Returns all stores matching to requested filter.
      Parameters:
      contextHub - the ContextHub configuration resource
      flags - filter (EnumSet containing desired status of the store)
      Returns:
      stores matching to requested filter

    • filterModules

      List<Module> filterModules(Resource contextHub, EnumSet<ContextHub.ModuleStatus> flags)
      Returns all modules matching to requested filter.
      Parameters:
      contextHub - the ContextHub configuration resource
      flags - filter (EnumSet containing desired status of the store)
      Returns:
      modules matching to requested filter

    • getEnabledStores

      List<Store> getEnabledStores(Resource contextHub)
      Returns all enabled ContextHub's stores.
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      enabled stores

    • getEnabledModules

      List<Module> getEnabledModules(Resource contextHub)
      Returns all visible ContextHub modules.
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      enabled modules

    • getEnabledModes

      List<Mode> getEnabledModes(Resource contextHub)
      Returns all visible ContextHub modes.
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      enabled modes

    • getDisabledStores

      List<Store> getDisabledStores(Resource contextHub)
      Returns all disabled ContextHub's stores.
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      disabled stores

    • getDisabledModules

      List<Module> getDisabledModules(Resource contextHub)
      Returns all hidden ContextHub modules.
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      hidden modules

    • getDisabledModes

      List<Mode> getDisabledModes(Resource contextHub)
      Returns all hidden ContextHub modes.
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      hidden modes

    • getTheme

      String getTheme(Resource contextHub)
      Returns ContextHub's UI theme name.
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      UI theme name

    • isConfigured

      boolean isConfigured(Resource contextHub)
      Determines if ContextHub's instance is ready to use (it's false when ContextHub's resource wasn't found).
      Parameters:
      contextHub - the ContextHub configuration resource
      Returns:
      true if ContextHub was properly initialized

    • isConfigured

      boolean isConfigured(SlingHttpServletRequest request)
      Determines if ContextHub is configured for this request.
      Parameters:
      request - request
      Returns:
      true if ContextHub was properly initialized

    • getKernelCodeURL

      String getKernelCodeURL(SlingHttpServletRequest request)
      Returns URL to ContextHub's kernel.js
      Parameters:
      request - request
      Returns:
      URL to kernel.js

    • getUICodeURL

      String getUICodeURL(SlingHttpServletRequest request)
      Returns the URL to ContextHub's ui.js
      Parameters:
      request - request
      Returns:
      URL to ui.js

    • getStylesURL

      String getStylesURL(SlingHttpServletRequest request)
      Returns URL to ContextHub's styles.css (containing ui source code)
      Parameters:
      request - request
      Returns:
      URL to styles.css

    • getUIPageURL

      String getUIPageURL(SlingHttpServletRequest request)
      Returns URL to ContextHub's UI page (which is "static", only the code is "dynamic")
      Parameters:
      request - request
      Returns:
      URL to ui.html

    • getKernelCategories

      List<String> getKernelCategories(SlingHttpServletRequest request)
      Returns a list of kernel client library categories (including javascript part of ui libraries if includeUI is set to true).
      Parameters:
      request - request
      Returns:
      list of categories required to build code.js

    • getUICategories

      List<String> getUICategories(SlingHttpServletRequest request)
      Returns a list of ui (type: js) client library categories.
      Parameters:
      request - request
      Returns:
      list of categories required to build styles.css

    • getStylesCategories

      List<String> getStylesCategories(SlingHttpServletRequest request)
      Returns a list of ui (type: css) client library categories.
      Parameters:
      request - request
      Returns:
      list of categories required to build styles.css

    • getKernelCode

      String getKernelCode(SlingHttpServletRequest request, SlingHttpServletResponse response)
      Returns generated output of kernel.js. Output is built based on categories returned by getKernelCategories(org.apache.sling.api.SlingHttpServletRequest) and minimized if not set to debug.
      Parameters:
      request - request
      response - response
      Returns:
      ContextHub's kernel JavaScript code

    • getUICode

      String getUICode(SlingHttpServletRequest request, SlingHttpServletResponse response)
      Returns generated output of ui.js. Output is build basing on categories returned by getUICategories(org.apache.sling.api.SlingHttpServletRequest) and minimized if not set to debug.
      Parameters:
      request - request
      response - response
      Returns:
      output of ui.js

    • getStyles

      String getStyles(SlingHttpServletRequest request)
      Returns generated output of styles.css. Output is build basing on categories returned by getUICategories(org.apache.sling.api.SlingHttpServletRequest) and minimized if not set to debug.
      Parameters:
      request - request
      Returns:
      output of styles.css

    • showUi

      boolean showUi()
      Returns whether to include the ContextHub UI or not.
      Returns:
      true if ContextHub UI is to be included

    • isSilentMode

      boolean isSilentMode()
      Returns whether ContextHub should run in silent mode (takes priority over debug mode).
      Returns:
      true if debug is enabled

    • isDebug

      boolean isDebug(SlingHttpServletRequest request)
      Returns whether debug is enabled for a given ContextHub instance.
      Returns:
      true if debug is enabled

    • isDisabled

      boolean isDisabled(SlingHttpServletRequest request)
      Returns whether a given ContextHub instance is disabled.
      Parameters:
      request - - request
      Returns:
      true if a given ContextHub instance is disabled.

    • getAnonymousPath

      String getAnonymousPath()
      Returns home path of anonymous user.
      Returns:
      {String|null}