com.atlassian.bamboo.deployments.environments.persistence

Interface EnvironmentDao

All Known Implementing Classes:

EnvironmentDaoImpl

public interface EnvironmentDao

Dao for interacting with Environments in DB.

Method Summary

Modifier and Type	Method and Description
long	countAll()
void	delete(MutableEnvironment environment) Delete a specific Deployment Environment.
List<MutableEnvironment>	findAll()
List<? extends MutableEnvironment>	findAll(int firstResult, int pageSize)
List<Pair<Requirement,MutableEnvironment>>	findEnvironmentsByRequirementKey(String requirementKey) Get requirements to environment mapping by requirement key.
MutableEnvironment	getEnvironment(DeploymentKey environmentKey) Gets specific Environment by key
MutableEnvironment	getEnvironment(long environmentId) Gets specific Environment by ID
int	getEnvironmentCount()
int	getEnvironmentCountForProject(long deploymentProjectId)
List<MutableEnvironment>	getEnvironmentsForDeploymentProject(long deploymentProjectId) Retrieve all environments for a Deployment Project
int	getLastEnvironmentPosition(long deploymentProjectId)
boolean	isEnvironmentNameConflicting(MutableDeploymentProject deploymentProject, String name) Check if there is currently an environment with the given name in the given deployment Project.
void	save(MutableEnvironment environment) Save a new or existing environment.
<E extends MutableEnvironment> void	saveAll(Collection<E> environments) Save all items on the list;

Method Detail

getEnvironment

@Nullable
MutableEnvironment getEnvironment(long environmentId)

Gets specific Environment by ID

Parameters:

environmentId - ID of the environment your looking for.

Returns:

environment with given id or null if one with that ID could not be found.

getEnvironment

@Nullable
MutableEnvironment getEnvironment(@NotNull
                                            DeploymentKey environmentKey)

Gets specific Environment by key

Parameters:

environmentKey - ket of the environment to find

Returns:

Deployment Environment with given key or null if one with that key could not be found

save

void save(@NotNull
          MutableEnvironment environment)

Save a new or existing environment.

Parameters:

environment - to save.

saveAll

<E extends MutableEnvironment> void saveAll(@NotNull
                                            Collection<E> environments)

Save all items on the list;

Parameters:

environments -

getEnvironmentsForDeploymentProject

@NotNull
List<MutableEnvironment> getEnvironmentsForDeploymentProject(long deploymentProjectId)

Retrieve all environments for a Deployment Project

Parameters:

deploymentProjectId - of the Deployment Project

Returns:

List of all environments in a Deployment Project

delete

void delete(@NotNull
            MutableEnvironment environment)

Delete a specific Deployment Environment.

Parameters:

environment -

isEnvironmentNameConflicting

boolean isEnvironmentNameConflicting(@NotNull
                                     MutableDeploymentProject deploymentProject,
                                     @NotNull
                                     String name)

Check if there is currently an environment with the given name in the given deployment Project.

Parameters:

deploymentProject - the project to check environments of

name - to check for conflict

Returns:

true if the name is already being used by an environment in the project, false if not.

findAll

List<MutableEnvironment> findAll()

getLastEnvironmentPosition

int getLastEnvironmentPosition(long deploymentProjectId)

Returns:

position of the last environment associated with a deployment project or -1 if none.

getEnvironmentCount

int getEnvironmentCount()

Returns:

number of all Environments

getEnvironmentCountForProject

int getEnvironmentCountForProject(long deploymentProjectId)

Parameters:

deploymentProjectId -

Returns:

number of Environment defined for the project

countAll

long countAll()

Since:

5.11

findAll

List<? extends MutableEnvironment> findAll(int firstResult,
                                           int pageSize)

Since:

5.11

findEnvironmentsByRequirementKey

@NotNull
List<Pair<Requirement,MutableEnvironment>> findEnvironmentsByRequirementKey(@NotNull
                                                                                     String requirementKey)

Get requirements to environment mapping by requirement key.

Parameters:

requirementKey - on which environments rely

Returns:

pairs of environments or empty list

Since:

5.13