Package jetbrains.buildServer.serverSide

Interface CustomDataStorageManager

All Known Implementing Classes:

CustomDataStorageManagerImpl

public interface CustomDataStorageManager

Method Summary

Modifier and Type	Method	Description
void	destroyProjectStorage(String projectId)
CustomDataStorage	getBuildStorage(String buildTypeId, long buildId, String storageId)
Set<String>	getBuildStorageIds(String buildTypeId, long buildId, String storageIdPrefix)	Returns ids of all the custom data storages associated with the specified build type and build and having the specified prefix.
CustomDataStorage	getBuildTypeStorage(String buildTypeId, String storageId)
CustomDataStorage	getCustomDataStorage(long parentVcsRootId, String storageId)
CustomDataStorage	getCustomDataStorage(Class<?> clazz)	Returns storage which uses class name as internal storage id.
CustomDataStorage	getCustomDataStorage(SBuildType buildType, String storageId)
CustomDataStorage	getCustomDataStorage(SProject project, String storageId)
void	refreshBuildTypeStorages(Collection<String> buildTypeIds, String storageId)
void	refreshProjectStorages(Collection<String> projectIds, String storageId)
int	unloadUnusedStorages()

Method Detail

unloadUnusedStorages

int unloadUnusedStorages()

getCustomDataStorage

@NotNull
CustomDataStorage getCustomDataStorage(@NotNull
                                       SBuildType buildType,
                                       @NotNull
                                       String storageId)

getBuildTypeStorage

@NotNull
CustomDataStorage getBuildTypeStorage(@NotNull
                                      String buildTypeId,
                                      @NotNull
                                      String storageId)

getBuildStorage

@NotNull
CustomDataStorage getBuildStorage(@NotNull
                                  String buildTypeId,
                                  long buildId,
                                  @NotNull
                                  String storageId)

getBuildStorageIds

@NotNull
Set<String> getBuildStorageIds(@NotNull
                               String buildTypeId,
                               long buildId,
                               @NotNull
                               String storageIdPrefix)

Returns ids of all the custom data storages associated with the specified build type and build and having the specified prefix.

Parameters:

buildTypeId - internal build type id

buildId - id of a build

storageIdPrefix - storage id prefix

Returns:

set of full ids

getCustomDataStorage

@NotNull
CustomDataStorage getCustomDataStorage(@NotNull
                                       SProject project,
                                       @NotNull
                                       String storageId)

getCustomDataStorage

@NotNull
CustomDataStorage getCustomDataStorage(long parentVcsRootId,
                                       @NotNull
                                       String storageId)

getCustomDataStorage

@NotNull
CustomDataStorage getCustomDataStorage(@NotNull
                                       Class<?> clazz)

Returns storage which uses class name as internal storage id. Such a storage can be used by different services which need to store some data in the database without association of this data with any particular entity. The only purpose of the class argument is to make it more visible what service created this storage.

Parameters:

clazz - class of the service/Sptring bean which created and uses this storage

Returns:

see above

Since:

2020.2

destroyProjectStorage

void destroyProjectStorage(@NotNull
                           String projectId)

refreshBuildTypeStorages

void refreshBuildTypeStorages(@NotNull
                              Collection<String> buildTypeIds,
                              @NotNull
                              String storageId)

refreshProjectStorages

void refreshProjectStorages(@NotNull
                            Collection<String> projectIds,
                            @NotNull
                            String storageId)