Package jetbrains.buildServer.clouds.server.impl

Class SecuredCloudManager

java.lang.Object

jetbrains.buildServer.clouds.server.impl.SecuredCloudManager

All Implemented Interfaces:

CloudInstanceManager, CloudManager

public class SecuredCloudManager
extends Object
implements CloudManager

Author:

Eugene Petrenko Created: 11.11.2009 22:13:23

Constructor Summary

Constructors

Constructor	Description
SecuredCloudManager(CloudSecurity cloudSecurity, CloudManager insecureCloudManager, CloudInstancesProvider cloudInstancesProvider)

Method Summary

Modifier and Type	Method	Description
CanStartNewInstanceResult	canStartNewInstance(CloudProfile profile, CloudImage image)	Indicates whether it's possible to start a new instance of a certain image in particular cloud profile
CloudProfile	checkProfileReadAccess(String profileId)
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	deleteImageAndInstances(String projectId, String profileId, String imageId, TerminateInstanceReason reason)	Deletes a cloud image with the specified imageId from a cloud profile.
void	disposeClient(String projectId, String profileId)	Disposes of the client associated to the cloud profile with the given project and profile IDs.
void	disposeClientAndRemoveInstances(String projectId, String profileId, TerminateInstanceReason reason)	Disposes of the client associated to the cloud profile with the given project and profile IDs.
Collection<SBuildAgent>	findAgentByInstance(String profileId, String instanceId)
CloudType	findCloudType(String cloudName)	Returns cloud type for name or null
CloudImageParameters	findImageByInternalId(String projectId, String imageInternalId)
Pair<CloudProfile,CloudInstance>	findInstanceByAgent(AgentDescription agent)	Checks if the agent is an instnce of one of the running instances.
CloudInstance	findInstanceById(String projectId, String profileId, String instanceId)	Returns instance by the specified identifier.
Map<AgentDescription,Pair<CloudProfile,CloudInstance>>	findInstancesByAgents(Collection<? extends AgentDescription> agents)	Finds cloud instances (if any) for the collection of agents
CloudProfile	findProfileById(String projectId, String profileId)	Returns profile by the specified identifier in a certain project.
CloudProfile	findProfileByImageId(String imageId)
CloudProfile	findProfileGloballyById(String profileId)	Returns profile by the specified identifier.
String	generateAgentName(AgentDescription agent)	Generated name for build agent that is thought to be running as instance of this cloud client.
CloudClientEx	getClient(String projectId, String profileId)	Provides a client for the specified profile.
CloudClientEx	getClientIfExists(String projectId, String profileId)	Provides a client for the specified profile.
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).
SAgentType	getDescriptionFor(CloudProfile profile, String imageId)	Fetches recorded agent description
ProjectCloudIntegrationStatus	getProjectIntegrationStatus(String projectId)
String	getServerUrlForAgent(CloudProfile profile, CloudImage image)	Server url that will be sent to new created build agent
boolean	isConfigurable(String projectId)	Returns true if user can enable/disable configuration in the current project's tree
boolean	isImageWithAgent(CloudProfile profile, CloudImage image)	Checks if the image is configured to start agent.
boolean	isInstanceExpired(String profileId, String instanceId)	Returns true, if instance will be terminated after current build finishes
boolean	isIntegrationEnabled(String projectId)
void	iterateInstances(CloudInstancesProviderCallback callback)	Iterates through all running instances of all profiles.
void	iterateInstances(CloudInstancesProviderExtendedCallback callback)	Iterates through all running instances of all profiles.
void	iterateProfileInstances(CloudProfile profile, CloudInstancesProviderExtendedCallback callback)	Iterates through all running instances of all profiles.
Collection<CloudProfile>	listAllProfiles()	Returns all cloud profiles available to current user.
Collection<CloudImageParameters>	listImagesByProject(String projectId)
Collection<CloudProfile>	listProfilesByProject(String projectId, boolean includeFromSubprojects)	Returns cloud profiles defined in the current project.
void	markInstanceExpired(String profileId, String instanceId)	Marks the instance as expired, so it should be terminated after current build finishes
boolean	removeProfile(String projectId, String profileId)
void	removeProfileAndInstances(String projectId, String profileId, TerminateInstanceReason reason)	Terminate all running instance for the profile and then removes the profile itself
void	setProfileEnabled(String projectId, String profileId, boolean enabled)
CloudInstance	startInstance(String projectId, String profileId, String imageId, StartInstanceReason reason)	Starts new agent instance for given profile and image
CloudInstance	startInstance(String profileId, String imageId, StartInstanceReason reason)
void	terminateInstance(String projectId, String profileId, String imageId, String instanceId, TerminateInstanceReason reason)	Schedules termination a running instance
void	terminateInstance(String profileId, String imageId, String instanceId, TerminateInstanceReason reason)
void	terminateProfileInstances(String projectId, String profileId, TerminateInstanceReason reason)	Terminate all running instance for the profile
void	terminateProfileInstances(String profileId, TerminateInstanceReason reason)
void	terminateProjectInstances(String projectId, TerminateInstanceReason reason, boolean subProjectsOnly)	Terminate all running instance
CloudProfile	updateProfile(String projectId, String profileId, CloudProfileData profileData)
void	updateStatus(String projectId, ProjectCloudIntegrationStatus newStatus)	Updates enabled/disabled status of integration

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface jetbrains.buildServer.clouds.server.CloudManager

findAgentByInstance, isInstanceExpired, markInstanceExpired

Constructor Detail

SecuredCloudManager

public SecuredCloudManager(@NotNull
                           CloudSecurity cloudSecurity,
                           @NotNull
                           CloudManager insecureCloudManager,
                           @NotNull
                           CloudInstancesProvider cloudInstancesProvider)

Method Detail

findAgentByInstance

@NotNull
public Collection<SBuildAgent> findAgentByInstance(@NotNull
                                                   String profileId,
                                                   @NotNull
                                                   String instanceId)

Specified by:

findAgentByInstance in interface CloudManager

Returns:

agent, if any, that associated with the instance, profile pair

findCloudType

@Nullable
public CloudType findCloudType(@Nullable
                               String cloudName)

Description copied from interface: CloudManager

Returns cloud type for name or null

Specified by:

findCloudType in interface CloudManager

Parameters:

cloudName - cloud type ID

Returns:

registered cloud type or null

findInstanceByAgent

@Nullable
public Pair<CloudProfile,CloudInstance> findInstanceByAgent(@NotNull
                                                                  AgentDescription agent)

Description copied from interface: CloudManager

Checks if the agent is an instnce of one of the running instances.

Specified by:

findInstanceByAgent in interface CloudManager

Parameters:

agent - agent description of an agent that is going to connect

Returns:

corresponding CloudInstance if found or null

findInstancesByAgents

@NotNull
public Map<AgentDescription,Pair<CloudProfile,CloudInstance>> findInstancesByAgents(@NotNull
                                                                                                Collection<? extends AgentDescription> agents)

Description copied from interface: CloudManager

Finds cloud instances (if any) for the collection of agents

Specified by:

findInstancesByAgents in interface CloudManager

Parameters:

agents - agent descriptions of agents

Returns:

found pairs of agents and cloud instances. For agents that we don't find cloud instance for there's no entry in this collection

findProfileById

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

Description copied from interface: CloudManager

Returns profile by the specified identifier in a certain project.

Specified by:

findProfileById in interface CloudManager

Parameters:

projectId - internal project id

profileId - , see CloudProfile.getProfileId().

Returns:

found profile or null if no such ones.

findProfileGloballyById

@Nullable
public CloudProfile findProfileGloballyById(@NotNull
                                            String profileId)

Returns profile by the specified identifier.

Specified by:

findProfileGloballyById in interface CloudManager

Parameters:

profileId -

Returns:

found profile or null if no such ones.

checkProfileReadAccess

@Nullable
public CloudProfile checkProfileReadAccess(@NotNull
                                           String profileId)

findInstanceById

@Nullable
public CloudInstance findInstanceById(@NotNull
                                      String projectId,
                                      @NotNull
                                      String profileId,
                                      @NotNull
                                      String instanceId)

Returns instance by the specified identifier.

Specified by:

findInstanceById in interface CloudManager

Parameters:

projectId -

profileId -

instanceId -

Returns:

found instance or null if no such ones.

getClient

@NotNull
public CloudClientEx getClient(String projectId,
                               @NotNull
                               String profileId)
                        throws CloudException,
                               IllegalArgumentException

Description copied from interface: CloudManager

Provides a client for the specified profile. Creates a new client or gets a cached one if exists.

Specified by:

getClient in interface CloudManager

profileId - id of profile, see CloudProfile.getProfileId().

Returns:

correct ready for use cloud client.

Throws:

CloudException - e

IllegalArgumentException - e

getClientIfExists

@Nullable
public CloudClientEx getClientIfExists(String projectId,
                                       @NotNull
                                       String profileId)
                                throws CloudException,
                                       IllegalArgumentException

Description copied from interface: CloudManager

Provides a client for the specified profile. Creates gets a cached one if exists, returns null otherwise

Specified by:

getClientIfExists in interface CloudManager

profileId - id of profile, see CloudProfile.getProfileId().

Returns:

correct ready for use cloud client.

Throws:

CloudException - e

IllegalArgumentException - e

getCloudTypes

@NotNull
public Collection<? extends CloudType> getCloudTypes()

Description copied from interface: CloudManager

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).

Specified by:

getCloudTypes in interface CloudManager

Returns:

list of types. No order specified

getDescriptionFor

@Nullable
public SAgentType getDescriptionFor(@NotNull
                                    CloudProfile profile,
                                    @NotNull
                                    String imageId)

Description copied from interface: CloudManager

Fetches recorded agent description

Specified by:

getDescriptionFor in interface CloudManager

Parameters:

profile - profile

imageId - image id

Returns:

description if found

isImageWithAgent

public boolean isImageWithAgent(@NotNull
                                CloudProfile profile,
                                @NotNull
                                CloudImage image)

Description copied from interface: CloudManager

Checks if the image is configured to start agent. If unknown - true is returned

Specified by:

isImageWithAgent in interface CloudManager

Parameters:

profile - profile

image - image

Returns:

true is this image may contain agent, false if it is definitly broken

getServerUrlForAgent

@NotNull
public String getServerUrlForAgent(@NotNull
                                   CloudProfile profile,
                                   @NotNull
                                   CloudImage image)

Description copied from interface: CloudManager

Server url that will be sent to new created build agent

Specified by:

getServerUrlForAgent in interface CloudManager

Parameters:

profile - profile

image - image

Returns:

server url

isIntegrationEnabled

public boolean isIntegrationEnabled(String projectId)

Specified by:

isIntegrationEnabled in interface CloudManager

Returns:

false if user decided to disabled cloud integration at all

isConfigurable

public boolean isConfigurable(@NotNull
                              String projectId)

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

Specified by:

isConfigurable in interface CloudManager

Parameters:

projectId - project internal id

Returns:

see above

listProfilesByProject

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

Description copied from interface: CloudManager

Returns cloud profiles defined in the current project.

Specified by:

listProfilesByProject in interface CloudManager

Returns:

list of profiles; order of items is not specified (or depend on this interface implementation); empty list when no ones.

listAllProfiles

@NotNull
public Collection<CloudProfile> listAllProfiles()

Returns all cloud profiles available to current user. Cloud profile is available if user has VIEW_AGENT_CLOUDS permission in the project where this profile belongs.

Specified by:

listAllProfiles in interface CloudManager

Returns:

list of profiles; order of items is not specified (or depend on this interface implementation); empty list when no ones.

updateStatus

public void updateStatus(String projectId,
                         @NotNull
                         ProjectCloudIntegrationStatus newStatus)

Description copied from interface: CloudManager

Updates enabled/disabled status of integration

Specified by:

updateStatus in interface CloudManager

getProjectIntegrationStatus

@Nullable
public ProjectCloudIntegrationStatus getProjectIntegrationStatus(String projectId)

Specified by:

getProjectIntegrationStatus in interface CloudManager

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)

iterateInstances

public void iterateInstances(@NotNull
                             CloudInstancesProviderCallback callback)

Description copied from interface: CloudInstanceManager

Iterates through all running instances of all profiles.

Specified by:

iterateInstances in interface CloudInstanceManager

Parameters:

callback - uses this interface to notify next instance

iterateInstances

public void iterateInstances(@NotNull
                             CloudInstancesProviderExtendedCallback callback)

Description copied from interface: CloudInstanceManager

Iterates through all running instances of all profiles.

Specified by:

iterateInstances in interface CloudInstanceManager

Parameters:

callback - uses this interface to notify next instance

iterateProfileInstances

public void iterateProfileInstances(@NotNull
                                    CloudProfile profile,
                                    @NotNull
                                    CloudInstancesProviderExtendedCallback callback)

Description copied from interface: CloudInstanceManager

Iterates through all running instances of all profiles.

Specified by:

iterateProfileInstances in interface CloudInstanceManager

callback - uses this interface to notify next instance

canStartNewInstance

@NotNull
public CanStartNewInstanceResult canStartNewInstance(@NotNull
                                                     CloudProfile profile,
                                                     @NotNull
                                                     CloudImage image)

Description copied from interface: CloudInstanceManager

Indicates whether it's possible to start a new instance of a certain image in particular cloud profile

Specified by:

canStartNewInstance in interface CloudInstanceManager

Returns:

see above

startInstance

@NotNull
public CloudInstance startInstance(@NotNull
                                   String projectId,
                                   @NotNull
                                   String profileId,
                                   @NotNull
                                   String imageId,
                                   @NotNull
                                   StartInstanceReason reason)
                            throws StartAgentQuotaExceededException,
                                   FailedToStartInstanceException

Description copied from interface: CloudInstanceManager

Starts new agent instance for given profile and image

Specified by:

startInstance in interface CloudInstanceManager

Parameters:

projectId - projectId

profileId - profileId

imageId - imageId

reason - reason why instance is stared. Used for logging

Throws:

StartAgentQuotaExceededException - if there is not enough quota

FailedToStartInstanceException - if image or profile was not found

startInstance

@NotNull
public CloudInstance startInstance(@NotNull
                                   String profileId,
                                   @NotNull
                                   String imageId,
                                   @NotNull
                                   StartInstanceReason reason)
                            throws StartAgentQuotaExceededException,
                                   FailedToStartInstanceException

Specified by:

startInstance in interface CloudInstanceManager

Throws:

StartAgentQuotaExceededException

FailedToStartInstanceException

terminateProjectInstances

public void terminateProjectInstances(String projectId,
                                      @NotNull
                                      TerminateInstanceReason reason,
                                      boolean subProjectsOnly)

Description copied from interface: CloudInstanceManager

Terminate all running instance

Specified by:

terminateProjectInstances in interface CloudInstanceManager

reason - reason of termination

terminateInstance

public void terminateInstance(@NotNull
                              String profileId,
                              @NotNull
                              String imageId,
                              @NotNull
                              String instanceId,
                              @NotNull
                              TerminateInstanceReason reason)
                       throws FailedToStopInstanceException

Specified by:

terminateInstance in interface CloudInstanceManager

Throws:

FailedToStopInstanceException

terminateInstance

public void terminateInstance(@NotNull
                              String projectId,
                              @NotNull
                              String profileId,
                              @NotNull
                              String imageId,
                              @NotNull
                              String instanceId,
                              @NotNull
                              TerminateInstanceReason reason)

Description copied from interface: CloudInstanceManager

Schedules termination a running instance

Specified by:

terminateInstance in interface CloudInstanceManager

Parameters:

projectId - projectId

profileId - profileId

imageId - imageId

instanceId - instanceId

reason - reason why instance is terminated. Used for logging

terminateProfileInstances

public void terminateProfileInstances(@NotNull
                                      String profileId,
                                      @NotNull
                                      TerminateInstanceReason reason)

Specified by:

terminateProfileInstances in interface CloudInstanceManager

terminateProfileInstances

public void terminateProfileInstances(@NotNull
                                      String projectId,
                                      @NotNull
                                      String profileId,
                                      @NotNull
                                      TerminateInstanceReason reason)

Description copied from interface: CloudInstanceManager

Terminate all running instance for the profile

Specified by:

terminateProfileInstances in interface CloudInstanceManager

Parameters:

projectId - projectId

profileId - profileId

reason - reason of temination

generateAgentName

public String generateAgentName(@NotNull
                                AgentDescription agent)

Description copied from interface: CloudManager

Generated name for build agent that is thought to be running as instance of this cloud client.

Specified by:

generateAgentName in interface CloudManager

Parameters:

agent - agent instance

Returns:

proposed build agent name or null

isInstanceExpired

public boolean isInstanceExpired(@NotNull
                                 String profileId,
                                 @NotNull
                                 String instanceId)

Description copied from interface: CloudManager

Returns true, if instance will be terminated after current build finishes

Specified by:

isInstanceExpired in interface CloudManager

Returns:

true, if no other buids will be run on this instance. False otherwise

markInstanceExpired

public void markInstanceExpired(@NotNull
                                String profileId,
                                @NotNull
                                String instanceId)

Description copied from interface: CloudManager

Marks the instance as expired, so it should be terminated after current build finishes

Specified by:

markInstanceExpired in interface CloudManager

createProfile

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

Specified by:

createProfile in interface CloudManager

updateProfile

@NotNull
public CloudProfile updateProfile(@NotNull
                                  String projectId,
                                  @NotNull
                                  String profileId,
                                  @NotNull
                                  CloudProfileData profileData)

Specified by:

updateProfile in interface CloudManager

removeProfile

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

Specified by:

removeProfile in interface CloudManager

setProfileEnabled

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

Specified by:

setProfileEnabled in interface CloudManager

listImagesByProject

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

Specified by:

listImagesByProject in interface CloudManager

createImage

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

Specified by:

createImage in interface CloudManager

deleteImageAndInstances

public void deleteImageAndInstances(@NotNull
                                    String projectId,
                                    @NotNull
                                    String profileId,
                                    @NotNull
                                    String imageId,
                                    @NotNull
                                    TerminateInstanceReason reason)

Description copied from interface: CloudManager

Deletes a cloud image with the specified imageId from a cloud profile. Will also remove any instances running of this image

Specified by:

deleteImageAndInstances in interface CloudManager

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.

reason - reason of termination

deleteImage

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

Description copied from interface: CloudManager

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

Specified by:

deleteImage in interface CloudManager

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.

disposeClientAndRemoveInstances

public void disposeClientAndRemoveInstances(@NotNull
                                            String projectId,
                                            @NotNull
                                            String profileId,
                                            @NotNull
                                            TerminateInstanceReason reason)

Description copied from interface: CloudManager

Disposes of the client associated to the cloud profile with the given project and profile IDs. Will terminate all running instances

Specified by:

disposeClientAndRemoveInstances in interface CloudManager

Parameters:

projectId - the unique identifier of the project

profileId - the unique identifier of the profile

reason - reason of termination

disposeClient

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

Description copied from interface: CloudManager

Disposes of the client associated to the cloud profile with the given project and profile IDs.

Specified by:

disposeClient in interface CloudManager

Parameters:

projectId - the unique identifier of the project

profileId - the unique identifier of the profile

findImageByInternalId

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

Specified by:

findImageByInternalId in interface CloudManager

findProfileByImageId

@Nullable
public CloudProfile findProfileByImageId(@NotNull
                                         String imageId)

Specified by:

findProfileByImageId in interface CloudManager

removeProfileAndInstances

public void removeProfileAndInstances(@NotNull
                                      String projectId,
                                      @NotNull
                                      String profileId,
                                      TerminateInstanceReason reason)

Description copied from interface: CloudManager

Terminate all running instance for the profile and then removes the profile itself

Specified by:

removeProfileAndInstances in interface CloudManager

Parameters:

projectId - projectId

profileId - profileId

reason - reason of temination