com.atlassian.bamboo.configuration.external

Interface RssDetectionService

All Known Implementing Classes:

RssDetectionServiceImpl

public interface RssDetectionService

Service for scheduling Repository-stored Specs detection.

Method Summary

Modifier and Type	Method and Description
ErrorCollection	canEnqueue(long repositoryId) Checks whether Bamboo can enqueue RSS detection for the given repository.
void	cleanUnfinishedSpecsAndInitService() Init the service and clean up any stale scan states after Bamboo restart.
Future<Boolean>	enqueue(long repositoryId) Enqueue RSS detection for repository with the given ID.
Future<Boolean>	enqueue(long repositoryId, boolean force) Enqueue RSS detection for repository with the given ID.
boolean	isInProgress(long repositoryId)
Future<Boolean>	shutdown() Shut down the RSS detection service and the underlying thread pool.

Method Detail

canEnqueue

@NotNull
ErrorCollection canEnqueue(long repositoryId)

Checks whether Bamboo can enqueue RSS detection for the given repository. If Specs can't be executed, returns an error collection containing all the reasons why. If they can, returns an empty error collection.

This method will not attempt to connect to the repository. It will only validate repository's configuration and global Bamboo settings.

Parameters:

repositoryId - ID of the repository

Returns:

collection containing reasons why triggering Specs can't be performed, empty if Specs can be enqueued

enqueue

@NotNull
Future<Boolean> enqueue(long repositoryId)

Enqueue RSS detection for repository with the given ID. Only IDs of linked repositories with Specs scanning enabled may trigger Specs execution.

Parameters:

repositoryId - ID of the linked repository

Returns:

future result of the RSS detection, yielding true if Bamboo Specs have been run

enqueue

@NotNull
Future<Boolean> enqueue(long repositoryId,
                                 boolean force)

Enqueue RSS detection for repository with the given ID. Only IDs of linked repositories with Specs scanning enabled may trigger Specs execution.

Parameters:

repositoryId - ID of the linked repository

force - if true, specs import is executed even if no new commits are found in the repository

Returns:

future result of the RSS detection, yielding true if Bamboo Specs have been run

shutdown

@NotNull
Future<Boolean> shutdown()

Shut down the RSS detection service and the underlying thread pool.

Returns:

future result of the shutdown, yielding true after the shutdown is finished

isInProgress

boolean isInProgress(long repositoryId)

Returns:

true if scanning for specs is currently queued or in progress.

cleanUnfinishedSpecsAndInitService

void cleanUnfinishedSpecsAndInitService()

Init the service and clean up any stale scan states after Bamboo restart.

Since:

6.10