com.atlassian.bamboo.deployments.projects.persistence

Interface DeploymentProjectDao

All Known Implementing Classes:

DeploymentProjectDaoImpl

@Internal
public interface DeploymentProjectDao

Method Summary

Modifier and Type	Method and Description
long	countAllDeploymentProjects()
MutableDeploymentProject	createNewDeploymentProjectInstance()
MutableVersionNamingScheme	createNewVersionNamingSchemeInstance()
void	delete(MutableDeploymentProject deploymentProject) Delete DeploymentProject and related DeploymentProjectItems
void	delete(MutableDeploymentProjectItem deploymentProjectItem) Delete DeploymentProjectItem
void	delete(MutableVersionNamingScheme versionNamingScheme) Delete the version naming Scheme
boolean	doesArtifactProjectItemExist(long deploymentProjectId, long artifactId) Check for existence of DeploymentProjectItem by DB id of the DeploymentProject and ArtifactDefinition
MutableDeploymentProject	findDeploymentProjectByName(String name)
MutableDeploymentProject	findDeploymentProjectByOid(BambooEntityOid oid)
Collection<Long>	findDeploymentProjectsInOtherStates(VcsLocationBambooSpecsState specsState)
List<MutableDeploymentProject>	findDeploymentProjectsRelatedToArtifact(long artifactId)
Set<Long>	findSpecsStateIdsReferencedByDeployments()
List<MutableDeploymentProject>	getAllDeploymentProjects()
List<MutableDeploymentProject>	getAllDeploymentProjects(int firstResult, int maxResults)
MutableDeploymentProjectItem	getArtifactProjectItem(long deploymentProjectId, long artifactId) Get DeploymentProjectItem by DB id of the DeploymentProject and ArtifactDefinition
MutableDeploymentProject	getDeploymentProject(DeploymentKey key) Get DeploymentProject by key
MutableDeploymentProject	getDeploymentProject(long deploymentProjectId) Get DeploymentProject by DB id
int	getDeploymentProjectCount()
MutableDeploymentProject	getDeploymentProjectForEnvironment(long environmentId) Get DeploymentProject associated with Environment
MutableDeploymentProject	getDeploymentProjectForVersion(long versionId) Get DeploymentProject associated with Version
List<MutableDeploymentProject>	getDeploymentProjectsReferencingArtifact(long artifactId) Get all deployment projects that contain a version that uses specified artifact
List<MutableDeploymentProject>	getDeploymentProjectsRelatedToPlan(PlanKey planKey) Get DeploymentProjects linked to Plan with planKey.
List<MutableDeploymentProject>	getDeploymentProjectsRelatedToPlans(Set<PlanKey> planKeyFamily) Get DeploymentProjects linked to Plan identified with any of plan keys.
BambooEntityOid	getMaxDeploymentProjectOid(int serverKey)
List<Pair<MutableDeploymentProject,MutableEnvironment>>	getPaginatedDeploymentsWithEnvironments(int start, int limit, String filter) Retrieves paginated list of pairs of MutableDeploymentProject and MutableEnvironment ordered by InternalDeploymentProject.getName() and InternalEnvironment.getPosition()
MutableDeploymentProjectItem	getProjectItem(long deploymentProjectItemId) Get DeploymentProjectItem by DB id
List<MutableDeploymentProjectItem>	getProjectItems(long deploymentProjectId) Get list of DeploymentProject items
MutableVersionNamingScheme	getVersionNamingSchemeForProject(long projectId) Get the version naming configuration for a specific project
boolean	isDeploymentProjectNameConflicting(String name) Deployment Project Names need to be unique within the system.
void	removeAbstractProjectItems()
void	save(MutableDeploymentProject deploymentProject) Save DeploymentProject
void	save(MutableDeploymentProjectItem deploymentProjectItem) Save DeploymentProjectItem
void	save(MutableVersionNamingScheme versionNamingScheme) Save the version naming Scheme

Method Detail

countAllDeploymentProjects

long countAllDeploymentProjects()

Returns:

number of deployment projects in the system

getAllDeploymentProjects

@NotNull
List<MutableDeploymentProject> getAllDeploymentProjects()

Returns:

list of all DeploymentProjects

getAllDeploymentProjects

@NotNull
List<MutableDeploymentProject> getAllDeploymentProjects(int firstResult,
                                                                 int maxResults)

Returns:

paginated list of deployment projects, firstResult starts from 0

getDeploymentProjectsRelatedToPlan

@NotNull
List<MutableDeploymentProject> getDeploymentProjectsRelatedToPlan(@NotNull
                                                                           PlanKey planKey)

Get DeploymentProjects linked to Plan with planKey. This method will not perform any master-branch matching, returned DeploymentProjects will be linked to exact planKey regardless if it identifies master plan or branch.

Parameters:

planKey - of the linked Plan

getDeploymentProjectsRelatedToPlans

@NotNull
List<MutableDeploymentProject> getDeploymentProjectsRelatedToPlans(@NotNull
                                                                            Set<PlanKey> planKeyFamily)

Get DeploymentProjects linked to Plan identified with any of plan keys.

Parameters:

planKeyFamily - set of plan keys, usually it is set of all branch keys + master plan key

findDeploymentProjectsRelatedToArtifact

@NotNull
List<MutableDeploymentProject> findDeploymentProjectsRelatedToArtifact(long artifactId)

getDeploymentProject

@Nullable
MutableDeploymentProject getDeploymentProject(long deploymentProjectId)

Get DeploymentProject by DB id

getDeploymentProject

@Nullable
MutableDeploymentProject getDeploymentProject(@NotNull
                                                        DeploymentKey key)

Get DeploymentProject by key

save

void save(MutableDeploymentProject deploymentProject)

Save DeploymentProject

delete

void delete(MutableDeploymentProject deploymentProject)

Delete DeploymentProject and related DeploymentProjectItems

getProjectItems

@NotNull
List<MutableDeploymentProjectItem> getProjectItems(long deploymentProjectId)

Get list of DeploymentProject items

getProjectItem

@Nullable
MutableDeploymentProjectItem getProjectItem(long deploymentProjectItemId)

Get DeploymentProjectItem by DB id

getArtifactProjectItem

@Nullable
MutableDeploymentProjectItem getArtifactProjectItem(long deploymentProjectId,
                                                              long artifactId)

Get DeploymentProjectItem by DB id of the DeploymentProject and ArtifactDefinition

doesArtifactProjectItemExist

boolean doesArtifactProjectItemExist(long deploymentProjectId,
                                     long artifactId)

Check for existence of DeploymentProjectItem by DB id of the DeploymentProject and ArtifactDefinition

save

void save(MutableDeploymentProjectItem deploymentProjectItem)

Save DeploymentProjectItem

delete

void delete(MutableDeploymentProjectItem deploymentProjectItem)

Delete DeploymentProjectItem

isDeploymentProjectNameConflicting

boolean isDeploymentProjectNameConflicting(@NotNull
                                           String name)

Deployment Project Names need to be unique within the system. This method checks if a name is already being used

Parameters:

name - to check

Returns:

true if the name is already being used, otherwise false.

getDeploymentProjectForEnvironment

@Nullable
MutableDeploymentProject getDeploymentProjectForEnvironment(long environmentId)

Get DeploymentProject associated with Environment

Parameters:

environmentId - Environment id

getDeploymentProjectForVersion

@Nullable
MutableDeploymentProject getDeploymentProjectForVersion(long versionId)

Get DeploymentProject associated with Version

Parameters:

versionId - Version id

getVersionNamingSchemeForProject

@Nullable
MutableVersionNamingScheme getVersionNamingSchemeForProject(long projectId)

Get the version naming configuration for a specific project

Parameters:

projectId - of the project

save

void save(MutableVersionNamingScheme versionNamingScheme)

Save the version naming Scheme

Parameters:

versionNamingScheme - to save

delete

void delete(MutableVersionNamingScheme versionNamingScheme)

Delete the version naming Scheme

Parameters:

versionNamingScheme - to delete

getDeploymentProjectsReferencingArtifact

List<MutableDeploymentProject> getDeploymentProjectsReferencingArtifact(long artifactId)

Get all deployment projects that contain a version that uses specified artifact

Parameters:

artifactId -

Returns:

getDeploymentProjectCount

int getDeploymentProjectCount()

Returns:

number of all deployment projects

getMaxDeploymentProjectOid

@NotNull
BambooEntityOid getMaxDeploymentProjectOid(int serverKey)

Since:

5.11

findDeploymentProjectByOid

@Nullable
MutableDeploymentProject findDeploymentProjectByOid(BambooEntityOid oid)

Since:

6.1

findDeploymentProjectByName

@Nullable
MutableDeploymentProject findDeploymentProjectByName(String name)

Since:

6.1

createNewDeploymentProjectInstance

@NotNull
MutableDeploymentProject createNewDeploymentProjectInstance()

Since:

6.1

createNewVersionNamingSchemeInstance

@NotNull
MutableVersionNamingScheme createNewVersionNamingSchemeInstance()

Since:

6.1

findDeploymentProjectsInOtherStates

@NotNull
Collection<Long> findDeploymentProjectsInOtherStates(VcsLocationBambooSpecsState specsState)

findSpecsStateIdsReferencedByDeployments

@NotNull
Set<Long> findSpecsStateIdsReferencedByDeployments()

Since:

8.0

removeAbstractProjectItems

void removeAbstractProjectItems()

getPaginatedDeploymentsWithEnvironments

List<Pair<MutableDeploymentProject,MutableEnvironment>> getPaginatedDeploymentsWithEnvironments(int start,
                                                                                                int limit,
                                                                                                String filter)

Retrieves paginated list of pairs of MutableDeploymentProject and MutableEnvironment ordered by InternalDeploymentProject.getName() and InternalEnvironment.getPosition()

Parameters:

start -

limit -

filter -

Returns:

list of pair MutableDeploymentProject with zero of one MutableEnvironment

Since:

6.8