org.apache.continuum.taskqueue
Interface OverallBuildQueue

All Known Implementing Classes:

DefaultOverallBuildQueue

public interface OverallBuildQueue

Author:

Maria Odea Ching

getId

int getId()

Returns the id of the "overall" build queue

Returns:

setId

void setId(int id)

getName

String getName()

Returns the name of the "overall" build queue

Returns:

setName

void setName(String name)

getCheckoutQueue

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

Returns the checkout queue.

Returns:

addToCheckoutQueue

void addToCheckoutQueue(CheckOutTask checkoutTask)
                        throws org.codehaus.plexus.taskqueue.TaskQueueException

Add checkout task to checkout queue.

Parameters:

checkoutTask -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

addToCheckoutQueue

void addToCheckoutQueue(List<CheckOutTask> checkoutTasks)
                        throws org.codehaus.plexus.taskqueue.TaskQueueException

Add checkout tasks to checkout queue.

Parameters:

checkoutTasks -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getProjectsInCheckoutQueue

List<CheckOutTask> getProjectsInCheckoutQueue()
                                              throws org.codehaus.plexus.taskqueue.TaskQueueException

Get all checkout tasks in checkout queue.

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

isInCheckoutQueue

boolean isInCheckoutQueue(int projectId)
                          throws org.codehaus.plexus.taskqueue.TaskQueueException

Check if the project is in the checkout queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

cancelCheckoutTask

void cancelCheckoutTask(int projectId)
                        throws org.codehaus.plexus.taskqueue.TaskQueueException

Cancel checkout of project.

Parameters:

projectId -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException

cancelCurrentCheckout

boolean cancelCurrentCheckout()

Cancel current checkout.

Returns:

TODO

removeProjectFromCheckoutQueue

boolean removeProjectFromCheckoutQueue(int projectId)
                                       throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove project from checkout queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectsFromCheckoutQueue

boolean removeProjectsFromCheckoutQueue(int[] projectId)
                                        throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the specified projects in the checkout queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeTasksFromCheckoutQueueWithHashCodes

void removeTasksFromCheckoutQueueWithHashCodes(int[] hashCodes)
                                               throws org.codehaus.plexus.taskqueue.TaskQueueException

Parameters:

hashCodes -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getPrepareBuildQueue

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

Returns the prepare build queue.

Returns:

addToPrepareBuildQueue

void addToPrepareBuildQueue(PrepareBuildProjectsTask prepareBuildTask)
                            throws org.codehaus.plexus.taskqueue.TaskQueueException

Add the prepare build task to the prepare build queue.

Parameters:

prepareBuildTask -

Throws:

Exception

org.codehaus.plexus.taskqueue.TaskQueueException

addToPrepareBuildQueue

void addToPrepareBuildQueue(List<PrepareBuildProjectsTask> prepareBuildTasks)
                            throws org.codehaus.plexus.taskqueue.TaskQueueException

Add the prepare build tasks to the prepare build queue.

Parameters:

prepareBuildTasks -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getProjectsInPrepareBuildQueue

List<PrepareBuildProjectsTask> getProjectsInPrepareBuildQueue()
                                                              throws org.codehaus.plexus.taskqueue.TaskQueueException

Returns the prepare build tasks in the prepare build queue.

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

isInPrepareBuildQueue

boolean isInPrepareBuildQueue(int projectId)
                              throws org.codehaus.plexus.taskqueue.TaskQueueException

Checks if the specified project is in the prepare build queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

isInPrepareBuildQueue

boolean isInPrepareBuildQueue(int projectGroupId,
                              int scmRootId)
                              throws org.codehaus.plexus.taskqueue.TaskQueueException

Checks if the specified project group and scm root is in the prepare build queue.

Parameters:

projectGroupId -

scmRootId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException

isInPrepareBuildQueue

boolean isInPrepareBuildQueue(int projectGroupId,
                              String scmRootAddress)
                              throws org.codehaus.plexus.taskqueue.TaskQueueException

Checks if the specified project group and scm root is in the prepare build queue.

Parameters:

projectGroupId -

scmRootAddress -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException

cancelPrepareBuildTask

void cancelPrepareBuildTask(int projectGroupId,
                            int scmRootId)

Cancel the prepare build task of the corresponding project group and scm root.

Parameters:

projectId -

scmRootId -

cancelPrepareBuildTask

void cancelPrepareBuildTask(int projectId)

Cancel the prepare build task of the corresponding project

Parameters:

projectId -

cancelCurrentPrepareBuild

boolean cancelCurrentPrepareBuild()

Cancel the current prepare build.

Returns:

removeProjectFromPrepareBuildQueue

boolean removeProjectFromPrepareBuildQueue(int projectGroupId,
                                           int scmRootId)
                                           throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the project group matching the specified id, and scm root id from the prepare build queue.

Parameters:

projectGroupId -

scmRootId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectFromPrepareBuildQueue

boolean removeProjectFromPrepareBuildQueue(int projectGroupId,
                                           String scmRootAddress)
                                           throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the project group matching the specified id and scm root address from the prepare build queue.

Parameters:

projectId -

scmRootAddress -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectsFromPrepareBuildQueueWithHashCodes

void removeProjectsFromPrepareBuildQueueWithHashCodes(int[] hashCodes)
                                                      throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the projects matching the specified hashcodes from the prepare build queue.

Parameters:

hashCodes -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getBuildQueue

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

Returns the build queue.

Returns:

addToBuildQueue

void addToBuildQueue(BuildProjectTask buildTask)
                     throws org.codehaus.plexus.taskqueue.TaskQueueException

Add the build task to the build queue.

Parameters:

buildTask -

Throws:

Exception

org.codehaus.plexus.taskqueue.TaskQueueException

addToBuildQueue

void addToBuildQueue(List<BuildProjectTask> buildTasks)
                     throws org.codehaus.plexus.taskqueue.TaskQueueException

Add the build tasks to the build queue.

Parameters:

buildTasks -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getProjectsInBuildQueue

List<BuildProjectTask> getProjectsInBuildQueue()
                                               throws org.codehaus.plexus.taskqueue.TaskQueueException

Returns the build tasks in the build queue.

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

isInBuildQueue

boolean isInBuildQueue(int projectId)
                       throws org.codehaus.plexus.taskqueue.TaskQueueException

Checks if the specified project is in the build queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

isInBuildQueue

boolean isInBuildQueue(int projectId,
                       int buildDefinitionId)
                       throws org.codehaus.plexus.taskqueue.TaskQueueException

Checks if the specified project with the specified build definition is in the build queue.

Parameters:

projectId -

buildDefinitionId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

cancelBuildTask

void cancelBuildTask(int projectId)

Cancel the build task of the corresponding project.

Parameters:

projectId -

cancelCurrentBuild

boolean cancelCurrentBuild()

Cancel the current build.

Returns:

removeProjectFromBuildQueue

boolean removeProjectFromBuildQueue(int projectId,
                                    int buildDefinitionId,
                                    BuildTrigger buildTrigger,
                                    String projectName,
                                    int projectGroupId)
                                    throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the project matching the specified id, name, build definition and trigger from the build queue.

Parameters:

projectId -

buildDefinitionId -

buildTrigger -

projectName -

projectGroupId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectFromBuildQueue

boolean removeProjectFromBuildQueue(int projectId)
                                    throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the specified project from the build queue.

Parameters:

projectId -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectsFromBuildQueue

boolean removeProjectsFromBuildQueue(int[] projectIds)
                                     throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the specified projects from the build queue.

Parameters:

projectIds -

Returns:

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

removeProjectsFromBuildQueueWithHashCodes

void removeProjectsFromBuildQueueWithHashCodes(int[] hashCodes)
                                               throws org.codehaus.plexus.taskqueue.TaskQueueException

Remove the projects matching the specified hashcodes from the build queue.

Parameters:

hashCodes -

Throws:

org.codehaus.plexus.taskqueue.TaskQueueException - TODO

getBuildTaskQueueExecutor

org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor getBuildTaskQueueExecutor()

Returns the build task queue executor used.

Returns:

getCheckoutTaskQueueExecutor

org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor getCheckoutTaskQueueExecutor()

Returns the checkout task queue executor used.

Returns:

getPrepareBuildTaskQueueExecutor

org.codehaus.plexus.taskqueue.execution.TaskQueueExecutor getPrepareBuildTaskQueueExecutor()

Returns the prepare build task queue executor used.

Returns: