org.apache.continuum.taskqueue.manager
Interface TaskQueueManager

All Known Implementing Classes:
DefaultTaskQueueManager

public interface TaskQueueManager

Author:
Maria Catherine Tan

Field Summary
static String ROLE
           
 
Method Summary
 org.codehaus.plexus.taskqueue.TaskQueue getPurgeQueue()
           
 boolean isInPurgeQueue(int purgeConfigurationId)
           
 boolean isProjectInReleaseStage(String releaseId)
          Check whether a project is in the release stage based on the given releaseId.
 boolean isRepositoryInPurgeQueue(int repositoryId)
          Check if the repository is already in the purging queue
 boolean isRepositoryInUse(int repositoryId)
          Check if the repository is being used by a project that is currently building
 boolean releaseInProgress()
           
 boolean removeFromPurgeQueue(int purgeConfigId)
          Remove local repository from the purge queue
 boolean removeFromPurgeQueue(int[] purgeConfigIds)
          Remove local repositories from the purge queue
 void removeRepositoryFromPurgeQueue(int repositoryId)
          Remove local repository from the purge queue
 

Field Detail

ROLE

static final String ROLE
Method Detail

getPurgeQueue

org.codehaus.plexus.taskqueue.TaskQueue getPurgeQueue()

isInPurgeQueue

boolean isInPurgeQueue(int purgeConfigurationId)
                       throws TaskQueueManagerException
Throws:
TaskQueueManagerException

isRepositoryInPurgeQueue

boolean isRepositoryInPurgeQueue(int repositoryId)
                                 throws TaskQueueManagerException
Check if the repository is already in the purging queue

Parameters:
repositoryId - the id of the repository purge configuration
Returns:
true if the repository is in the purging queue, otherwise false
Throws:
TaskQueueManagerException

isRepositoryInUse

boolean isRepositoryInUse(int repositoryId)
                          throws TaskQueueManagerException
Check if the repository is being used by a project that is currently building

Parameters:
repositoryId - the id of the local repository
Returns:
true if the repository is in use, otherwise false
Throws:
TaskQueueManagerException

isProjectInReleaseStage

boolean isProjectInReleaseStage(String releaseId)
                                throws TaskQueueManagerException
Check whether a project is in the release stage based on the given releaseId.

Parameters:
releaseId -
Returns:
Throws:
TaskQueueManagerException

releaseInProgress

boolean releaseInProgress()
                          throws TaskQueueManagerException
Throws:
TaskQueueManagerException

removeFromPurgeQueue

boolean removeFromPurgeQueue(int purgeConfigId)
                             throws TaskQueueManagerException
Remove local repository from the purge queue

Parameters:
purgeConfigId - the id of the purge configuration
Returns:
true if the purge configuration was successfully removed from the purge queue, otherwise false
Throws:
TaskQueueManagerException

removeFromPurgeQueue

boolean removeFromPurgeQueue(int[] purgeConfigIds)
                             throws TaskQueueManagerException
Remove local repositories from the purge queue

Parameters:
purgeConfigIds - the ids of the purge configuration
Returns:
true if the purge configurations were successfully removed from the purge queue, otherwise false
Throws:
TaskQueueManagerException

removeRepositoryFromPurgeQueue

void removeRepositoryFromPurgeQueue(int repositoryId)
                                    throws TaskQueueManagerException
Remove local repository from the purge queue

Parameters:
repositoryId - the id of the local repository
Throws:
TaskQueueManagerException


Copyright © 2003-2013 The Apache Software Foundation. All Rights Reserved.