Package com.atlassian.bamboo.deployments.versions.service

Class DeploymentVersionServiceImpl

java.lang.Object

com.atlassian.bamboo.deployments.versions.service.DeploymentVersionServiceImpl

All Implemented Interfaces:

DeploymentVersionDtoManager, DeploymentVersionService

public class DeploymentVersionServiceImpl
extends Object
implements DeploymentVersionService, DeploymentVersionDtoManager

Nested Class Summary

Nested classes/interfaces inherited from interface com.atlassian.bamboo.deployments.versions.service.DeploymentVersionService

DeploymentVersionService.DeploymentVersionNeededAttributes

Constructor Summary

Constructors

Constructor

Description

DeploymentVersionServiceImpl(@NotNull DeploymentProjectDao deploymentProjectDao, @NotNull DeploymentVersionDao deploymentVersionDao, @NotNull InternalResultsSummaryAccessor internalResultsSummaryAccessor, @NotNull DeploymentVersionChainResultDataCollector deploymentVersionChainResultDataCollector, @NotNull com.opensymphony.xwork2.TextProvider textProvider, @NotNull BambooUserManager bambooUserService, @NotNull VariableDefinitionManager variableDefinitionManager, @NotNull VariableDefinitionFactory variableDefinitionFactory, @NotNull CustomVariableContext customVariableContext, @NotNull com.atlassian.event.api.EventPublisher eventPublisher, @NotNull CachedPlanManager cachedPlanManager, @NotNull ScopedExclusionService scopedExclusionService, @NotNull ResultsSummaryVariableAccessor resultsSummaryVariableAccessor, @NotNull RepositoryDefinitionManager repositoryDefinitionManager, @NotNull VcsRepositoryManager vcsRepositoryManager, @NotNull BambooCachingPermissionManagerFacadeFactory bambooCachingPermissionManagerFacadeFactory, @NotNull ArtifactLinkManager artifactLinkManager, @NotNull AuditLogService auditLogService)

Method Summary

Modifier and Type	Method	Description
@NotNull DeploymentVersion	createDeploymentVersion(long deploymentProjectId, @NotNull PlanResultKey planResultKey)	Create a deployment version out of a deployment project and plan result.
@NotNull DeploymentVersion	createDeploymentVersion(long deploymentProjectId, @NotNull PlanResultKey planResultKey, @Nullable com.atlassian.user.User user, @Nullable String versionName, @Nullable String nextVersionName)	Create a deployment version with a specific name.
@NotNull Map<DeploymentVersion,Integer>	findLatestKnownVersionsForEnvironmentsOfDeploymentProject(DeploymentProject deploymentProject)	Find all DeploymentVersion that are currently deployed on environments of a DeploymentProject For each version found give number of environments it is present on.
DeploymentVersion	findNextVersionContainingResult(long deploymentProjectId, @NotNull PlanResultKey planResultKey)	Find the first version that is created from a result which is later than current result (not taking custom revision into account)
@Nullable DeploymentVersion	findPreviousVersion(long deploymentProjectId, long versionId)
static @NotNull Optional<DeploymentVersionState>	findUserRelatedDeploymentVersionStatus(@NotNull List<? extends DeploymentVersionStatus> versionStatuses, @NotNull String userName)
@NotNull Multimap<DeploymentProject,Pair<Long,PlanResultKey>>	findVersionIdentifiersAssociatedWithJiraIssue(@NotNull String issueKey)	Find all the version identifiers that are associated with a JIRA issue, grouped by DeploymentProject Note: this API is in its intermittent form and is subject to change.
@NotNull List<DeploymentVersion>	findVersionsAssociatedWithJiraIssue(long deploymentProjectId, @NotNull String issueKey)	Find all the versions of a DeploymentProject that are associated with a JIRA issue
@NotNull Multimap<DeploymentProject,DeploymentVersion>	findVersionsAssociatedWithJiraIssue(@NotNull String issueKey)	Find all the version that are associated with a JIRA issue, grouped by DeploymentProject
@NotNull List<DeploymentVersion>	findVersionsBetween(long deploymentProjectId, @NotNull DeploymentVersion version1, @NotNull DeploymentVersion version2)	Find versions created between version1 and version2.
@NotNull List<DeploymentVersion>	findVersionsBetweenNoVariables(long deploymentProjectId, @NotNull DeploymentVersion version1, @NotNull DeploymentVersion version2)	Find versions created between version1 and version2.
@NotNull List<DeploymentVersionStatus>	getAllUsersLatestVersionStatusDtosOrderedByCreationDate(long deploymentVersionId)
@NotNull Map<Long,List<DeploymentVersionStatus>>	getAllUsersLatestVersionStatusesOrderedByCreationDate(@NotNull List<Long> deploymentVersionIds)	Find all users' latest version statuses for each version id ordered by creation date.
@NotNull List<DeploymentVersion>	getDeploymentProjectVersions(long deploymentProjectId)	Retrieves the list of all the version for the deployment project, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	getDeploymentProjectVersionsNoVariables(@NotNull DeploymentProject deploymentProject)	Retrieves the list of all the version for the deployment project, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	getDeploymentProjectVersionsNoVariables(@NotNull DeploymentProject deploymentProject, int offset, int maxResults)	Retrieves the list of the version for the deployment project, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts).
@NotNull List<DeploymentVersion>	getDeploymentProjectVersionsNoVariables(@NotNull DeploymentProject deploymentProject, int offset, int maxResults, DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)	Retrieves the list of the version for the deployment project, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts).
@Nullable DeploymentVersion	getDeploymentVersion(long deploymentVersionId)	Get DeploymentVersion by id
@Nullable DeploymentVersion	getDeploymentVersion(@Nullable DeploymentVersionDto dto, @Nullable DeploymentProject project, DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)	Convert a DeploymentVersionDto to a DeploymentVersion.
@Nullable DeploymentVersion	getDeploymentVersionByName(@NotNull String existingVersionName, long deploymentProjectId)	Get a specific version by name
@NotNull String	getEvaluatedVersionName(String nextVersionName, Map<String,VariableDefinitionContext> variables, Set<String> variablesToIncrement)
@NotNull String	getIncrementedVersionName(@NotNull String versionName)	Calculates an increment of a version name.
@Nullable DeploymentVersion	getLatestVersionForProject(long deploymentProjectId)	Find the latest version for a deployment project regardless of branch used to create it.
@Nullable DeploymentVersion	getLatestVersionForProject(long deploymentProjectId, @NotNull PlanKey branchKey)	Find the latest version for a deployment project.
@Nullable DeploymentVersionStatus	getLatestVersionStatus(long deploymentVersionId)
@NotNull Map<Long,DeploymentVersionStatus>	getLatestVersionStatuses(@NotNull List<Long> deploymentVersionIds)	Find a latest version status for each version id.
@NotNull DeploymentVersion	getOrCreateDeploymentVersion(long deploymentProjectId, @NotNull PlanResultKey planResultKey)	Given a build result, find a deployment version that matches it, or create it if it doesn't exist.
@NotNull Map<String,VariableDefinitionContext>	getPossibleVersionVariables(@NotNull ImmutablePlan linkedPlan, boolean includeUndeterminable)	Provides a map of variables which might show up on a version.
@NotNull Map<String,VariableDefinitionContext>	getPossibleVersionVariables(@NotNull ImmutablePlan linkedPlan, @Nullable PlanResultKey planResultKey, boolean includeUndeterminable)	Provides a map of variables which might show up on a version.
@NotNull Set<PlanResultKey>	getRelatedPlanResultKeys(long deploymentVersionId)	Retrieve the PlanResultKeys of ResultSummaries related to a particular DeploymentVersion
@NotNull Map<Long,PlanResultKey>	getRelatedPlanResultKeys(@NotNull Set<Long> deploymentVersionIds)	Retrieve the PlanResultKeys of ResultSummaries related to a particular DeploymentVersions
@Nullable DeploymentVersion	getRelatedVersion(long deploymentProjectId, @NotNull PlanResultKey planResultKey)	Find latest version of a deployment project that is related to specific plan result.
@NotNull Set<String>	getResultPlanKeysHavingDeploymentProjectVersions(long deploymentProjectId)	Returns keys of result plans (branch) that have at least one deployment project version (release)
@NotNull List<VariableSubstitutionContext>	getVariableContextForVersion(@org.jetbrains.annotations.NotNull long deploymentVersionId)	Fetch variable context associated with a version.
@NotNull Multimap<String,Artifact>	getVersionArtifacts(@NotNull DeploymentVersion deploymentVersion)	Find all Artifact related to a version.
String	getVersionNamePreview(ResultsSummary resultsSummary, String versionName)	Given a version name and a result summary, what would the version name look like after substitution.
int	getVersionsCount()	Count all versions
int	getVersionsCountForProject(long deploymentProjectId)	Count versions related to deployment project
int	getVersionsCountForProjectAndBranch(@org.jetbrains.annotations.NotNull long deploymentProjectId, @NotNull PlanKey branchKey)	Count versions related to deployment project and a specified plan branch
boolean	hasVersionsUnrelatedToBranch(long deploymentProjectId, @NotNull PlanKey branchKey)	Test if there are DeploymentVersions in a DeploymentProject that are unrelated to given branch
boolean	isFromTheSameBranch(long firstVersionId, long secondVersionId)	Checks if both deployment versions come from the same branch
boolean	isFromTheSameBranch(String planKey, long versionId)	Checks if the specified build result is on the same branch as the specified version ID
boolean	isVersionNameConflicting(long deploymentProjectId, @NotNull String name)	Check whether the version name is already being used by another version within this project
@NotNull DeploymentVersion	renameVersion(long deploymentProjectId, @NotNull DeploymentVersion deploymentVersion, @NotNull String newVersionName)	Rename a version.
void	resetVersionsAge(@NotNull DeploymentVersion deploymentVersion)	Resets version's age to 0.
@NotNull List<DeploymentVersion>	searchVersionsByBranch(long deploymentProjectId, @NotNull PlanKey branchKey)	Search for deployment versions in a project associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	searchVersionsByBranchAndName(long deploymentProjectId, @NotNull PlanKey branchKey, @NotNull String searchTerm)	Search for deployment versions in a project whose name contains the searchTerm, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	searchVersionsByBranchAndNameNoVariables(@NotNull DeploymentProject deploymentProject, @NotNull PlanKey branchKey, @NotNull String searchTerm)	Search for deployment versions in a project whose name contains the searchTerm and associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	searchVersionsByBranchAndNameNoVariables(@NotNull DeploymentProject deploymentProject, @NotNull PlanKey branchKey, @NotNull String searchTerm, int offset, int maxResults, DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)	Search for deployment versions in a project whose name contains the searchTerm and associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	searchVersionsByBranchNoVariables(@NotNull DeploymentProject deploymentProject, @NotNull PlanKey branchKey)	Search for deployment versions in a project associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	searchVersionsByBranchNoVariables(@NotNull DeploymentProject deploymentProject, @NotNull PlanKey branchKey, int startIndex, int maxResults)	Search for deployment versions in a project associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	searchVersionsByBranchNoVariables(@NotNull DeploymentProject deploymentProject, @NotNull PlanKey branchKey, int startIndex, int maxResults, @NotNull DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)	Search for deployment versions in a project associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	searchVersionsByName(long deploymentProjectId, @NotNull String searchTerm)	Search for deployment versions in a project whose name contains the searchTerm, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	searchVersionsByNameNoVariables(@NotNull DeploymentProject deploymentProject, @NotNull String searchTerm)	Search for deployment versions in a project whose name contains the searchTerm, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
@NotNull List<DeploymentVersion>	searchVersionsByNameNoVariables(@NotNull DeploymentProject deploymentProject, @NotNull String searchTerm, int offset, int maxResults, @NotNull DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)	Search for deployment versions in a project whose name contains the searchTerm, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)
void	updatePlanKey(@NotNull PlanKey originalPlanKey, @NotNull PlanKey newPlanKey)	Update planKey in DeploymentVersion's related entities when plan key has changed (ie after moving plan)
void	updateVersionsForResult(@NotNull PlanResultKey planResultKey)	Update related versions data (artifacts and variables) after a chain stage has been completed.
@NotNull DeploymentVersionStatus	updateVersionStatus(long deploymentVersionId, @NotNull DeploymentVersionState status, @NotNull String userName)	Updates the version status for given deployment version.
@NotNull ErrorCollection	validateCreateDeploymentVersion(long deploymentProjectId, @NotNull PlanResultKey planResultKey, @Nullable String name, @Nullable String nextVersionName)	Validates values to be used for creating a new version.
@NotNull ErrorCollection	validateDeploymentVersionRename(long deploymentProjectId, @NotNull DeploymentVersion deploymentVersion, @Nullable String name)	Validates values to be used for renaming version.

Methods inherited from class java.lang.Object

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

Constructor Details

DeploymentVersionServiceImpl

public DeploymentVersionServiceImpl(@NotNull
 @NotNull DeploymentProjectDao deploymentProjectDao,
 @NotNull
 @NotNull DeploymentVersionDao deploymentVersionDao,
 @NotNull
 @NotNull InternalResultsSummaryAccessor internalResultsSummaryAccessor,
 @NotNull
 @NotNull DeploymentVersionChainResultDataCollector deploymentVersionChainResultDataCollector,
 @NotNull
 @NotNull com.opensymphony.xwork2.TextProvider textProvider,
 @NotNull
 @NotNull BambooUserManager bambooUserService,
 @NotNull
 @NotNull VariableDefinitionManager variableDefinitionManager,
 @NotNull
 @NotNull VariableDefinitionFactory variableDefinitionFactory,
 @NotNull
 @NotNull CustomVariableContext customVariableContext,
 @NotNull
 @NotNull com.atlassian.event.api.EventPublisher eventPublisher,
 @NotNull
 @NotNull CachedPlanManager cachedPlanManager,
 @NotNull
 @NotNull ScopedExclusionService scopedExclusionService,
 @NotNull
 @NotNull ResultsSummaryVariableAccessor resultsSummaryVariableAccessor,
 @NotNull
 @NotNull RepositoryDefinitionManager repositoryDefinitionManager,
 @NotNull
 @NotNull VcsRepositoryManager vcsRepositoryManager,
 @NotNull
 @NotNull BambooCachingPermissionManagerFacadeFactory bambooCachingPermissionManagerFacadeFactory,
 @NotNull
 @NotNull ArtifactLinkManager artifactLinkManager,
 @NotNull
 @NotNull AuditLogService auditLogService)

Method Details

validateDeploymentVersionRename

@NotNull
public @NotNull ErrorCollection validateDeploymentVersionRename(long deploymentProjectId,
 @NotNull
 @NotNull DeploymentVersion deploymentVersion,
 @Nullable
 @Nullable String name)

Description copied from interface: DeploymentVersionService

Validates values to be used for renaming version.

Specified by:

validateDeploymentVersionRename in interface DeploymentVersionService

Returns:

errorCollection containing any errors found. If no errors, an empty errorCollection will be returned.

renameVersion

@NotNull
public @NotNull DeploymentVersion renameVersion(long deploymentProjectId,
 @NotNull
 @NotNull DeploymentVersion deploymentVersion,
 @NotNull
 @NotNull String newVersionName)
                                         throws WebValidationException

Description copied from interface: DeploymentVersionService

Rename a version.

Specified by:

renameVersion in interface DeploymentVersionService

Returns:

deploymentVersion with the name changed

Throws:

WebValidationException

validateCreateDeploymentVersion

@NotNull
public @NotNull ErrorCollection validateCreateDeploymentVersion(long deploymentProjectId,
 @NotNull
 @NotNull PlanResultKey planResultKey,
 @Nullable
 @Nullable String name,
 @Nullable
 @Nullable String nextVersionName)

Description copied from interface: DeploymentVersionService

Validates values to be used for creating a new version.

Specified by:

validateCreateDeploymentVersion in interface DeploymentVersionService

Parameters:

deploymentProjectId - id of the deployment project

planResultKey - key of the build result on which this version is created

name - version name

nextVersionName - name of the next version

Returns:

errorCollection containing any errors found. If no errors, an empty errorCollection will be returned.

isVersionNameConflicting

public boolean isVersionNameConflicting(long deploymentProjectId,
 @NotNull
 @NotNull String name)

Description copied from interface: DeploymentVersionService

Check whether the version name is already being used by another version within this project

Specified by:

isVersionNameConflicting in interface DeploymentVersionService

Parameters:

deploymentProjectId - project to filter by

name - to check

Returns:

true if name is already being used.

getOrCreateDeploymentVersion

@NotNull
public @NotNull DeploymentVersion getOrCreateDeploymentVersion(long deploymentProjectId,
 @NotNull
 @NotNull PlanResultKey planResultKey)
                                                        throws WebValidationException

Description copied from interface: DeploymentVersionService

Given a build result, find a deployment version that matches it, or create it if it doesn't exist. Uses automatic naming.

Specified by:

getOrCreateDeploymentVersion in interface DeploymentVersionService

Parameters:

deploymentProjectId - of project to create version for

planResultKey - of the result to pull artifacts from

Returns:

deployment version

Throws:

WebValidationException

updateVersionsForResult

public void updateVersionsForResult(@NotNull
 @NotNull PlanResultKey planResultKey)

Description copied from interface: DeploymentVersionService

Update related versions data (artifacts and variables) after a chain stage has been completed.

Specified by:

updateVersionsForResult in interface DeploymentVersionService

createDeploymentVersion

@NotNull
public @NotNull DeploymentVersion createDeploymentVersion(long deploymentProjectId,
 @NotNull
 @NotNull PlanResultKey planResultKey)
                                                   throws WebValidationException

Description copied from interface: DeploymentVersionService

Create a deployment version out of a deployment project and plan result. Automatic naming

Specified by:

createDeploymentVersion in interface DeploymentVersionService

Parameters:

deploymentProjectId - of project to create version for

planResultKey - of the result to pull artifacts from

Returns:

created Deployment Version

Throws:

WebValidationException

createDeploymentVersion

@NotNull
public @NotNull DeploymentVersion createDeploymentVersion(long deploymentProjectId,
 @NotNull
 @NotNull PlanResultKey planResultKey,
 @Nullable
 @Nullable com.atlassian.user.User user,
 @Nullable
 @Nullable String versionName,
 @Nullable
 @Nullable String nextVersionName)
                                                   throws WebValidationException

Description copied from interface: DeploymentVersionService

Create a deployment version with a specific name. From deployment project and plan result. Assumes validation of name has been done.

Specified by:

createDeploymentVersion in interface DeploymentVersionService

Parameters:

deploymentProjectId - project the version is getting created for

planResultKey - of the result to pull artifacts from

user - the person who is creating this version

versionName - name for the version to create

nextVersionName - the name for the next version (to be updated in version naming scheme)

Returns:

created Deployment Version.

Throws:

WebValidationException

getVariableContextForVersion

@NotNull
public @NotNull List<VariableSubstitutionContext> getVariableContextForVersion(@NotNull
 @org.jetbrains.annotations.NotNull long deploymentVersionId)

Description copied from interface: DeploymentVersionService

Fetch variable context associated with a version.

Specified by:

getVariableContextForVersion in interface DeploymentVersionService

getVersionNamePreview

public String getVersionNamePreview(ResultsSummary resultsSummary,
 String versionName)

Description copied from interface: DeploymentVersionService

Given a version name and a result summary, what would the version name look like after substitution. Does not check/mutate for uniqueness.

Specified by:

getVersionNamePreview in interface DeploymentVersionService

Parameters:

resultsSummary - the version would get created from

versionName - the potential name of the version

Returns:

substituted version name

resetVersionsAge

public void resetVersionsAge(@NotNull
 @NotNull DeploymentVersion deploymentVersion)

Description copied from interface: DeploymentVersionService

Resets version's age to 0.

Specified by:

resetVersionsAge in interface DeploymentVersionService

getPossibleVersionVariables

@NotNull
public @NotNull Map<String,VariableDefinitionContext> getPossibleVersionVariables(@NotNull
 @NotNull ImmutablePlan linkedPlan,
 boolean includeUndeterminable)

Description copied from interface: DeploymentVersionService

Provides a map of variables which might show up on a version.

Specified by:

getPossibleVersionVariables in interface DeploymentVersionService

Parameters:

linkedPlan - plan the deployment project is linked to

includeUndeterminable - if true include variables that we don't currently know the value, with a nice example (used for display purposes)

Returns:

a map of variables which might show up on a version.

getPossibleVersionVariables

@NotNull
public @NotNull Map<String,VariableDefinitionContext> getPossibleVersionVariables(@NotNull
 @NotNull ImmutablePlan linkedPlan,
 @Nullable
 @Nullable PlanResultKey planResultKey,
 boolean includeUndeterminable)

Description copied from interface: DeploymentVersionService

Provides a map of variables which might show up on a version.

Specified by:

getPossibleVersionVariables in interface DeploymentVersionService

Parameters:

linkedPlan - plan the deployment project is linked to

planResultKey - resultKey for result variables context

includeUndeterminable - if true include variables that we don't currently know the value, with a nice example (used for display purposes)

Returns:

a map of variables which might show up on a version.

getDeploymentVersion

@Nullable
public @Nullable DeploymentVersion getDeploymentVersion(long deploymentVersionId)

Description copied from interface: DeploymentVersionService

Get DeploymentVersion by id

Specified by:

getDeploymentVersion in interface DeploymentVersionService

getDeploymentVersion

@Nullable
@Internal
public @Nullable DeploymentVersion getDeploymentVersion(@Nullable
 @Nullable DeploymentVersionDto dto,
 @Nullable
 @Nullable DeploymentProject project,
 @NotNull
 DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)
                                                 throws org.acegisecurity.AccessDeniedException

Description copied from interface: DeploymentVersionDtoManager

Convert a DeploymentVersionDto to a DeploymentVersion.

Specified by:

getDeploymentVersion in interface DeploymentVersionDtoManager

Throws:

org.acegisecurity.AccessDeniedException - if the DeploymentVersion is inaccessible to the current user, but also marks the current transaction as rollback-only

getResultPlanKeysHavingDeploymentProjectVersions

@NotNull
public @NotNull Set<String> getResultPlanKeysHavingDeploymentProjectVersions(long deploymentProjectId)

Description copied from interface: DeploymentVersionService

Returns keys of result plans (branch) that have at least one deployment project version (release)

Specified by:

getResultPlanKeysHavingDeploymentProjectVersions in interface DeploymentVersionService

Parameters:

deploymentProjectId - id of the deployment project

Returns:

getDeploymentProjectVersions

@NotNull
public @NotNull List<DeploymentVersion> getDeploymentProjectVersions(long deploymentProjectId)

Description copied from interface: DeploymentVersionService

Retrieves the list of all the version for the deployment project, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

This method fetches complete version data, DeploymentVersionService.getDeploymentProjectVersionsNoVariables(DeploymentProject) should be preferred when variable data is not required, e.g. for displaying list of version in the UI.

Specified by:

getDeploymentProjectVersions in interface DeploymentVersionService

Parameters:

deploymentProjectId - id of the deployment project

Returns:

all the versions for the specified deployment project. Empty list if deployment project not found or if there is no versions for it.

getDeploymentProjectVersionsNoVariables

@NotNull
public @NotNull List<DeploymentVersion> getDeploymentProjectVersionsNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject)

Description copied from interface: DeploymentVersionService

Retrieves the list of all the version for the deployment project, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

Specified by:

getDeploymentProjectVersionsNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project

Returns:

all the versions for the specified deployment project. Empty list if deployment project not found or if there is no versions for it.

getDeploymentProjectVersionsNoVariables

@NotNull
public @NotNull List<DeploymentVersion> getDeploymentProjectVersionsNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject,
 int offset,
 int maxResults)

Description copied from interface: DeploymentVersionService

Retrieves the list of the version for the deployment project, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts).

Specified by:

getDeploymentProjectVersionsNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project

offset - number of results to skip

maxResults - maximum length of the returned list

Returns:

the versions for the specified deployment project. Empty list if deployment project not found or if there is no versions for it.

getDeploymentProjectVersionsNoVariables

@NotNull
public @NotNull List<DeploymentVersion> getDeploymentProjectVersionsNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject,
 int offset,
 int maxResults,
 @NotNull
 DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)

Description copied from interface: DeploymentVersionService

Retrieves the list of the version for the deployment project, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts).

Specified by:

getDeploymentProjectVersionsNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project

offset - number of results to skip

maxResults - maximum length of the returned list

deploymentVersionNeededAttributes - specify whether certain attributes will be loaded or not.

Returns:

the versions for the specified deployment project. Empty list if deployment project not found or if there is no versions for it.

getLatestVersionForProject

@Nullable
public @Nullable DeploymentVersion getLatestVersionForProject(long deploymentProjectId)

Description copied from interface: DeploymentVersionService

Find the latest version for a deployment project regardless of branch used to create it. Comparison based on creation date.

Specified by:

getLatestVersionForProject in interface DeploymentVersionService

Parameters:

deploymentProjectId - of the deployment project

Returns:

the latest version for a deployment project

getLatestVersionForProject

@Nullable
public @Nullable DeploymentVersion getLatestVersionForProject(long deploymentProjectId,
 @NotNull
 @NotNull PlanKey branchKey)

Description copied from interface: DeploymentVersionService

Find the latest version for a deployment project. Comparison based on creation date.

Specified by:

getLatestVersionForProject in interface DeploymentVersionService

Parameters:

deploymentProjectId - of the deployment project

branchKey - key of the PlanBranch

Returns:

the latest version created for a branch for a deployment project

getDeploymentVersionByName

@Nullable
public @Nullable DeploymentVersion getDeploymentVersionByName(@NotNull
 @NotNull String existingVersionName,
 long deploymentProjectId)

Description copied from interface: DeploymentVersionService

Get a specific version by name

Specified by:

getDeploymentVersionByName in interface DeploymentVersionService

Parameters:

existingVersionName - name of the version

Returns:

the Deployment version with given name if found, otherwise null.

searchVersionsByName

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByName(long deploymentProjectId,
 @NotNull
 @NotNull String searchTerm)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project whose name contains the searchTerm, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

This method fetches complete version data, DeploymentVersionService.searchVersionsByNameNoVariables(DeploymentProject, String) should be preferred when variable data is not required, e.g. for displaying list of version in the UI.

Specified by:

searchVersionsByName in interface DeploymentVersionService

Parameters:

deploymentProjectId - deployment project to search within

searchTerm - term to look for.

Returns:

list of Deployment Versions matching the search criteria

searchVersionsByBranch

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByBranch(long deploymentProjectId,
 @NotNull
 @NotNull PlanKey branchKey)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

This method fetches complete version data, DeploymentVersionService.searchVersionsByBranchNoVariables(DeploymentProject, PlanKey) should be preferred when variable data is not required, e.g. for displaying list of version in the UI.

Specified by:

searchVersionsByBranch in interface DeploymentVersionService

Parameters:

deploymentProjectId - deployment project to search within

branchKey - plan branch to narrow search result

Returns:

list of Deployment Versions matching the search criteria

searchVersionsByBranchAndName

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByBranchAndName(long deploymentProjectId,
 @NotNull
 @NotNull PlanKey branchKey,
 @NotNull
 @NotNull String searchTerm)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project whose name contains the searchTerm, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

This method fetches complete version data, DeploymentVersionService.searchVersionsByBranchAndNameNoVariables(DeploymentProject, PlanKey, String) should be preferred when variable data is not required, e.g. for displaying list of version in the UI.

Specified by:

searchVersionsByBranchAndName in interface DeploymentVersionService

Parameters:

deploymentProjectId - deployment project to search within

branchKey - plan branch to narrow search result

searchTerm - term to look for.

Returns:

list of Deployment Versions matching the search criteria

searchVersionsByNameNoVariables

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByNameNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject,
 @NotNull
 @NotNull String searchTerm)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project whose name contains the searchTerm, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

Specified by:

searchVersionsByNameNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project to search within

searchTerm - term to look for.

Returns:

list of Deployment Versions matching the search criteria

searchVersionsByNameNoVariables

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByNameNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject,
 @NotNull
 @NotNull String searchTerm,
 int offset,
 int maxResults,
 @NotNull
 @NotNull DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project whose name contains the searchTerm, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

Specified by:

searchVersionsByNameNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project to search within

searchTerm - term to look for.

offset - number of results to skip

maxResults - maximum length of the returned list

deploymentVersionNeededAttributes - specify whether certain attributes will be loaded or not.

Returns:

list of Deployment Versions matching the search criteria

searchVersionsByBranchNoVariables

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByBranchNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject,
 @NotNull
 @NotNull PlanKey branchKey)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

Specified by:

searchVersionsByBranchNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project to search within

branchKey - plan branch to narrow search result

Returns:

list of Deployment Versions matching the search criteria

searchVersionsByBranchNoVariables

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByBranchNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject,
 @NotNull
 @NotNull PlanKey branchKey,
 int startIndex,
 int maxResults)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

Specified by:

searchVersionsByBranchNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project to search within

branchKey - plan branch to narrow search result

Returns:

list of Deployment Versions matching the search criteria

searchVersionsByBranchNoVariables

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByBranchNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject,
 @NotNull
 @NotNull PlanKey branchKey,
 int startIndex,
 int maxResults,
 @NotNull
 @NotNull DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

Specified by:

searchVersionsByBranchNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project to search within

branchKey - plan branch to narrow search result

startIndex - number of results to skip

maxResults - maximum length of the returned list

deploymentVersionNeededAttributes - specify whether certain attributes will be loaded or not.

Returns:

list of Deployment Versions matching the search criteria

searchVersionsByBranchAndNameNoVariables

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByBranchAndNameNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject,
 @NotNull
 @NotNull PlanKey branchKey,
 @NotNull
 @NotNull String searchTerm)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project whose name contains the searchTerm and associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

Specified by:

searchVersionsByBranchAndNameNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project to search within

branchKey - plan branch to narrow search result

searchTerm - term to look for.

Returns:

list of Deployment Versions matching the search criteria

searchVersionsByBranchAndNameNoVariables

@NotNull
public @NotNull List<DeploymentVersion> searchVersionsByBranchAndNameNoVariables(@NotNull
 @NotNull DeploymentProject deploymentProject,
 @NotNull
 @NotNull PlanKey branchKey,
 @NotNull
 @NotNull String searchTerm,
 int offset,
 int maxResults,
 @NotNull
 DeploymentVersionService.DeploymentVersionNeededAttributes deploymentVersionNeededAttributes)

Description copied from interface: DeploymentVersionService

Search for deployment versions in a project whose name contains the searchTerm and associated with a specific branch, sorted by CreationDate (the most recent Deployment Versions will be returned as firsts)

Specified by:

searchVersionsByBranchAndNameNoVariables in interface DeploymentVersionService

Parameters:

deploymentProject - deployment project to search within

branchKey - plan branch to narrow search result

searchTerm - term to look for.

offset - number of results to skip

maxResults - maximum length of the returned list

deploymentVersionNeededAttributes - specify whether certain attributes will be loaded or not.

Returns:

list of Deployment Versions matching the search criteria

getVersionsCount

public int getVersionsCount()

Description copied from interface: DeploymentVersionService

Count all versions

Specified by:

getVersionsCount in interface DeploymentVersionService

Returns:

number of versions created in all deployment projects

getVersionsCountForProject

public int getVersionsCountForProject(long deploymentProjectId)

Description copied from interface: DeploymentVersionService

Count versions related to deployment project

Specified by:

getVersionsCountForProject in interface DeploymentVersionService

Parameters:

deploymentProjectId - id of deployment project

Returns:

number of versions created in deployment project

getVersionsCountForProjectAndBranch

public int getVersionsCountForProjectAndBranch(@NotNull
 @org.jetbrains.annotations.NotNull long deploymentProjectId,
 @NotNull
 @NotNull PlanKey branchKey)

Description copied from interface: DeploymentVersionService

Count versions related to deployment project and a specified plan branch

Specified by:

getVersionsCountForProjectAndBranch in interface DeploymentVersionService

Parameters:

deploymentProjectId - id of deployment project

branchKey - plan branch key

Returns:

number of versions created in deployment project

getRelatedPlanResultKeys

@NotNull
public @NotNull Set<PlanResultKey> getRelatedPlanResultKeys(long deploymentVersionId)

Description copied from interface: DeploymentVersionService

Retrieve the PlanResultKeys of ResultSummaries related to a particular DeploymentVersion

Specified by:

getRelatedPlanResultKeys in interface DeploymentVersionService

getRelatedPlanResultKeys

@NotNull
public @NotNull Map<Long,PlanResultKey> getRelatedPlanResultKeys(@NotNull
 @NotNull Set<Long> deploymentVersionIds)

Description copied from interface: DeploymentVersionService

Retrieve the PlanResultKeys of ResultSummaries related to a particular DeploymentVersions

Specified by:

getRelatedPlanResultKeys in interface DeploymentVersionService

isFromTheSameBranch

public boolean isFromTheSameBranch(long firstVersionId,
 long secondVersionId)

Description copied from interface: DeploymentVersionService

Checks if both deployment versions come from the same branch

Specified by:

isFromTheSameBranch in interface DeploymentVersionService

Parameters:

firstVersionId - first deployment version

secondVersionId - second deployment version

Returns:

isFromTheSameBranch

public boolean isFromTheSameBranch(String planKey,
 long versionId)

Description copied from interface: DeploymentVersionService

Checks if the specified build result is on the same branch as the specified version ID

Specified by:

isFromTheSameBranch in interface DeploymentVersionService

Parameters:

planKey - the planKey of the build result you want to compare

versionId - the version ID of the version you want to compare

Returns:

getLatestVersionStatus

@Nullable
public @Nullable DeploymentVersionStatus getLatestVersionStatus(long deploymentVersionId)

Specified by:

getLatestVersionStatus in interface DeploymentVersionService

getAllUsersLatestVersionStatusDtosOrderedByCreationDate

@NotNull
public @NotNull List<DeploymentVersionStatus> getAllUsersLatestVersionStatusDtosOrderedByCreationDate(long deploymentVersionId)

Specified by:

getAllUsersLatestVersionStatusDtosOrderedByCreationDate in interface DeploymentVersionService

Returns:

all users' version statuses for the requested deploymentVersionId.

getLatestVersionStatuses

@NotNull
public @NotNull Map<Long,DeploymentVersionStatus> getLatestVersionStatuses(@NotNull
 @NotNull List<Long> deploymentVersionIds)

Description copied from interface: DeploymentVersionService

Find a latest version status for each version id. If no version status is available, the resulting map will not contain corresponding entry.

Specified by:

getLatestVersionStatuses in interface DeploymentVersionService

getAllUsersLatestVersionStatusesOrderedByCreationDate

@NotNull
public @NotNull Map<Long,List<DeploymentVersionStatus>> getAllUsersLatestVersionStatusesOrderedByCreationDate(@NotNull
 @NotNull List<Long> deploymentVersionIds)

Description copied from interface: DeploymentVersionService

Find all users' latest version statuses for each version id ordered by creation date. If no version status is available, the resulting map will contain empty list.

Specified by:

getAllUsersLatestVersionStatusesOrderedByCreationDate in interface DeploymentVersionService

updateVersionStatus

@NotNull
public @NotNull DeploymentVersionStatus updateVersionStatus(long deploymentVersionId,
 @NotNull
 @NotNull DeploymentVersionState status,
 @NotNull
 @NotNull String userName)

Description copied from interface: DeploymentVersionService

Updates the version status for given deployment version.

Specified by:

updateVersionStatus in interface DeploymentVersionService

findVersionsBetween

@NotNull
public @NotNull List<DeploymentVersion> findVersionsBetween(long deploymentProjectId,
 @NotNull
 @NotNull DeploymentVersion version1,
 @NotNull
 @NotNull DeploymentVersion version2)

Description copied from interface: DeploymentVersionService

Find versions created between version1 and version2. The versions must be different but belong to the same DeploymentProject The order of the argument is irrelevant: the method will determine which of the versions is the lower bound. Lower bound is not included in result but upper bound is. The result is sorted by creation date (newest first)

Specified by:

findVersionsBetween in interface DeploymentVersionService

findVersionsBetweenNoVariables

@NotNull
public @NotNull List<DeploymentVersion> findVersionsBetweenNoVariables(long deploymentProjectId,
 @NotNull
 @NotNull DeploymentVersion version1,
 @NotNull
 @NotNull DeploymentVersion version2)

Description copied from interface: DeploymentVersionService

Find versions created between version1 and version2. The versions must be different but belong to the same DeploymentProject The order of the argument is irrelevant: the method will determine which of the versions is the lower bound. Lower bound is not included in result but upper bound is. The result is sorted by creation date (newest first)

Specified by:

findVersionsBetweenNoVariables in interface DeploymentVersionService

findPreviousVersion

@Nullable
public @Nullable DeploymentVersion findPreviousVersion(long deploymentProjectId,
 long versionId)

Specified by:

findPreviousVersion in interface DeploymentVersionService

getVersionArtifacts

@NotNull
public @NotNull Multimap<String,Artifact> getVersionArtifacts(@NotNull
 @NotNull DeploymentVersion deploymentVersion)

Description copied from interface: DeploymentVersionService

Find all Artifact related to a version.

Specified by:

getVersionArtifacts in interface DeploymentVersionService

Returns:

getRelatedVersion

@Nullable
public @Nullable DeploymentVersion getRelatedVersion(long deploymentProjectId,
 @NotNull
 @NotNull PlanResultKey planResultKey)

Description copied from interface: DeploymentVersionService

Find latest version of a deployment project that is related to specific plan result.

Specified by:

getRelatedVersion in interface DeploymentVersionService

Returns:

findNextVersionContainingResult

public DeploymentVersion findNextVersionContainingResult(long deploymentProjectId,
 @NotNull
 @NotNull PlanResultKey planResultKey)

Description copied from interface: DeploymentVersionService

Find the first version that is created from a result which is later than current result (not taking custom revision into account)

Specified by:

findNextVersionContainingResult in interface DeploymentVersionService

Returns:

getIncrementedVersionName

@NotNull
public @NotNull String getIncrementedVersionName(@NotNull
 @NotNull String versionName)

Description copied from interface: DeploymentVersionService

Calculates an increment of a version name. Increments last number in the name. If nothing found to increment will return passed in value.

Specified by:

getIncrementedVersionName in interface DeploymentVersionService

Parameters:

versionName - to increment

Returns:

incremented version name.

getEvaluatedVersionName

@NotNull
public @NotNull String getEvaluatedVersionName(String nextVersionName,
 Map<String,VariableDefinitionContext> variables,
 Set<String> variablesToIncrement)

Specified by:

getEvaluatedVersionName in interface DeploymentVersionService

Returns:

updatePlanKey

public void updatePlanKey(@NotNull
 @NotNull PlanKey originalPlanKey,
 @NotNull
 @NotNull PlanKey newPlanKey)

Description copied from interface: DeploymentVersionService

Update planKey in DeploymentVersion's related entities when plan key has changed (ie after moving plan)

Specified by:

updatePlanKey in interface DeploymentVersionService

Parameters:

originalPlanKey - original PlanKey

newPlanKey - new PlanKey

findVersionsAssociatedWithJiraIssue

@NotNull
public @NotNull List<DeploymentVersion> findVersionsAssociatedWithJiraIssue(long deploymentProjectId,
 @NotNull
 @NotNull String issueKey)

Description copied from interface: DeploymentVersionService

Find all the versions of a DeploymentProject that are associated with a JIRA issue

Specified by:

findVersionsAssociatedWithJiraIssue in interface DeploymentVersionService

findVersionsAssociatedWithJiraIssue

@NotNull
public @NotNull Multimap<DeploymentProject,DeploymentVersion> findVersionsAssociatedWithJiraIssue(@NotNull
 @NotNull String issueKey)

Description copied from interface: DeploymentVersionService

Find all the version that are associated with a JIRA issue, grouped by DeploymentProject

Specified by:

findVersionsAssociatedWithJiraIssue in interface DeploymentVersionService

findVersionIdentifiersAssociatedWithJiraIssue

@NotNull
public @NotNull Multimap<DeploymentProject,Pair<Long,PlanResultKey>> findVersionIdentifiersAssociatedWithJiraIssue(@NotNull
 @NotNull String issueKey)

Description copied from interface: DeploymentVersionService

Find all the version identifiers that are associated with a JIRA issue, grouped by DeploymentProject Note: this API is in its intermittent form and is subject to change.

Specified by:

findVersionIdentifiersAssociatedWithJiraIssue in interface DeploymentVersionService

findLatestKnownVersionsForEnvironmentsOfDeploymentProject

@NotNull
public @NotNull Map<DeploymentVersion,Integer> findLatestKnownVersionsForEnvironmentsOfDeploymentProject(DeploymentProject deploymentProject)

Description copied from interface: DeploymentVersionService

Find all DeploymentVersion that are currently deployed on environments of a DeploymentProject For each version found give number of environments it is present on.

Specified by:

findLatestKnownVersionsForEnvironmentsOfDeploymentProject in interface DeploymentVersionService

Returns:

hasVersionsUnrelatedToBranch

public boolean hasVersionsUnrelatedToBranch(long deploymentProjectId,
 @NotNull
 @NotNull PlanKey branchKey)

Description copied from interface: DeploymentVersionService

Test if there are DeploymentVersions in a DeploymentProject that are unrelated to given branch

Specified by:

hasVersionsUnrelatedToBranch in interface DeploymentVersionService

Parameters:

deploymentProjectId - identifies deployment project

branchKey - key of the branch

Returns:

true if there are versions in the project that are unrelated to branch

findUserRelatedDeploymentVersionStatus

@NotNull
public static @NotNull Optional<DeploymentVersionState> findUserRelatedDeploymentVersionStatus(@NotNull
 @NotNull List<? extends DeploymentVersionStatus> versionStatuses,
 @NotNull
 @NotNull String userName)