EnvironmentService (Atlassian Bamboo 6.8.0 API)

All Known Implementing Classes:

EnvironmentServiceImpl
```
public interface EnvironmentService
```
Provides services and functionality around Environments. All objects returned/inputted are immutable.

Field Summary

Fields
Modifier and Type Field and Description

static String DEFAULT_ARTIFACT_TASK_NAME

Fields
Modifier and Type	Field and Description
`static String`	`DEFAULT_ARTIFACT_TASK_NAME`

Method Summary

All Methods Instance Methods Abstract Methods Deprecated Methods
Modifier and Type	Method and Description
`Environment`	`addEnvironment(long deploymentProjectId, String name, String description)` Creates a new environment in the specified deployment project.
`void`	`addNotification(long environmentId, NotificationRule newRule)` Adds a new notification to the environment notifications
`Environment`	`cloneEnvironment(long deploymentProjectId, long environmentId, String name, String description)` Create new environment as a clone of existing one
`Environment`	`createImmutableEnvironment(MutableEnvironment environment)` Converts mutable environment to immutable.
`Environment`	`createOperationsAwareImmutableEnvironment(MutableEnvironment environment)` Create operation aware immutable environment
`void`	`deleteNotification(long environmentId, long notificationId)` Removes notification from the environment's notification set.
`Environment`	`editEnvironment(long environmentId, String name, String description)` Edit the details of an existing environment
`Environment`	`findEnvironmentByName(long deploymentProjectId, String name)` Find environment with specified name in a deployment project
`Set<RequirementDeploymentMapping>`	`findEnvironmentsByRequirementKey(String requirementKey)` Find environments which rely on requirementKey
`Iterable<Environment>`	`getAllEnvironments()` Retrieve all `Environment` defined in the system.
`Collection<Environment>`	`getAllEnvironmentsForDashboard()` Retrieve all `Environment` defined in the system.
`Iterable<Environment>`	`getAllEnvironmentsNoUserContext()` Retrieve all `Environment` defined in the system without filling in operations permitted for the user.
`Environment`	`getEnvironment(long environmentId)` Get specific environment by ID.
`int`	`getEnvironmentCount()`
`int`	`getEnvironmentCountForProject(DeploymentProject deploymentProject)`
`Function<Environment,DecoratedEnvironment>`	`getEnvironmentDecorator()` Create environment decorator function object.
`List<EnvironmentRepositoryLink>`	`getEnvironmentRepositoryLinksForRepository(long repositoryId)`
`RequirementSet`	`getEnvironmentRequirementSet(long environmentId)` Retrieve Agent Requirement set for environment, if environment with id exists.
`List<Environment>`	`getEnvironmentsForDeploymentProject(long deploymentProjectId)` Get all environments for a particular deployment project.
`List<EnvironmentStub>`	`getEnvironmentStubsForDeploymentProject(long deploymentProjectId)` Get all environment stubs for a particular deployment project.
`List<EnvironmentRepositoryLink>`	`getEnvironmentsUsingRepository(long repositoryId)` Deprecated. since 5.13, use `getEnvironmentRepositoryLinksForRepository(long)`
`List<Environment>`	`getEnvironmentsUsingRepositoryDataEntity(long repositoryId)` TODO 6.0 rename to getEnvironmentsUsingRepository
`NotificationSet`	`getNotificationSet(long environmentId)` Retrieve notification set for environment, if environment with id exists.
`PaginatedEnvironmentsForDashboard`	`getPaginatedEnvironmentsForDeploymentProject(long deploymentProjectId, int start, int limit, String filter)` Get paginated environments for a particular deployment project ordered by position.
`List<PlanRepositoryDefinition>`	`getPlanRepositoryDefinitionsForEnvironment(Environment environment)` Deprecated. since 6.1 use `getPlanRepositoryDefinitionsForEnvironment(InternalEnvironment)`
`List<PlanRepositoryDefinition>`	`getPlanRepositoryDefinitionsForEnvironment(InternalEnvironment environment)` Retrieves all repositories used in environment source checkout tasks
`List<RepositoryDefinition>`	`getRepositoryDefinitionsForEnvironment(Environment environment)` Deprecated. since 5.14 use `getPlanRepositoryDefinitionsForEnvironment(InternalEnvironment)`
`ErrorCollection`	`moveEnvironment(MoveEnvironmentStrategy moveEnvironmentStrategy, long deploymentProjectId, long environmentId, int currentPosition, Optional<Long> relatedEnvId)` Move Environment in given deploymentProject with given strategy.
`ErrorCollection`	`moveEnvironmentDown(long deploymentProjectId, long environmentId, int currentPosition)` Deprecated. since 6.8 use `moveEnvironment(MoveEnvironmentStrategy, long, long, int, Optional)` with `MoveEnvironmentStrategy.DOWN`
`ErrorCollection`	`moveEnvironmentUp(long deploymentProjectId, long environmentId, int currentPosition)` Deprecated. since 6.8 use `moveEnvironment(MoveEnvironmentStrategy, long, long, int, Optional)` with `MoveEnvironmentStrategy.UP`
`void`	`removeRepositoryFromEnvironment(EnvironmentRepositoryLink environmentRepositoryLink)` Remove `EnvironmentRepositoryLink` from environment
`void`	`resetTriggersForDeployment(long deploymentProjectId)` Delete and recreate triggers for all environments for this deployment
`void`	`restartAllTriggeringForDeploymentProject(long deploymentProjectId)` Restart all automatic triggering on every `Environment` related to a `DeploymentProject`.
`void`	`startAllTriggers(Environment environment)` Start all automatic triggering on `InternalEnvironment`
`void`	`startAllTriggersForDeploymentProject(long deploymentProjectId)` Start all automatic triggering on every `Environment` related to a `DeploymentProject`
`void`	`stopAllTriggers(Environment environment)` Stop all automatic triggering on `InternalEnvironment`
`void`	`stopAllTriggersForDeploymentProject(long deploymentProjectId)` Stop all automatic triggering on every `Environment` related to a `DeploymentProject`
`void`	`updateEnvironmentConfigurationState(long environmentId, ConfigurationState configurationState)` Update the configurationState of this environment
`void`	`updatePlanKey(long deploymentProjectId, PlanKey originalPlanKey, PlanKey newPlanKey)` Update planKey in Environment related configuration when plan key has changed (ie after moving plan).
`RepositoryDefinition`	`updateRepositoryLinkInEnvironment(EnvironmentRepositoryLink environmentRepositoryLink, RepositoryDataEntity newRepositoryEntity)` Update `EnvironmentRepositoryLink` data
`ErrorCollection`	`validateAddEnvironment(long deploymentProjectId, String name, String description)` Validates values to be used for creating a new environment.
`ErrorCollection`	`validateEditEnvironment(long environmentId, String name, String description)` Validates values to be used when editing existing environment.

- Field Detail
  - DEFAULT_ARTIFACT_TASK_NAME
```
static final String DEFAULT_ARTIFACT_TASK_NAME
```
    See Also:
    
    Constant Field Values
- Method Detail
  - getEnvironmentsForDeploymentProject
```
@NotNull
List<Environment> getEnvironmentsForDeploymentProject(long deploymentProjectId)
```
    Get all environments for a particular deployment project. Does not validate deployment project actually exists.
    
    Parameters:
    
    deploymentProjectId - of the deployment project to get environments for
    
    Returns:
    
    List of environments for a single deployment project. Sorted by position, name.
  - getEnvironmentStubsForDeploymentProject
```
@NotNull
List<EnvironmentStub> getEnvironmentStubsForDeploymentProject(long deploymentProjectId)
```
    Get all environment stubs for a particular deployment project. Does not validate deployment project actually exists. Returns minimum data set required for rendering on deployment project pages.
    
    Parameters:
    
    deploymentProjectId - of the deployment project to get environments for
    
    Returns:
    
    List of environments for a single deployment project. Sorted by position, name.
  - getPaginatedEnvironmentsForDeploymentProject
```
@NotNull
PaginatedEnvironmentsForDashboard getPaginatedEnvironmentsForDeploymentProject(long deploymentProjectId,
                                                                                        int start,
                                                                                        int limit,
                                                                                        @Nullable
                                                                                        String filter)
```
    Get paginated environments for a particular deployment project ordered by position. Does not validate deployment project actually exists. Filtering requires at least one character. If filter is null or empty then no filtering.
    
    Parameters:
    
    deploymentProjectId - of the deployment project to get environments for
    
    start - start by index
    
    limit - return no more entries than limit
    
    filter - filter
    
    Returns:
    
    List of environments for a single deployment project. Sorted by position.
    
    See Also:
    
    InternalEnvironment.getPosition()
  - getEnvironment
```
@Nullable
Environment getEnvironment(long environmentId)
                              throws org.acegisecurity.AccessDeniedException
```
    Get specific environment by ID.
    
    Parameters:
    
    environmentId - ID to search for
    
    Returns:
    
    environment with given ID or null if one could not be found.
    
    Throws:
    
    org.acegisecurity.AccessDeniedException - when user doesn't have permissions to view environment
  - validateAddEnvironment
```
@NotNull
ErrorCollection validateAddEnvironment(long deploymentProjectId,
                                                @Nullable
                                                String name,
                                                @Nullable
                                                String description)
```
    Validates values to be used for creating a new environment.
    
    Parameters:
    
    deploymentProjectId -
    
    name -
    
    description -
    
    Returns:
    
    errorCollection containing any errors found. If no errors, an empty errorCollection will be returned.
  - addEnvironment
```
@NotNull
Environment addEnvironment(long deploymentProjectId,
                                    @Nullable
                                    String name,
                                    @Nullable
                                    String description)
                             throws WebValidationException
```
    Creates a new environment in the specified deployment project.
    
    Parameters:
    
    deploymentProjectId - to create environment in
    
    name - of the environment.
    
    description - of the environment.
    
    Throws:
    
    WebValidationException
  - cloneEnvironment
```
Environment cloneEnvironment(long deploymentProjectId,
                             long environmentId,
                             @Nullable
                             String name,
                             @Nullable
                             String description)
                      throws WebValidationException
```
    Create new environment as a clone of existing one
    
    Parameters:
    
    environmentId -
    
    name -
    
    description -
    
    Returns:
    
    Throws:
    
    WebValidationException
  - validateEditEnvironment
```
@NotNull
ErrorCollection validateEditEnvironment(long environmentId,
                                                 @Nullable
                                                 String name,
                                                 @Nullable
                                                 String description)
```
    Validates values to be used when editing existing environment.
    
    Parameters:
    
    environmentId - environment to edit
    
    name - of the environment
    
    description - of the environment
    
    Returns:
    
    errorCollection containing any errors found. If no errors, an empty errorCollection will be returned.
  - editEnvironment
```
@NotNull
Environment editEnvironment(long environmentId,
                                     String name,
                                     String description)
                              throws WebValidationException
```
    Edit the details of an existing environment
    
    Parameters:
    
    environmentId - environment to edit
    
    name - of the environment
    
    description - of the environment
    
    Returns:
    
    the updated environment
    
    Throws:
    
    WebValidationException
  - updateEnvironmentConfigurationState
```
void updateEnvironmentConfigurationState(long environmentId,
                                         @NotNull
                                         ConfigurationState configurationState)
```
    Update the configurationState of this environment
    
    Parameters:
    
    environmentId - of environment to update
    
    configurationState - new configuration state
  - getEnvironmentRequirementSet
```
@Nullable
RequirementSet getEnvironmentRequirementSet(long environmentId)
```
    Retrieve Agent Requirement set for environment, if environment with id exists.
    
    Parameters:
    
    environmentId - of environment
    
    Returns:
    
    all requirements this environment has.
  - getAllEnvironments
```
@NotNull
Iterable<Environment> getAllEnvironments()
```
    Retrieve all Environment defined in the system. The result is filtered by environment permissions and sorted by deployment project id and environment position. Environments belonging to inaccessible projects are not currently filtered out, but their operations show them to be inaccessible.
  - getAllEnvironmentsForDashboard
```
@NotNull
Collection<Environment> getAllEnvironmentsForDashboard()
```
    Retrieve all Environment defined in the system. The result is filtered by environment permissions and sorted by deployment project id and environment position. Environments belonging to inaccessible projects are not currently filtered out, but their operations show them to be inaccessible. Some data inside the object may be unavailable.
  - getAllEnvironmentsNoUserContext
```
@NotNull
Iterable<Environment> getAllEnvironmentsNoUserContext()
```
    Retrieve all Environment defined in the system without filling in operations permitted for the user.
  - getRepositoryDefinitionsForEnvironment
```
@Deprecated
 @NotNull
List<RepositoryDefinition> getRepositoryDefinitionsForEnvironment(@NotNull
                                                                                        Environment environment)
```
    Deprecated. since 5.14 use getPlanRepositoryDefinitionsForEnvironment(InternalEnvironment)
    
    Retrieves all repositories used in environment source checkout tasks
    
    Parameters:
    
    environment -
    
    Returns:
  - getPlanRepositoryDefinitionsForEnvironment
```
@NotNull
 @Deprecated
List<PlanRepositoryDefinition> getPlanRepositoryDefinitionsForEnvironment(@NotNull
                                                                                                Environment environment)
```
    Deprecated. since 6.1 use getPlanRepositoryDefinitionsForEnvironment(InternalEnvironment)
    
    Retrieves all repositories used in environment source checkout tasks
    
    Parameters:
    
    environment -
    
    Returns:
  - getPlanRepositoryDefinitionsForEnvironment
```
@NotNull
List<PlanRepositoryDefinition> getPlanRepositoryDefinitionsForEnvironment(@NotNull
                                                                                   InternalEnvironment environment)
```
    Retrieves all repositories used in environment source checkout tasks
    
    Parameters:
    
    environment -
    
    Returns:
  - getEnvironmentsUsingRepository
```
@Deprecated
List<EnvironmentRepositoryLink> getEnvironmentsUsingRepository(long repositoryId)
```
    Deprecated. since 5.13, use getEnvironmentRepositoryLinksForRepository(long)
  - getEnvironmentRepositoryLinksForRepository
```
List<EnvironmentRepositoryLink> getEnvironmentRepositoryLinksForRepository(long repositoryId)
```
    Parameters:
    
    repositoryId - repository id
    
    Returns:
    
    list of Source Repository relationships defined for the given repository
  - getEnvironmentsUsingRepositoryDataEntity
```
List<Environment> getEnvironmentsUsingRepositoryDataEntity(long repositoryId)
```
    TODO 6.0 rename to getEnvironmentsUsingRepository
    
    Parameters:
    
    repositoryId - repository id
    
    Returns:
    
    list of immutable Environments that use given repository
  - updateRepositoryLinkInEnvironment
```
RepositoryDefinition updateRepositoryLinkInEnvironment(EnvironmentRepositoryLink environmentRepositoryLink,
                                                       RepositoryDataEntity newRepositoryEntity)
```
    Update EnvironmentRepositoryLink data
    
    Parameters:
    
    environmentRepositoryLink -
    
    newRepositoryEntity -
    
    Returns:
  - removeRepositoryFromEnvironment
```
void removeRepositoryFromEnvironment(@NotNull
                                     EnvironmentRepositoryLink environmentRepositoryLink)
```
    Remove EnvironmentRepositoryLink from environment
    
    Parameters:
    
    environmentRepositoryLink -
  - addNotification
```
void addNotification(long environmentId,
                     @NotNull
                     NotificationRule newRule)
              throws WebValidationException
```
    Adds a new notification to the environment notifications
    
    Throws:
    
    WebValidationException
  - getNotificationSet
```
@Nullable
NotificationSet getNotificationSet(long environmentId)
```
    Retrieve notification set for environment, if environment with id exists.
    
    Parameters:
    
    environmentId - of environment
  - deleteNotification
```
void deleteNotification(long environmentId,
                        long notificationId)
                 throws WebValidationException
```
    Removes notification from the environment's notification set.
    
    Throws:
    
    WebValidationException
  - stopAllTriggers
```
void stopAllTriggers(@NotNull
                     Environment environment)
```
    Stop all automatic triggering on InternalEnvironment
    
    Parameters:
    
    environment -
  - startAllTriggers
```
void startAllTriggers(@NotNull
                      Environment environment)
```
    Start all automatic triggering on InternalEnvironment
    
    Parameters:
    
    environment -
  - stopAllTriggersForDeploymentProject
```
void stopAllTriggersForDeploymentProject(long deploymentProjectId)
```
    Stop all automatic triggering on every Environment related to a DeploymentProject
    
    Parameters:
    
    deploymentProjectId -
  - startAllTriggersForDeploymentProject
```
void startAllTriggersForDeploymentProject(long deploymentProjectId)
```
    Start all automatic triggering on every Environment related to a DeploymentProject
    
    Parameters:
    
    deploymentProjectId -
  - restartAllTriggeringForDeploymentProject
```
void restartAllTriggeringForDeploymentProject(long deploymentProjectId)
```
    Restart all automatic triggering on every Environment related to a DeploymentProject. When using this method please keep in mind that triggers should be stopped before modifying their configuration and restarted afterwards. Thus stopAllTriggersForDeploymentProject(long) and startAllTriggersForDeploymentProject(long) might be more useful.
  - moveEnvironmentUp
```
@NotNull
 @Deprecated
ErrorCollection moveEnvironmentUp(long deploymentProjectId,
                                                        long environmentId,
                                                        int currentPosition)
```
    Deprecated. since 6.8 use moveEnvironment(MoveEnvironmentStrategy, long, long, int, Optional) with MoveEnvironmentStrategy.UP
    
    Moves an environment up the list
  - moveEnvironmentDown
```
@NotNull
 @Deprecated
ErrorCollection moveEnvironmentDown(long deploymentProjectId,
                                                          long environmentId,
                                                          int currentPosition)
```
    Deprecated. since 6.8 use moveEnvironment(MoveEnvironmentStrategy, long, long, int, Optional) with MoveEnvironmentStrategy.DOWN
    
    Moves an environment down the list
  - getEnvironmentCount
```
int getEnvironmentCount()
```
    Returns:
    
    number of all environments
    
    Since:
    
    5.3
  - getEnvironmentCountForProject
```
int getEnvironmentCountForProject(DeploymentProject deploymentProject)
```
    Parameters:
    
    deploymentProject -
    
    Returns:
    
    number of environments defined for project
    
    Since:
    
    5.1
  - updatePlanKey
```
void updatePlanKey(long deploymentProjectId,
                   @NotNull
                   PlanKey originalPlanKey,
                   @NotNull
                   PlanKey newPlanKey)
```
    Update planKey in Environment related configuration when plan key has changed (ie after moving plan). This method is called by DeploymentProjectService.updatePlanKey(PlanKey, PlanKey) after DeploymentProject has been updated.
    
    Parameters:
    
    deploymentProjectId - id of deployment project which environments have to be checked
    
    originalPlanKey - original PlanKey
    
    newPlanKey - new PlanKey
    
    Since:
    
    5.2
  - resetTriggersForDeployment
```
void resetTriggersForDeployment(long deploymentProjectId)
```
    Delete and recreate triggers for all environments for this deployment
    
    Parameters:
    
    deploymentProjectId -
    
    Since:
    
    5.11
  - getEnvironmentDecorator
```
Function<Environment,DecoratedEnvironment> getEnvironmentDecorator()
```
    Create environment decorator function object. Instances should be used for a single stream operation and should not live long.
  - findEnvironmentsByRequirementKey
```
@NotNull
Set<RequirementDeploymentMapping> findEnvironmentsByRequirementKey(@NotNull
                                                                            String requirementKey)
```
    Find environments which rely on requirementKey
    
    Parameters:
    
    requirementKey - on which environments rely
    
    Returns:
    
    environments or empty set
    
    Since:
    
    5.13
  - createImmutableEnvironment
```
@NotNull
Environment createImmutableEnvironment(@NotNull
                                                MutableEnvironment environment)
```
    Converts mutable environment to immutable.
    
    Since:
    
    6.1
  - findEnvironmentByName
```
@Nullable
Environment findEnvironmentByName(long deploymentProjectId,
                                            String name)
```
    Find environment with specified name in a deployment project
    
    Parameters:
    
    deploymentProjectId -
    
    name -
    
    Since:
    
    6.8
  - createOperationsAwareImmutableEnvironment
```
@NotNull
Environment createOperationsAwareImmutableEnvironment(@NotNull
                                                               MutableEnvironment environment)
```
    Create operation aware immutable environment
    
    Since:
    
    6.8
    
    See Also:
    
    Operations
  - moveEnvironment
```
ErrorCollection moveEnvironment(MoveEnvironmentStrategy moveEnvironmentStrategy,
                                long deploymentProjectId,
                                long environmentId,
                                int currentPosition,
                                Optional<Long> relatedEnvId)
```
    Move Environment in given deploymentProject with given strategy. relatedEnvId is optional for most cases. It is only required for strategy MoveEnvironmentStrategy.AFTER or MoveEnvironmentStrategy.BEFORE
    
    Parameters:
    
    moveEnvironmentStrategy -
    
    deploymentProjectId -
    
    environmentId -
    
    currentPosition -
    
    relatedEnvId -
    
    Returns:
    
    error collection
    
    Since:
    
    6.8

Interface EnvironmentService

Field Summary

Method Summary

Field Detail

DEFAULT_ARTIFACT_TASK_NAME

Method Detail

getEnvironmentsForDeploymentProject

getEnvironmentStubsForDeploymentProject

getPaginatedEnvironmentsForDeploymentProject

getEnvironment

validateAddEnvironment

addEnvironment

cloneEnvironment

validateEditEnvironment

editEnvironment

updateEnvironmentConfigurationState

getEnvironmentRequirementSet

getAllEnvironments

getAllEnvironmentsForDashboard

getAllEnvironmentsNoUserContext

getRepositoryDefinitionsForEnvironment

getPlanRepositoryDefinitionsForEnvironment

getPlanRepositoryDefinitionsForEnvironment

getEnvironmentsUsingRepository

getEnvironmentRepositoryLinksForRepository

getEnvironmentsUsingRepositoryDataEntity

updateRepositoryLinkInEnvironment

removeRepositoryFromEnvironment

addNotification

getNotificationSet

deleteNotification

stopAllTriggers

startAllTriggers

stopAllTriggersForDeploymentProject

startAllTriggersForDeploymentProject

restartAllTriggeringForDeploymentProject

moveEnvironmentUp

moveEnvironmentDown

getEnvironmentCount

getEnvironmentCountForProject

updatePlanKey

resetTriggersForDeployment

getEnvironmentDecorator

findEnvironmentsByRequirementKey

createImmutableEnvironment

findEnvironmentByName

createOperationsAwareImmutableEnvironment

moveEnvironment