Package com.atlassian.bamboo.deployments.cache

Class CachedEnvironmentServiceImpl

java.lang.Object

com.atlassian.bamboo.deployments.cache.CachedEnvironmentServiceImpl

All Implemented Interfaces:

CachedEnvironmentService

public class CachedEnvironmentServiceImpl
extends Object
implements CachedEnvironmentService

Field Summary

Fields

Modifier and Type	Field	Description
protected static final long	CACHE_UPDATE_CONCURRENCY_LEVEL
protected static final String	CONCURRENCY_SYS_PROP

Constructor Summary

Constructors

Constructor

Description

CachedEnvironmentServiceImpl(InternalEnvironmentService internalEnvironmentService, EnvironmentService environmentService, EnvironmentDao environmentDao, EnvironmentRepositoryLinkDao environmentRepositoryLinkDao, DeploymentProjectDao deploymentProjectDao, TriggerTypeManager triggerTypeManager, BambooPermissionManager bambooPermissionManager, BambooClusterSettings bambooClusterSettings, VersionDao versionDao, PaginatedDataCollector paginatedDataCollector)

Method Summary

Modifier and Type	Method	Description
@NotNull Environment	createImmutableEnvironment(@NotNull InternalEnvironment environment)	Convert InternalEnvironment to full Environment
@NotNull Iterable<Environment>	getAllEnvironments()	Retrieves all environments.
@NotNull Iterable<InternalEnvironment>	getAllInternalEnvironmentsNoUserContext()	Retrieves all environments defined in the system without filling in operations permitted for the user.
@NotNull BambooCacheStats	getCacheStats()	Retrieve cache statistics
@NotNull List<Pair<Long,Long>>	getDashboardPageUnrestricted(int offset, int limit, @Nullable String filter)	Retrieves a list of environment IDs and their corresponding deployment project IDs for the dashboard page.
@Nullable Long	getDeploymentProjectIdForEnvironment(long environmentId)	Retrieves the deployment project ID for a specific environment.
@Nullable Environment	getEnvironment(long environmentId)	Retrieves an environment by its ID.
@Nullable ImmutableRequirementSet	getEnvironmentRequirementSet(long environmentId)	Retrieves the requirement set for a specific environment.
@NotNull List<Environment>	getEnvironmentsForDeploymentProject(long deploymentProjectId)	Retrieves a list of environments for a specific deployment project.
@NotNull List<Environment>	getEnvironmentsForDeploymentProjectWithConsistencyGuarantee(long deploymentProjectId)	Retrieves a list of environments for a specific deployment project with consistency guarantee.
@NotNull List<EnvironmentStub>	getEnvironmentStubsForDeploymentProject(long deploymentProjectId)	Retrieves a list of environment stubs for a specific deployment project.
List<Environment>	getEnvironmentsUsingRepository(long repositoryId)
@Nullable Environment	getEnvironmentUnrestricted(long environmentId)	Get specific environment by ID.
@Nullable Environment	getEnvironmentWithConsistencyGuarantee(long environmentId)	Retrieves an environment by its ID with consistency guarantee.
@NotNull PaginatedEnvironmentsForDashboard	getPaginatedEnvironmentsForDeploymentProject(long deploymentProjectId, int start, int limit, String filter)	Get paginated environments for a particular deployment project ordered by position.
void	initialiseCache(@NotNull Iterable<? extends InternalDeploymentProject> deploymentProjects)	Initializes the cache with the given deployment projects.
void	initialiseTriggers(org.apache.logging.log4j.Logger logger, Date lastShutdownTime)	Initialise triggers on all active environments.
boolean	isCacheActive()
void	refreshByRequirementSetId(long requirementSetId)	Refreshes the cache for environments by a specific requirement set ID.
void	refreshEnvironment(long environmentId)	Refreshes the cache for a specific environment.
void	reindexDeploymentProject(@NotNull InternalDeploymentProject deploymentProject)	Reindexes a deployment project in the cache.
void	removeDeploymentProject(long deploymentProjectId)	Removes a deployment project from the cache by its ID.
void	removeEnvironment(long environmentId)	Removes an environment from the cache by its ID.
@NotNull Stream<InternalEnvironment>	streamInternalEnvironmentsByIdsUnrestricted(@NotNull Set<Long> environmentIds)	Streams internal environments by their IDs without restrictions.

Methods inherited from class java.lang.Object

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

Field Details

CACHE_UPDATE_CONCURRENCY_LEVEL

protected static final long CACHE_UPDATE_CONCURRENCY_LEVEL

See Also:

• Constant Field Values

CONCURRENCY_SYS_PROP

protected static final String CONCURRENCY_SYS_PROP

See Also:

• Constant Field Values

Constructor Details

CachedEnvironmentServiceImpl

@Inject
public CachedEnvironmentServiceImpl(InternalEnvironmentService internalEnvironmentService,
 EnvironmentService environmentService,
 EnvironmentDao environmentDao,
 EnvironmentRepositoryLinkDao environmentRepositoryLinkDao,
 DeploymentProjectDao deploymentProjectDao,
 TriggerTypeManager triggerTypeManager,
 BambooPermissionManager bambooPermissionManager,
 BambooClusterSettings bambooClusterSettings,
 VersionDao versionDao,
 PaginatedDataCollector paginatedDataCollector)

Method Details

initialiseCache

public void initialiseCache(@NotNull
 @NotNull Iterable<? extends InternalDeploymentProject> deploymentProjects)

Description copied from interface: CachedEnvironmentService

Initializes the cache with the given deployment projects. Do NOT call this method multiple times; cache can be initialized only once.

Specified by:

initialiseCache in interface CachedEnvironmentService

Parameters:

deploymentProjects - the deployment projects to initialize the cache with

initialiseTriggers

public void initialiseTriggers(org.apache.logging.log4j.Logger logger,
 Date lastShutdownTime)

Description copied from interface: CachedEnvironmentService

Initialise triggers on all active environments.

Specified by:

initialiseTriggers in interface CachedEnvironmentService

Parameters:

logger - the logger to use

lastShutdownTime - the last shutdown time

getEnvironmentsForDeploymentProject

@NotNull
public @NotNull List<Environment> getEnvironmentsForDeploymentProject(long deploymentProjectId)

Description copied from interface: CachedEnvironmentService

Retrieves a list of environments for a specific deployment project.

Specified by:

getEnvironmentsForDeploymentProject in interface CachedEnvironmentService

Parameters:

deploymentProjectId - the ID of the deployment project

Returns:

a list of environments for the specified deployment project

getEnvironmentsForDeploymentProjectWithConsistencyGuarantee

@NotNull
public @NotNull List<Environment> getEnvironmentsForDeploymentProjectWithConsistencyGuarantee(long deploymentProjectId)

Description copied from interface: CachedEnvironmentService

Retrieves a list of environments for a specific deployment project with consistency guarantee.

Specified by:

getEnvironmentsForDeploymentProjectWithConsistencyGuarantee in interface CachedEnvironmentService

Parameters:

deploymentProjectId - the ID of the deployment project

Returns:

a list of environments for the specified deployment project

getEnvironment

@Nullable
public @Nullable Environment getEnvironment(long environmentId)

Description copied from interface: CachedEnvironmentService

Retrieves an environment by its ID.

Specified by:

getEnvironment in interface CachedEnvironmentService

Parameters:

environmentId - the ID of the environment

Returns:

the environment, or null if not found

getEnvironmentUnrestricted

@Nullable
public @Nullable Environment getEnvironmentUnrestricted(long environmentId)

Description copied from interface: CachedEnvironmentService

Get specific environment by ID. Does not check permissions.

Specified by:

getEnvironmentUnrestricted in interface CachedEnvironmentService

Parameters:

environmentId - ID to search for

Returns:

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

getEnvironmentWithConsistencyGuarantee

@Nullable
public @Nullable Environment getEnvironmentWithConsistencyGuarantee(long environmentId)

Description copied from interface: CachedEnvironmentService

Retrieves an environment by its ID with consistency guarantee.

Specified by:

getEnvironmentWithConsistencyGuarantee in interface CachedEnvironmentService

Parameters:

environmentId - the ID of the environment

Returns:

the environment with consistency guarantee, or null if not found

getAllEnvironments

@NotNull
public @NotNull Iterable<Environment> getAllEnvironments()

Description copied from interface: CachedEnvironmentService

Retrieves all environments.

Specified by:

getAllEnvironments in interface CachedEnvironmentService

Returns:

an iterable of all environments

getAllInternalEnvironmentsNoUserContext

@NotNull
public @NotNull Iterable<InternalEnvironment> getAllInternalEnvironmentsNoUserContext()

Description copied from interface: CachedEnvironmentService

Retrieves all environments defined in the system without filling in operations permitted for the user.

Specified by:

getAllInternalEnvironmentsNoUserContext in interface CachedEnvironmentService

Returns:

an iterable of all environments

getEnvironmentRequirementSet

@Nullable
public @Nullable ImmutableRequirementSet getEnvironmentRequirementSet(long environmentId)

Description copied from interface: CachedEnvironmentService

Retrieves the requirement set for a specific environment.

Specified by:

getEnvironmentRequirementSet in interface CachedEnvironmentService

Parameters:

environmentId - the ID of the environment

Returns:

the requirement set, or null if not found

getEnvironmentStubsForDeploymentProject

@NotNull
public @NotNull List<EnvironmentStub> getEnvironmentStubsForDeploymentProject(long deploymentProjectId)

Description copied from interface: CachedEnvironmentService

Retrieves a list of environment stubs for a specific deployment project.

Specified by:

getEnvironmentStubsForDeploymentProject in interface CachedEnvironmentService

Parameters:

deploymentProjectId - the ID of the deployment project

Returns:

a list of environment stubs for the specified deployment project

getPaginatedEnvironmentsForDeploymentProject

@NotNull
public @NotNull PaginatedEnvironmentsForDashboard getPaginatedEnvironmentsForDeploymentProject(long deploymentProjectId,
 int start,
 int limit,
 String filter)

Description copied from interface: CachedEnvironmentService

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.

Specified by:

getPaginatedEnvironmentsForDeploymentProject in interface CachedEnvironmentService

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

getDeploymentProjectIdForEnvironment

@Nullable
public @Nullable Long getDeploymentProjectIdForEnvironment(long environmentId)

Description copied from interface: CachedEnvironmentService

Retrieves the deployment project ID for a specific environment.

Specified by:

getDeploymentProjectIdForEnvironment in interface CachedEnvironmentService

Parameters:

environmentId - the ID of the environment

Returns:

the deployment project ID, or null if not found

getDashboardPageUnrestricted

@NotNull
public @NotNull List<Pair<Long,Long>> getDashboardPageUnrestricted(int offset,
 int limit,
 @Nullable
 @Nullable String filter)

Description copied from interface: CachedEnvironmentService

Retrieves a list of environment IDs and their corresponding deployment project IDs for the dashboard page.

Specified by:

getDashboardPageUnrestricted in interface CachedEnvironmentService

Parameters:

offset - the starting point of the list

limit - the maximum number of items to return

filter - an optional filter to apply

Returns:

a list of pairs containing deployment project ID and environment ID.

getEnvironmentsUsingRepository

public List<Environment> getEnvironmentsUsingRepository(long repositoryId)

Specified by:

getEnvironmentsUsingRepository in interface CachedEnvironmentService

Parameters:

repositoryId - repository id

Returns:

list of immutable Environments that use given repository

createImmutableEnvironment

@NotNull
public @NotNull Environment createImmutableEnvironment(@NotNull
 @NotNull InternalEnvironment environment)

Description copied from interface: CachedEnvironmentService

Convert InternalEnvironment to full Environment

Specified by:

createImmutableEnvironment in interface CachedEnvironmentService

streamInternalEnvironmentsByIdsUnrestricted

@NotNull
public @NotNull Stream<InternalEnvironment> streamInternalEnvironmentsByIdsUnrestricted(@NotNull
 @NotNull Set<Long> environmentIds)

Description copied from interface: CachedEnvironmentService

Streams internal environments by their IDs without restrictions.

Specified by:

streamInternalEnvironmentsByIdsUnrestricted in interface CachedEnvironmentService

Parameters:

environmentIds - the set of environment IDs

Returns:

a stream of internal environments

removeDeploymentProject

public void removeDeploymentProject(long deploymentProjectId)

Description copied from interface: CachedEnvironmentService

Removes a deployment project from the cache by its ID.

Specified by:

removeDeploymentProject in interface CachedEnvironmentService

Parameters:

deploymentProjectId - the ID of the deployment project to remove

removeEnvironment

public void removeEnvironment(long environmentId)

Description copied from interface: CachedEnvironmentService

Removes an environment from the cache by its ID.

Specified by:

removeEnvironment in interface CachedEnvironmentService

Parameters:

environmentId - the ID of the environment to remove

refreshByRequirementSetId

public void refreshByRequirementSetId(long requirementSetId)

Description copied from interface: CachedEnvironmentService

Refreshes the cache for environments by a specific requirement set ID.

Specified by:

refreshByRequirementSetId in interface CachedEnvironmentService

Parameters:

requirementSetId - the ID of the requirement set

reindexDeploymentProject

public void reindexDeploymentProject(@NotNull
 @NotNull InternalDeploymentProject deploymentProject)

Description copied from interface: CachedEnvironmentService

Reindexes a deployment project in the cache.

Specified by:

reindexDeploymentProject in interface CachedEnvironmentService

Parameters:

deploymentProject - the deployment project to reindex

refreshEnvironment

public void refreshEnvironment(long environmentId)

Description copied from interface: CachedEnvironmentService

Refreshes the cache for a specific environment.

Specified by:

refreshEnvironment in interface CachedEnvironmentService

Parameters:

environmentId - the ID of the environment to refresh

getCacheStats

@NotNull
public @NotNull BambooCacheStats getCacheStats()

Description copied from interface: CachedEnvironmentService

Retrieve cache statistics

Specified by:

getCacheStats in interface CachedEnvironmentService

Returns:

Cache statistics

isCacheActive

public boolean isCacheActive()

Specified by:

isCacheActive in interface CachedEnvironmentService