Package jetbrains.buildServer.clouds.server

Interface CloudManagerBase

All Known Implementing Classes:

CloudManagerBaseImpl

public interface CloudManagerBase

Server-side cloud manager.

Method Summary

Modifier and Type	Method	Description
CloudImageParameters	createImage(String projectId, CloudImageData imageData)
CloudProfile	createProfile(String projectId, CloudProfileData profileData)
void	deleteImage(String projectId, String profileId, String imageId)	Deletes a cloud image with the specified imageId from a cloud profile
void	disposeClient(String projectId, String profileId)	Disposes resources related to a specific cloud profile.
CloudType	findCloudType(String cloudName)
CloudImageParameters	findImageByInternalId(String projectId, String imageInternalId)
CloudProfile	findProfileById(String projectId, String profileId)
CloudProfile	findProfileByImageId(String imageId)
CloudProfile	findProfileGloballyById(String profileId)
CloudClientEx	getClient(String projectId, String profileId)
CloudClientEx	getClientIfExists(String projectId, String profileId)
CloudClientEx	getClientIfExistsByProjectExtId(String projectExtId, String profileId)
Collection<? extends CloudType>	getCloudTypes()	Returns all available "Real" cloud types, excluding ReadOnlyClient (which is not a "real" cloud type, but rather used to show instances on the secondary nodes).
ProjectCloudIntegrationStatus	getProjectIntegrationStatus(String projectId)
boolean	isConfigurable(String projectId)	Returns true if user can enable/disable configuration in the current project's tree
boolean	isIntegrationEnabled(String projectId)
Collection<CloudProfile>	listAllProfiles()	Returns all profiles available on server across all projects.
Collection<CloudImageParameters>	listImagesByProject(String projectId)
Collection<CloudProfile>	listProfilesByProject(String projectId, boolean includeFromSubprojects)
boolean	removeProfile(String projectId, String profileId)
void	setProfileEnabled(String projectId, String profileId, boolean enabled)
CloudProfile	updateProfile(String projectId, String profileId, CloudProfileData cloudProfileData)
void	updateStatus(String projectId, ProjectCloudIntegrationStatus newStatus)

Method Detail

isIntegrationEnabled

boolean isIntegrationEnabled(@NotNull
                             String projectId)

Parameters:

projectId -

Returns:

true if cloud integration is enabled in the project with given id

isConfigurable

boolean isConfigurable(@NotNull
                       String projectId)

Returns true if user can enable/disable configuration in the current project's tree

Parameters:

projectId - project internal id

Returns:

see above

updateProfile

@NotNull
CloudProfile updateProfile(@NotNull
                           String projectId,
                           @NotNull
                           String profileId,
                           @NotNull
                           CloudProfileData cloudProfileData)

listProfilesByProject

@NotNull
Collection<CloudProfile> listProfilesByProject(String projectId,
                                               boolean includeFromSubprojects)

listAllProfiles

@NotNull
Collection<CloudProfile> listAllProfiles()

Returns all profiles available on server across all projects. CloudProfile#profileId is guaranteed to be unique in this list

Returns:

getCloudTypes

@NotNull
Collection<? extends CloudType> getCloudTypes()

Returns all available "Real" cloud types, excluding ReadOnlyClient (which is not a "real" cloud type, but rather used to show instances on the secondary nodes).

Returns:

list of types. No order specified

findCloudType

CloudType findCloudType(@Nullable
                        String cloudName)

findProfileById

@Nullable
CloudProfile findProfileById(String projectId,
                             @NotNull
                             String profileId)

findProfileGloballyById

@Nullable
CloudProfile findProfileGloballyById(@NotNull
                                     String profileId)

getClientIfExists

@Nullable
CloudClientEx getClientIfExists(String projectId,
                                @NotNull
                                String profileId)

getClientIfExistsByProjectExtId

CloudClientEx getClientIfExistsByProjectExtId(String projectExtId,
                                              @NotNull
                                              String profileId)

getClient

@NotNull
CloudClientEx getClient(String projectId,
                        @NotNull
                        String profileId)

updateStatus

void updateStatus(String projectId,
                  @NotNull
                  ProjectCloudIntegrationStatus newStatus)

disposeClient

void disposeClient(@NotNull
                   String projectId,
                   @NotNull
                   String profileId)

Disposes resources related to a specific cloud profile.

Parameters:

projectId - the ID of the project

profileId - the ID of the cloud profile

getProjectIntegrationStatus

@Nullable
ProjectCloudIntegrationStatus getProjectIntegrationStatus(String projectId)

Parameters:

projectId - - project internal id

Returns:

returns cloud integration status information in this project; null, if project doesn't have any information (inherits from parent project)

createProfile

@NotNull
CloudProfile createProfile(@NotNull
                           String projectId,
                           @NotNull
                           CloudProfileData profileData)

removeProfile

boolean removeProfile(@NotNull
                      String projectId,
                      @NotNull
                      String profileId)

setProfileEnabled

void setProfileEnabled(@NotNull
                       String projectId,
                       @NotNull
                       String profileId,
                       boolean enabled)

listImagesByProject

@NotNull
Collection<CloudImageParameters> listImagesByProject(@NotNull
                                                     String projectId)

createImage

@NotNull
CloudImageParameters createImage(@NotNull
                                 String projectId,
                                 @NotNull
                                 CloudImageData imageData)

deleteImage

void deleteImage(@NotNull
                 String projectId,
                 @NotNull
                 String profileId,
                 @NotNull
                 String imageId)

Deletes a cloud image with the specified imageId from a cloud profile

Parameters:

projectId - The ID of the project that the image belongs to. Cannot be null.

profileId - The ID of the profile that the image belongs to. Cannot be null.

imageId - The ID of the image to be deleted. Cannot be null.

findImageByInternalId

@Nullable
CloudImageParameters findImageByInternalId(@NotNull
                                           String projectId,
                                           @NotNull
                                           String imageInternalId)

findProfileByImageId

@Nullable
CloudProfile findProfileByImageId(@NotNull
                                  String imageId)