org.apache.continuum.buildmanager
Class ParallelBuildsManager

java.lang.Object
  org.apache.continuum.buildmanager.ParallelBuildsManager

All Implemented Interfaces:

BuildsManager, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

public class ParallelBuildsManager
extends Object
implements BuildsManager, org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Parallel builds manager.

Version:

$Id$

Author:

Maria Odea Ching

ParallelBuildsManager

public ParallelBuildsManager()

buildProject

public void buildProject(int projectId,
                         BuildDefinition buildDefinition,
                         String projectName,
                         BuildTrigger buildTrigger,
                         ScmResult scmResult,
                         int projectGroupId)
                  throws BuildManagerException

Description copied from interface: BuildsManager

Build the project using the specified build definition. Adds the project to the build queue of the overall queue with the least among of tasks queued. The overall queue is chosen from the pool of queues attached to the schedule of the build definition.

Specified by:

buildProject in interface BuildsManager

scmResult - TODO

Throws:

BuildManagerException

See Also:

BuildsManager.buildProject(int, BuildDefinition, String, BuildTrigger, ScmResult, int)

buildProjects

public void buildProjects(List<Project> projects,
                          Map<Integer,BuildDefinition> projectsBuildDefinitionsMap,
                          BuildTrigger buildTrigger,
                          Map<Integer,ScmResult> scmResultMap,
                          int projectGroupId)
                   throws BuildManagerException

Description copied from interface: BuildsManager

Build projects using their corresponding build definitions. This method adds the group of projects to the build queue of the overall queue with the least amount of tasks queued.

Specified by:

buildProjects in interface BuildsManager

scmResultMap - TODO

Throws:

BuildManagerException

See Also:

BuildsManager.buildProjects(List, Map, BuildTrigger, Map, int)

cancelBuildInQueue

public boolean cancelBuildInQueue(int buildQueueId)
                           throws BuildManagerException

Description copied from interface: BuildsManager

Cancels the current build on the specified overall queue.

Specified by:

cancelBuildInQueue in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.cancelBuildInQueue(int)

cancelAllBuilds

public boolean cancelAllBuilds()
                        throws BuildManagerException

Description copied from interface: BuildsManager

Cancels all the builds in all the overall queues.

Specified by:

cancelAllBuilds in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.cancelAllBuilds()

cancelAllCheckouts

public boolean cancelAllCheckouts()
                           throws BuildManagerException

Specified by:

cancelAllCheckouts in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.cancelAllCheckouts()

cancelBuild

public boolean cancelBuild(int projectId)
                    throws BuildManagerException

Description copied from interface: BuildsManager

Cancels the specified project's build.

Specified by:

cancelBuild in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.cancelBuild(int)

cancelCheckout

public boolean cancelCheckout(int projectId)
                       throws BuildManagerException

Specified by:

cancelCheckout in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.cancelCheckout(int)

cancelPrepareBuild

public boolean cancelPrepareBuild(int projectGroupId,
                                  int scmRootId)
                           throws BuildManagerException

Description copied from interface: BuildsManager

Cancels the specified project group prepare build

Specified by:

cancelPrepareBuild in interface BuildsManager

Returns:

Throws:

BuildManagerException

cancelPrepareBuild

public boolean cancelPrepareBuild(int projectId)
                           throws BuildManagerException

Description copied from interface: BuildsManager

Cancels the specified project prepare build

Specified by:

cancelPrepareBuild in interface BuildsManager

Returns:

Throws:

BuildManagerException

checkoutProject

public void checkoutProject(int projectId,
                            String projectName,
                            File workingDirectory,
                            String scmRootUrl,
                            String scmUsername,
                            String scmPassword,
                            BuildDefinition defaultBuildDefinition,
                            List<Project> subProjects)
                     throws BuildManagerException

Description copied from interface: BuildsManager

Adds the project to the checkout queue of the overall build queue with the least amount of tasks queued. The overall queue is chosen from the pool of queues attached to the schedule of the build definition.

Specified by:

checkoutProject in interface BuildsManager

scmRootUrl - TODO

subProjects - TODO

Throws:

BuildManagerException

See Also:

BuildsManager.checkoutProject(int, String, File, String, String, String, BuildDefinition, List)

isInAnyBuildQueue

public boolean isInAnyBuildQueue(int projectId)
                          throws BuildManagerException

Description copied from interface: BuildsManager

Checks whether the project build is queued.

Specified by:

isInAnyBuildQueue in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.isInAnyBuildQueue(int)

isInAnyBuildQueue

public boolean isInAnyBuildQueue(int projectId,
                                 int buildDefinitionId)
                          throws BuildManagerException

Description copied from interface: BuildsManager

Checks whether the project build using the specified build definition is queued.

Specified by:

isInAnyBuildQueue in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.isInAnyBuildQueue(int, int)

isInAnyCheckoutQueue

public boolean isInAnyCheckoutQueue(int projectId)
                             throws BuildManagerException

Description copied from interface: BuildsManager

Checks whether the project checkout is already queued.

Specified by:

isInAnyCheckoutQueue in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.isInAnyCheckoutQueue(int)

isAnyProjectCurrentlyBeingCheckedOut

public boolean isAnyProjectCurrentlyBeingCheckedOut(int[] projectIds)
                                             throws BuildManagerException

Description copied from interface: BuildsManager

Checks if at least one of the projects is currently being checked out.

Specified by:

isAnyProjectCurrentlyBeingCheckedOut in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.isAnyProjectCurrentlyBeingCheckedOut(int[])

isInPrepareBuildQueue

public boolean isInPrepareBuildQueue(int projectId)
                              throws BuildManagerException

Description copied from interface: BuildsManager

Checks whether the project is already in the prepare-build queue.

Specified by:

isInPrepareBuildQueue in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.isInPrepareBuildQueue(int)

isInPrepareBuildQueue

public boolean isInPrepareBuildQueue(int projectGroupId,
                                     int scmRootId)
                              throws BuildManagerException

Description copied from interface: BuildsManager

Checks where the project group is already in the prepare-build queue

Specified by:

isInPrepareBuildQueue in interface BuildsManager

Parameters:

projectGroupId -

scmRootId -

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.isInPrepareBuildQueue(int, int)

isProjectInAnyCurrentBuild

public boolean isProjectInAnyCurrentBuild(int projectId)
                                   throws BuildManagerException

Description copied from interface: BuildsManager

Checks whether the project is currently being built.

Specified by:

isProjectInAnyCurrentBuild in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.isProjectInAnyCurrentBuild(int)

prepareBuildProjects

public void prepareBuildProjects(Map<Integer,Integer> projectsBuildDefinitionsMap,
                                 BuildTrigger buildTrigger,
                                 int projectGroupId,
                                 String projectGroupName,
                                 String scmRootAddress,
                                 int scmRootId)
                          throws BuildManagerException

Description copied from interface: BuildsManager

Adds the projects in the prepare-build-queue.

Specified by:

prepareBuildProjects in interface BuildsManager

projectGroupId - TODO

scmRootAddress - TODO

Throws:

BuildManagerException

See Also:

BuildsManager.prepareBuildProjects(Map, BuildTrigger, int, String, String, int)

removeProjectFromBuildQueue

public void removeProjectFromBuildQueue(int projectId)
                                 throws BuildManagerException

Description copied from interface: BuildsManager

Removes the project from the build queue.

Specified by:

removeProjectFromBuildQueue in interface BuildsManager

Throws:

BuildManagerException

See Also:

BuildsManager.removeProjectFromBuildQueue(int)

removeProjectFromBuildQueue

public void removeProjectFromBuildQueue(int projectId,
                                        int buildDefinitionId,
                                        BuildTrigger buildTrigger,
                                        String projectName,
                                        int projectGroupId)
                                 throws BuildManagerException

Description copied from interface: BuildsManager

Removes the project built using the specified build definition from the build queue.

Specified by:

removeProjectFromBuildQueue in interface BuildsManager

Throws:

BuildManagerException

See Also:

BuildsManager.removeProjectFromBuildQueue(int, int, BuildTrigger, String, int)

removeProjectFromCheckoutQueue

public void removeProjectFromCheckoutQueue(int projectId)
                                    throws BuildManagerException

Description copied from interface: BuildsManager

Removes the project from the checkout queue.

Specified by:

removeProjectFromCheckoutQueue in interface BuildsManager

Throws:

BuildManagerException

See Also:

BuildsManager.removeProjectFromCheckoutQueue(int)

removeProjectsFromBuildQueue

public void removeProjectsFromBuildQueue(int[] projectIds)

Description copied from interface: BuildsManager

Removes the specified projects from their build queues.

Specified by:

removeProjectsFromBuildQueue in interface BuildsManager

See Also:

BuildsManager.removeProjectsFromBuildQueue(int[])

removeProjectsFromCheckoutQueue

public void removeProjectsFromCheckoutQueue(int[] projectIds)

Description copied from interface: BuildsManager

Removes the specified projects from their checkout queues.

Specified by:

removeProjectsFromCheckoutQueue in interface BuildsManager

See Also:

BuildsManager.removeProjectsFromCheckoutQueue(int[])

removeProjectsFromCheckoutQueueWithHashcodes

public void removeProjectsFromCheckoutQueueWithHashcodes(int[] hashcodes)
                                                  throws BuildManagerException

Description copied from interface: BuildsManager

Removes a set of projects using the specified hashcodes from the checkout queues.

Specified by:

removeProjectsFromCheckoutQueueWithHashcodes in interface BuildsManager

Throws:

BuildManagerException

See Also:

BuildsManager.removeProjectsFromCheckoutQueueWithHashcodes(int[])

removeProjectsFromBuildQueueWithHashcodes

public void removeProjectsFromBuildQueueWithHashcodes(int[] hashcodes)
                                               throws BuildManagerException

Description copied from interface: BuildsManager

Removes a set of projects using the specified hashcodes from the build queues.

Specified by:

removeProjectsFromBuildQueueWithHashcodes in interface BuildsManager

Throws:

BuildManagerException

See Also:

BuildsManager.removeProjectsFromBuildQueueWithHashcodes(int[])

removeProjectGroupFromPrepareBuildQueue

public boolean removeProjectGroupFromPrepareBuildQueue(int projectGroupId,
                                                       String scmRootAddress)
                                                throws BuildManagerException

Specified by:

removeProjectGroupFromPrepareBuildQueue in interface BuildsManager

Throws:

BuildManagerException

addOverallBuildQueue

public void addOverallBuildQueue(BuildQueue buildQueue)
                          throws BuildManagerException

Description copied from interface: BuildsManager

Add an overall build queue.

Specified by:

addOverallBuildQueue in interface BuildsManager

Throws:

BuildManagerException - TODO

See Also:

BuildsManager.addOverallBuildQueue(BuildQueue)

removeOverallBuildQueue

public void removeOverallBuildQueue(int overallBuildQueueId)
                             throws BuildManagerException

Description copied from interface: BuildsManager

Remove an overall build queue.

Specified by:

removeOverallBuildQueue in interface BuildsManager

Throws:

BuildManagerException

See Also:

BuildsManager.removeOverallBuildQueue(int)

getOverallBuildQueues

public Map<Integer,OverallBuildQueue> getOverallBuildQueues()

getCurrentBuilds

public Map<String,BuildProjectTask> getCurrentBuilds()
                                              throws BuildManagerException

Description copied from interface: BuildsManager

Returns all the build tasks currently being executed.

Specified by:

getCurrentBuilds in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.getCurrentBuilds()

getCurrentCheckouts

public Map<String,CheckOutTask> getCurrentCheckouts()
                                             throws BuildManagerException

Description copied from interface: BuildsManager

Returns all the checkout tasks currently being executed.

Specified by:

getCurrentCheckouts in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.getCurrentCheckouts()

getProjectsInBuildQueues

public Map<String,List<BuildProjectTask>> getProjectsInBuildQueues()
                                                            throws BuildManagerException

Description copied from interface: BuildsManager

Returns all the overall build queues together with a list of the build tasks in it's build queue.

Specified by:

getProjectsInBuildQueues in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.getProjectsInBuildQueues()

getProjectsInCheckoutQueues

public Map<String,List<CheckOutTask>> getProjectsInCheckoutQueues()
                                                           throws BuildManagerException

Description copied from interface: BuildsManager

Returns all the overall build queues together with a list of checkout tasks in it's checkout queue.

Specified by:

getProjectsInCheckoutQueues in interface BuildsManager

Returns:

Throws:

BuildManagerException

See Also:

BuildsManager.getProjectsInCheckoutQueues()

cancelAllPrepareBuilds

public boolean cancelAllPrepareBuilds()
                               throws BuildManagerException

Description copied from interface: BuildsManager

Cancels all the prepare builds in all overall queues

Specified by:

cancelAllPrepareBuilds in interface BuildsManager

Throws:

BuildManagerException

See Also:

BuildsManager.cancelAllPrepareBuilds()

isBuildInProgress

public boolean isBuildInProgress()

Description copied from interface: BuildsManager

Checks whether a build is in progress.

Specified by:

isBuildInProgress in interface BuildsManager

Returns:

See Also:

BuildsManager.isBuildInProgress()

isProjectCurrentlyPreparingBuild

public boolean isProjectCurrentlyPreparingBuild(int projectId)
                                         throws BuildManagerException

Description copied from interface: BuildsManager

Checks whether project is currently preparing build

Specified by:

isProjectCurrentlyPreparingBuild in interface BuildsManager

Returns:

Throws:

BuildManagerException

isProjectGroupCurrentlyPreparingBuild

public boolean isProjectGroupCurrentlyPreparingBuild(int projectGroupId,
                                                     int scmRootId)
                                              throws BuildManagerException

Description copied from interface: BuildsManager

Checks whether project group is currently preparing build

Specified by:

isProjectGroupCurrentlyPreparingBuild in interface BuildsManager

Returns:

Throws:

BuildManagerException

getCurrentProjectInPrepareBuild

public Map<String,PrepareBuildProjectsTask> getCurrentProjectInPrepareBuild()
                                                                     throws BuildManagerException

Description copied from interface: BuildsManager

Return currently preparing build project.

Specified by:

getCurrentProjectInPrepareBuild in interface BuildsManager

Returns:

Throws:

BuildManagerException

getProjectsInPrepareBuildQueue

public Map<String,List<PrepareBuildProjectsTask>> getProjectsInPrepareBuildQueue()
                                                                          throws BuildManagerException

Description copied from interface: BuildsManager

Return all projects in prepare build queue.

Specified by:

getProjectsInPrepareBuildQueue in interface BuildsManager

Returns:

Throws:

BuildManagerException

removeProjectFromPrepareBuildQueue

public boolean removeProjectFromPrepareBuildQueue(int projectGroupId,
                                                  int scmRootId)
                                           throws BuildManagerException

Description copied from interface: BuildsManager

Remove a project from a prepare build queue.

Specified by:

removeProjectFromPrepareBuildQueue in interface BuildsManager

Returns:

Throws:

BuildManagerException

removeProjectsFromPrepareBuildQueueWithHashCodes

public void removeProjectsFromPrepareBuildQueueWithHashCodes(int[] hashCodes)
                                                      throws BuildManagerException

Description copied from interface: BuildsManager

Removes a set of projects using the specified hashcodes from the prepare build queues.

Specified by:

removeProjectsFromPrepareBuildQueueWithHashCodes in interface BuildsManager

Throws:

BuildManagerException

getOverallBuildQueueWhereProjectsInGroupAreQueued

public OverallBuildQueue getOverallBuildQueueWhereProjectsInGroupAreQueued(int projectGroupId)
                                                                    throws BuildManagerException

Throws:

BuildManagerException

isProjectCurrentlyBeingCheckedOut

public boolean isProjectCurrentlyBeingCheckedOut(int projectId)
                                          throws BuildManagerException

Description copied from interface: BuildsManager

Checks whether project is currently being checked out.

Specified by:

isProjectCurrentlyBeingCheckedOut in interface BuildsManager

Returns:

Throws:

BuildManagerException

isAnyProjectCurrentlyBuilding

public boolean isAnyProjectCurrentlyBuilding(int[] projectIds)
                                      throws BuildManagerException

Description copied from interface: BuildsManager

Checks if at least one of the projects is currently building.

Specified by:

isAnyProjectCurrentlyBuilding in interface BuildsManager

Returns:

Throws:

BuildManagerException

isAnyProjectCurrentlyPreparingBuild

public boolean isAnyProjectCurrentlyPreparingBuild(int[] projectIds)
                                            throws BuildManagerException

Description copied from interface: BuildsManager

Checks if at least one of the projects is currently preparing build

Specified by:

isAnyProjectCurrentlyPreparingBuild in interface BuildsManager

Returns:

Throws:

BuildManagerException

contextualize

public void contextualize(org.codehaus.plexus.context.Context context)
                   throws org.codehaus.plexus.context.ContextException

Specified by:

contextualize in interface org.codehaus.plexus.personality.plexus.lifecycle.phase.Contextualizable

Throws:

org.codehaus.plexus.context.ContextException

setContainer

public void setContainer(org.codehaus.plexus.PlexusContainer container)

setOverallBuildQueues

public void setOverallBuildQueues(Map<Integer,OverallBuildQueue> overallBuildQueues)

setConfigurationService

public void setConfigurationService(ConfigurationService configurationService)

setBuildQueueService

public void setBuildQueueService(BuildQueueService buildQueueService)

setBuildDefinitionDao

public void setBuildDefinitionDao(BuildDefinitionDao buildDefinitionDao)

setProjectDao

public void setProjectDao(ProjectDao projectDao)