Package com.hybris.backoffice.constants

Class BackofficeModules

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

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static java.util.Optional<ExtensionInfo> getBackofficeModule​(java.lang.String moduleName)
      Provides information about an extension of specified name that defines backoffice nature
      static java.util.List<ExtensionInfo> getBackofficeModules()
      Provides a list of extensions registered in system that define backoffice nature
      static java.util.List<java.lang.String> getBackofficeModulesNames()
      Provides a list of extension names registered in system that declare backoffice nature
      static java.io.File getConfigXmlFile​(ExtensionInfo extension)
      Gets backoffice UI configuration file for specified extension
      static java.io.File getModuleFile​(ExtensionInfo extension, java.lang.String suffix)
      Gets backoffice configuration file for specified extension and of specified suffix (i.e.
      static java.lang.String getModuleFileName​(java.lang.String moduleName, java.lang.String suffix)
      Gets the name of backoffice configuration file for specified module and of specified suffix (i.e.
      static java.io.File getSpringDefinitionsFile​(ExtensionInfo extension)
      Gets backoffice spring beans configuration file for specified extension
      static java.io.File getWidgetsXmlFile​(ExtensionInfo extension)
      Gets backoffice widgets meshup file for specified extension

      • Methods inherited from class java.lang.Object

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

    • Method Detail

      • getBackofficeModules

        public static java.util.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 java.util.List<java.lang.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 java.util.Optional<ExtensionInfo> getBackofficeModule​(java.lang.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 java.lang.String getModuleFileName​(java.lang.String moduleName,
                                                 java.lang.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 java.io.File getModuleFile​(ExtensionInfo extension,
                                         java.lang.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 java.io.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 java.io.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 java.io.File getWidgetsXmlFile​(ExtensionInfo extension)
        Gets backoffice widgets meshup file for specified extension
        Parameters:
        extension - information about extension
        Returns:
        widgets meshup file