net.nemerosa.ontrack.model.support

Interface ConfigurationService<T extends UserPasswordConfiguration>

All Known Subinterfaces:

ArtifactoryConfigurationService, GitConfigurationService, GitHubConfigurationService, GitLabConfigurationService, JenkinsConfigurationService, JIRAConfigurationService, StashConfigurationService, SVNConfigurationService

All Known Implementing Classes:

AbstractConfigurationService, ArtifactoryConfigurationServiceImpl, GitConfigurationServiceImpl, GitHubConfigurationServiceImpl, GitLabConfigurationServiceImpl, JenkinsConfigurationServiceImpl, JIRAConfigurationServiceImpl, StashConfigurationServiceImpl, SVNConfigurationServiceImpl

public interface ConfigurationService<T extends UserPasswordConfiguration>

Method Summary

Modifier and Type	Method and Description
void	addConfigurationServiceListener(ConfigurationServiceListener<T> listener) Adds a configuration event listener to this service
void	deleteConfiguration(java.lang.String name)
T	getConfiguration(java.lang.String name) Gets a configuration by its name and fails if not found.
java.util.List<ConfigurationDescriptor>	getConfigurationDescriptors()
java.util.List<T>	getConfigurations()
java.lang.Class<T>	getConfigurationType() Type of configuration handled by this service
java.util.Optional<T>	getOptionalConfiguration(java.lang.String name)
T	newConfiguration(T configuration)
T	replaceConfiguration(T configuration, java.util.function.Function<java.lang.String,java.lang.String> replacementFunction) Tries to replace a configuration by another based on its name.
ConnectionResult	test(T configuration) Tests a configuration
void	updateConfiguration(java.lang.String name, T configuration) Gets the former password if new password is blank for the same user.

Method Detail

getConfigurations

java.util.List<T> getConfigurations()

getConfigurationDescriptors

java.util.List<ConfigurationDescriptor> getConfigurationDescriptors()

newConfiguration

T newConfiguration(T configuration)

getConfiguration

T getConfiguration(java.lang.String name)

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.

Parameters:

name - Name of the configuration to find

Returns:

Found configuration

Throws:

ConfigurationNotFoundException - If the configuration cannot be found

getOptionalConfiguration

java.util.Optional<T> getOptionalConfiguration(java.lang.String name)

deleteConfiguration

void deleteConfiguration(java.lang.String name)

test

ConnectionResult test(T configuration)

Tests a configuration

updateConfiguration

void updateConfiguration(java.lang.String name,
                         T configuration)

Gets the former password if new password is blank for the same user. For a new user, a blank password can be accepted.

replaceConfiguration

T replaceConfiguration(T configuration,
                       java.util.function.Function<java.lang.String,java.lang.String> replacementFunction)
                throws ConfigurationNotFoundException

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.

Throws:

ConfigurationNotFoundException

getConfigurationType

java.lang.Class<T> getConfigurationType()

Type of configuration handled by this service

addConfigurationServiceListener

void addConfigurationServiceListener(ConfigurationServiceListener<T> listener)

Adds a configuration event listener to this service