Package jetbrains.buildServer.serverSide

Interface CredentialsStorageEx

All Superinterfaces:

CredentialsStorage, ServerExtension, TeamCityExtension

All Known Implementing Classes:

ProjectCredentialsStorage, TruncatingPrefixCredentialsStorageEx

public interface CredentialsStorageEx
extends CredentialsStorage

Method Summary

Modifier and Type	Method	Description
void	copySecureValuesForTokens(Map<String,SProject> tokenProjects, SProject contextProject)	Copy tokens to contextProject from tokenProjects.
void	deleteTokensFromProject(List<String> tokens, SProject contextProject)	Delete tokens from context project Requires explicit persist action after, see CredentialsStorageEx#schedulePersistingCredentials
Map<String,Map<String,String>>	findSecureValuesForTokens(Set<String> tokens, List<SProject> contextProjects)	Find all secure values for tokens in contextProjects For each token, different secure values can be found in different projects
Map<String,String>	getStoredValues(SProject contextProject)	Return all stored secure values for [contextProject]
PersistTask	schedulePersistingCredentials(SProject project)	Schedules persisting of all tokens related to [project] to persistent storage.
void	setSecureValuesForTokens(Map<String,String> tokens, SProject contextProject)	Save tokens and their secure values to credentials storage if no mapping for token exists

Methods inherited from interface jetbrains.buildServer.serverSide.CredentialsStorage

findTokenForSecureValue, getType, mapSecureValueToToken, mapTokenToSecureValue

Method Detail

setSecureValuesForTokens

void setSecureValuesForTokens(@NotNull
                              Map<String,String> tokens,
                              @NotNull
                              SProject contextProject)

Save tokens and their secure values to credentials storage if no mapping for token exists

Parameters:

tokens - map from token to secure value that should be stored

contextProject - project being edited

Since:

2019.2

findSecureValuesForTokens

@NotNull
Map<String,Map<String,String>> findSecureValuesForTokens(@NotNull
                                                                     Set<String> tokens,
                                                                     @NotNull
                                                                     List<SProject> contextProjects)

Find all secure values for tokens in contextProjects For each token, different secure values can be found in different projects

Parameters:

tokens - list of tokens to find secure values for

contextProjects - list of projects to search secure values in

Returns:

map from token to map from project external id to secure value

Since:

2019.2

copySecureValuesForTokens

void copySecureValuesForTokens(@NotNull
                               Map<String,SProject> tokenProjects,
                               @NotNull
                               SProject contextProject)

Copy tokens to contextProject from tokenProjects.

Parameters:

tokenProjects - map from token to project. All tokens from this map will be copied to contextProject

contextProject - project to copy tokens to

Since:

2020.1

getStoredValues

@NotNull
Map<String,String> getStoredValues(@NotNull
                                         SProject contextProject)

Return all stored secure values for [contextProject]

Parameters:

contextProject - context project to get all stored secure values for

Returns:

map token -> secure value

Since:

2019.2

schedulePersistingCredentials

@Nullable
PersistTask schedulePersistingCredentials(@NotNull
                                          SProject project)

Schedules persisting of all tokens related to [project] to persistent storage. Returns task which can be used to wait for the persisting to complete. If returned task is null, then project did not have tokens.

Parameters:

project -

Since:

2019.2.2

deleteTokensFromProject

void deleteTokensFromProject(@NotNull
                             List<String> tokens,
                             @NotNull
                             SProject contextProject)

Delete tokens from context project Requires explicit persist action after, see CredentialsStorageEx#schedulePersistingCredentials

Parameters:

tokens - list of tokens to delete

contextProject - project being edited

Since:

2020.2