Package jetbrains.buildServer.serverSide.connections.credentials

Interface ProjectConnectionCredentialsManager

public interface ProjectConnectionCredentialsManager

A service for working with connection credentials. Knows about all supported connection types and how to construct specific credentials.

Since:

2023.05

Method Summary

Modifier and Type	Method	Description
ConnectionCredentials	requestConnectionCredentials(SProject project, String connectionId)	Finds corresponding Connection project feature by ID and creates ConnectionCredentials specific to the Connection Provider type.
ConnectionCredentials	requestConnectionCredentials(SProject project, String connectionId, Map<String,String> additionalParams)	Finds corresponding Connection project feature by ID and creates ConnectionCredentials specific to the Connection Provider type using additional parameters (See corresponding Connection Provider for more details)

Method Detail

requestConnectionCredentials

@NotNull
ConnectionCredentials requestConnectionCredentials(@NotNull
                                                   SProject project,
                                                   @NotNull
                                                   String connectionId)
                                            throws ConnectionCredentialsException

Finds corresponding Connection project feature by ID and creates ConnectionCredentials specific to the Connection Provider type.

Parameters:

project - The project where to search for the Connection.

connectionId - Connection (project feature) id.

Returns:

Specific ConnectionCredentials object with needed credentials type.

Throws:

ConnectionCredentialsException

requestConnectionCredentials

@NotNull
ConnectionCredentials requestConnectionCredentials(@NotNull
                                                   SProject project,
                                                   @NotNull
                                                   String connectionId,
                                                   @Nullable
                                                   Map<String,String> additionalParams)
                                            throws ConnectionCredentialsException

Finds corresponding Connection project feature by ID and creates ConnectionCredentials specific to the Connection Provider type using additional parameters (See corresponding Connection Provider for more details)

Parameters:

project - The project where to search for the Connection.

connectionId - Connection (project feature) id.

additionalParams - Map of additional parameters for connection configuration.

Returns:

Specific ConnectionCredentials object with needed credentials type.

Throws:

ConnectionCredentialsException