Package jetbrains.buildServer.serverSide

Interface CustomSettings

  • All Known Implementing Classes:
    CustomSettingsImpl
    public interface CustomSettings
    Deprecated.
    use SBuildType.getCustomDataStorage(String) or {SProject.getCustomDataStorage(String) instead
    Represents a custom server-side settings storage. Custom means that settings correspond to a certain plugin (or an internal client) identified by a name. The name serves as a way of settings isolation, so different plugins can work with coinciding keys safely.

    The plugins are expected to manage and associate the required data with projects, VCS roots, etc or globally, using this interface. New objects to associate to will be added on demand.

    The implementation is responsible for persisting, thread-safe editing and handling the data when corresponding instances are deleted. Actual settings storage is human readable and can be edited manually on the disk.

    Since:
    7.0
    Author:
    Maxim Podkolzine (maxim.podkolzine@jetbrains.com)
    See Also:
    SettingsMap, CustomSettingsManager

    • Method Detail

      • getGlobalSettings

        @NotNull
SettingsMap getGlobalSettings()
        Deprecated.
        Returns the global settings. The actual persistent storage is not created at the moment of this call (though it may already exist), but rather on a first I/O operation.
        Returns:
        global settings map