net.nemerosa.ontrack.model.support.ConfigurationService.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ontrack-model Show documentation
Ontrack module: ontrack-model
There is a newer version: 4.4.5
package net.nemerosa.ontrack.model.support

import java.util.*
import java.util.function.Function

/**
 * Defines what the management of configurations must be.
 *
 * @param T Type of configuration
 */
interface ConfigurationService> {

    /**
     * Gets the list of configurations.
     */
    val configurations: List

    /**
     * List of descriptors for all these configurations
     */
    val configurationDescriptors: List

    /**
     * Saves a _new_ configuration.
     *
     * @param configuration Configuration to save
     * @return Saved configuration
     */
    fun newConfiguration(configuration: T): T

    /**
     * Gets a configuration by its name and fails if not found.
     *
     * Note that the returned configuration is *not* obfuscated. It can be used internally safely
     * and will be obfuscated whenever sent to the client.
     *
     * @param name Name of the configuration to find
     * @return Found configuration
     * @throws ConfigurationNotFoundException If the configuration cannot be found
     */
    fun getConfiguration(name: String): T

    /**
     * Same than [getConfiguration] but returns null if not found.
     *
     * @param name Name of the configuration to find
     * @return The configuration or null if not found
     */
    fun findConfiguration(name: String): T?

    /**
     * Same than [getConfiguration] but returns empty if not found.
     *
     * @param name Name of the configuration to find
     * @return The configuration or empty if not found
     */
    @Deprecated(message = "Use findConfiguration instead", replaceWith = ReplaceWith("findConfiguration"))
    fun getOptionalConfiguration(name: String): Optional

    /**
     * Deletes a configuration
     *
     * @param name Name of the configuration to delete
     */
    fun deleteConfiguration(name: String)

    /**
     * Tests a configuration
     */
    fun test(configuration: T): ConnectionResult

    /**
     * Gets the former password if new password is blank for the same user. For a new user,
     * a blank password can be accepted.
     */
    fun updateConfiguration(name: String, configuration: T)

    /**
     * Tries to replace a configuration by another based on its name.
     *
     *
     * If the replacement function, applied on the configuration name, would
     * give the same exact name, this method returns the configuration.
     *
     *
     * If the names are different, there are two cases:
     *
     *  * If the current user is allowed to create a new configuration,
     * the given configuration is transformed using the replacement
     * function and a new configuration is created.
     *  * If the current user is not allowed to create a configuration,
     * a [ConfigurationNotFoundException]
     * exception is thrown.
     *
     *
     */
    @Deprecated("Will be removed in V5.")
    fun replaceConfiguration(configuration: T, replacementFunction: Function): T

    /**
     * Type of configuration handled by this service
     */
    val configurationType: Class

    /**
     * Adds a configuration event listener to this service
     */
    fun addConfigurationServiceListener(listener: ConfigurationServiceListener)
}