Class BackofficeModules

java.lang.Object
com.hybris.backoffice.constants.BackofficeModules

public final class BackofficeModules extends Object
Utilities class providing information about registered Backoffice modules and their configuration files.
  • Method Details

    • getBackofficeModules

      public static List<ExtensionInfo> getBackofficeModules()
      Provides a list of extensions registered in system that define backoffice nature
      Returns:
      list of extensions in build order
    • getBackofficeModulesNames

      public static List<String> getBackofficeModulesNames()
      Provides a list of extension names registered in system that declare backoffice nature
      Returns:
      list of names of extensions with backoffice nature in build order
    • getBackofficeModule

      public static Optional<ExtensionInfo> getBackofficeModule(String moduleName)
      Provides information about an extension of specified name that defines backoffice nature
      Parameters:
      moduleName - name of module
      Returns:
      information about the extension
    • getModuleFileName

      public static String getModuleFileName(String moduleName, String suffix)
      Gets the name of backoffice configuration file for specified module and of specified suffix (i.e. modulename-backoffice-config.xml)
      Parameters:
      moduleName - name of module
      suffix - file suffix (i.e. config.xml
      Returns:
      full configuration file name
    • getModuleFile

      public static File getModuleFile(ExtensionInfo extension, String suffix)
      Gets backoffice configuration file for specified extension and of specified suffix (i.e. modulename-backoffice-config.xml)
      Parameters:
      extension - information about extension
      suffix - file suffix (i.e. config.xml
      Returns:
      configuration file
    • getSpringDefinitionsFile

      public static File getSpringDefinitionsFile(ExtensionInfo extension)
      Gets backoffice spring beans configuration file for specified extension
      Parameters:
      extension - information about extension
      Returns:
      spring beans configuration file
    • getConfigXmlFile

      public static File getConfigXmlFile(ExtensionInfo extension)
      Gets backoffice UI configuration file for specified extension
      Parameters:
      extension - information about extension
      Returns:
      backoffice UI configuration file
    • getWidgetsXmlFile

      public static File getWidgetsXmlFile(ExtensionInfo extension)
      Gets backoffice widgets meshup file for specified extension
      Parameters:
      extension - information about extension
      Returns:
      widgets meshup file