org.apache.continuum.buildagent
Interface ContinuumBuildAgentService

All Known Implementing Classes:
ContinuumBuildAgentServiceImpl

public interface ContinuumBuildAgentService


Method Summary
 void buildProjects(List<Map<String,Object>> projectsBuildContext)
           
 void cancelBuild()
           
 void executeDirectoryPurge(String directoryType, int daysOlder, int retentionCount, boolean deleteAll)
          Execute a directory purge on the build agent
 String generateWorkingCopyContent(int projectId, String userDirectory, String baseUrl, String imagesBaseUrl)
           
 List<Map<String,String>> getAvailableInstallations()
           
 String getBuildAgentPlatform()
          Get build agent's platform.
 Map<String,Object> getBuildResult(int projectId)
           
 int getBuildSizeOfAgent()
           
 Map<String,Object> getListener(String releaseId)
           
 String getPreparedReleaseName(String releaseId)
           
 Map<String,Object> getProjectCurrentlyBuilding()
           
 Map<String,Object> getProjectCurrentlyPreparingBuild()
           
 Map<String,Object> getProjectFile(int projectId, String directory, String filename)
           
 List<Map<String,Object>> getProjectsAndBuildDefinitionsCurrentlyPreparingBuild()
           
 List<Map<String,Object>> getProjectsAndBuildDefinitionsInPrepareBuildQueue()
           
 List<Map<String,Object>> getProjectsInBuildQueue()
           
 List<Map<String,Object>> getProjectsInPrepareBuildQueue()
           
 Map<String,Object> getReleasePluginParameters(int projectId, String pomFilename)
           
 Map<String,Object> getReleaseResult(String releaseId)
           
 boolean isExecutingBuild()
          Determines if build agent is currently executing a build
 boolean isExecutingRelease()
          Determines if build agent is currently executing a release
 boolean isProjectCurrentlyBuilding(int projectId, int buildDefinitionId)
           
 boolean isProjectCurrentlyPreparingBuild(int projectId, int buildDefinitionId)
           
 boolean isProjectGroupCurrentlyPreparingBuild(int projectGroupId)
           
 boolean isProjectGroupInPrepareBuildQueue(int projectGroupId)
           
 boolean isProjectGroupInQueue(int projectGroupId)
           
 boolean isProjectInBuildQueue(int projectId, int buildDefinitionId)
           
 boolean isProjectInPrepareBuildQueue(int projectId, int buildDefinitionId)
           
 boolean isProjectScmRootInQueue(int projectScmRootId, List<Integer> projectIds)
           
 boolean ping()
           
 List<Map<String,String>> processProject(int projectId, String pomFilename, boolean autoVersionSubmodules)
           
 String releaseCleanup(String releaseId)
           
 void releasePerform(String releaseId, String goals, String arguments, boolean useReleaseProfile, Map repository, String username)
           
 String releasePerformFromScm(String goals, String arguments, boolean useReleaseProfile, Map repository, String scmUrl, String scmUsername, String scmPassword, String scmTag, String scmTagBase, Map<String,String> environments, String username)
           
 String releasePrepare(Map project, Properties properties, Map releaseVersion, Map developmentVersion, Map<String,String> environments, String username)
           
 void releaseRollback(String releaseId, int projectId)
           
 boolean removeFromBuildQueue(int projectId, int builddefinitonId)
           
 void removeFromBuildQueue(List<String> hashCodes)
           
 boolean removeFromPrepareBuildQueue(int projectGroupId, int scmRootId)
           
 void removeFromPrepareBuildQueue(List<String> hashCodes)
           
 void removeListener(String releaseId)
           
 

Method Detail

buildProjects

void buildProjects(List<Map<String,Object>> projectsBuildContext)
                   throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getAvailableInstallations

List<Map<String,String>> getAvailableInstallations()
                                                   throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getBuildResult

Map<String,Object> getBuildResult(int projectId)
                                  throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getProjectCurrentlyBuilding

Map<String,Object> getProjectCurrentlyBuilding()
                                               throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

cancelBuild

void cancelBuild()
                 throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

generateWorkingCopyContent

String generateWorkingCopyContent(int projectId,
                                  String userDirectory,
                                  String baseUrl,
                                  String imagesBaseUrl)
                                  throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getProjectFile

Map<String,Object> getProjectFile(int projectId,
                                  String directory,
                                  String filename)
                                  throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getReleasePluginParameters

Map<String,Object> getReleasePluginParameters(int projectId,
                                              String pomFilename)
                                              throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

processProject

List<Map<String,String>> processProject(int projectId,
                                        String pomFilename,
                                        boolean autoVersionSubmodules)
                                        throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

releasePrepare

String releasePrepare(Map project,
                      Properties properties,
                      Map releaseVersion,
                      Map developmentVersion,
                      Map<String,String> environments,
                      String username)
                      throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getReleaseResult

Map<String,Object> getReleaseResult(String releaseId)
                                    throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getListener

Map<String,Object> getListener(String releaseId)
                               throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

removeListener

void removeListener(String releaseId)
                    throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getPreparedReleaseName

String getPreparedReleaseName(String releaseId)
                              throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

releasePerform

void releasePerform(String releaseId,
                    String goals,
                    String arguments,
                    boolean useReleaseProfile,
                    Map repository,
                    String username)
                    throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

releasePerformFromScm

String releasePerformFromScm(String goals,
                             String arguments,
                             boolean useReleaseProfile,
                             Map repository,
                             String scmUrl,
                             String scmUsername,
                             String scmPassword,
                             String scmTag,
                             String scmTagBase,
                             Map<String,String> environments,
                             String username)
                             throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

releaseCleanup

String releaseCleanup(String releaseId)
                      throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

releaseRollback

void releaseRollback(String releaseId,
                     int projectId)
                     throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getProjectsInPrepareBuildQueue

List<Map<String,Object>> getProjectsInPrepareBuildQueue()
                                                        throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getProjectsAndBuildDefinitionsInPrepareBuildQueue

List<Map<String,Object>> getProjectsAndBuildDefinitionsInPrepareBuildQueue()
                                                                           throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getProjectsInBuildQueue

List<Map<String,Object>> getProjectsInBuildQueue()
                                                 throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getBuildSizeOfAgent

int getBuildSizeOfAgent()
                        throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getProjectCurrentlyPreparingBuild

Map<String,Object> getProjectCurrentlyPreparingBuild()
                                                     throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getProjectsAndBuildDefinitionsCurrentlyPreparingBuild

List<Map<String,Object>> getProjectsAndBuildDefinitionsCurrentlyPreparingBuild()
                                                                               throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

isProjectGroupInQueue

boolean isProjectGroupInQueue(int projectGroupId)

isProjectScmRootInQueue

boolean isProjectScmRootInQueue(int projectScmRootId,
                                List<Integer> projectIds)

isProjectCurrentlyBuilding

boolean isProjectCurrentlyBuilding(int projectId,
                                   int buildDefinitionId)

isProjectInBuildQueue

boolean isProjectInBuildQueue(int projectId,
                              int buildDefinitionId)

isProjectGroupInPrepareBuildQueue

boolean isProjectGroupInPrepareBuildQueue(int projectGroupId)

isProjectGroupCurrentlyPreparingBuild

boolean isProjectGroupCurrentlyPreparingBuild(int projectGroupId)

isProjectInPrepareBuildQueue

boolean isProjectInPrepareBuildQueue(int projectId,
                                     int buildDefinitionId)

isProjectCurrentlyPreparingBuild

boolean isProjectCurrentlyPreparingBuild(int projectId,
                                         int buildDefinitionId)

removeFromPrepareBuildQueue

boolean removeFromPrepareBuildQueue(int projectGroupId,
                                    int scmRootId)
                                    throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

removeFromPrepareBuildQueue

void removeFromPrepareBuildQueue(List<String> hashCodes)
                                 throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

removeFromBuildQueue

boolean removeFromBuildQueue(int projectId,
                             int builddefinitonId)
                             throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

removeFromBuildQueue

void removeFromBuildQueue(List<String> hashCodes)
                          throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

ping

boolean ping()
             throws ContinuumBuildAgentException
Throws:
ContinuumBuildAgentException

getBuildAgentPlatform

String getBuildAgentPlatform()
                             throws ContinuumBuildAgentException
Get build agent's platform.

Returns:
The operating system name of the build agent
Throws:
Exception
ContinuumBuildAgentException

isExecutingBuild

boolean isExecutingBuild()
Determines if build agent is currently executing a build

Returns:
true if executing build; false otherwise

isExecutingRelease

boolean isExecutingRelease()
                           throws ContinuumBuildAgentException
Determines if build agent is currently executing a release

Returns:
true if executing release; false otherwise
Throws:
ContinuumBuildAgentException - if unable to determine if buildagent is executing a release

executeDirectoryPurge

void executeDirectoryPurge(String directoryType,
                           int daysOlder,
                           int retentionCount,
                           boolean deleteAll)
                           throws ContinuumBuildAgentException
Execute a directory purge on the build agent

Parameters:
directoryType - valid types are working and releases
daysOlder - days older
retentionCount - retention count
deleteAll - delete all flag
Throws:
ContinuumBuildAgentException - error that will occur during the purge


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