Package org.silverpeas.kernel

Interface SilverpeasResourcesLocation

public interface SilverpeasResourcesLocation
Location of the different resource files required by Silverpeas. These resources include the loggers configuration files, the Silverpeas properties files, the L10n bundles, and so on.
Author:
mmoquillon
Implementation Requirements:
The SilverpeasResourcesLocation implementation is loaded from the the Java SPI (Java Service Provider Interface) and the single instance is kept in memory for further retrieval.
Implementation Note:
Whatever the number of available implementations of this interface, only the first found one is used. Nevertheless, by using the @Priority annotation, the implementation to use can be explicitly indicated.

  • Method Details

    • getInstance

      static SilverpeasResourcesLocation getInstance()
      Gets the single object of the SilverpeasResourcesLocation singleton. If the implementation isn't yet loaded, then it is loaded and instantiated once time.
      Returns:
      the single instance of SilverpeasResourcesLocation
      Implementation Note:
      The implementation is loaded and instantiated by Java SPI at first call. The single instance is then kept in memory so that it is returned at each next call.

    • getLoggersRootPath

      Path getLoggersRootPath()
      Gets the path of the root directory into which are defined all the loggers to use by Silverpeas. In this directory should be located the properties file defining and configuring each of the loggers of Silverpeas.
      Returns:
      the path of the root directory of the Silverpeas loggers.

    • getL10nBundlesRootPath

      Path getL10nBundlesRootPath()
      Gets the path of the root directory into which are located the l10n resource bundles for Silverpeas.
      Returns:
      the path of the root directory of the resource bundles.

    • getConfigurationFilesRootPath

      Path getConfigurationFilesRootPath()
      Gets the path of the root directory into which are located the configuration resource files
      Returns:
      the path of the root directory of the properties files.