|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
public interface RemoteBuildServer
Implementation of the interface is registered in XmlRpc at TeamCity server side.
Java clients are encouraged to use RemoteBuildServerFacade instead, which provides more high-level API.
| Field Summary | |
|---|---|
static java.lang.String |
REMOTE_BUILD_SERVER
|
| Method Summary | |
|---|---|
java.lang.String |
addToQueue(java.util.Vector addToQueueRequests,
java.lang.String rawTriggeredBy)
Adds one or more builds in the queue. |
byte[] |
fetchData(java.lang.String userId,
java.lang.String buildId,
java.lang.String sourceId,
java.lang.String whatToFetch)
Fetches binary data from the server. |
java.lang.String |
findBuildInstanceById(java.lang.String id)
Returns build instance data for the specified id |
java.lang.String |
findBuildRunnerByType(java.lang.String buildTypeId,
java.lang.String runnerType)
Returns the first found build runner of the specified type in the specified build configuration. |
java.lang.String |
findRemoteBuildDataByInstanceId(java.lang.String buildInstanceId)
Returns remote build infogiration for the specified remote build instance |
java.lang.String |
findUserById(java.lang.String userId)
Returns user for the specified id |
java.util.Vector |
getBuildFailedTests(java.lang.String buildId,
int startFromIdx,
int maxTestsToLoad)
Returns failed tests in the specified build instance, for running build currently executing test will be added to the list too. |
java.util.Vector |
getBuildInstanceLogMessages(java.lang.String buildId,
int skipMessages)
Returns messages logged for the specified build instance |
java.util.Vector |
getBuildInstanceLogMessages(java.lang.String buildId,
int skipMessages,
int maxCount)
Returns limited number of messages logged for the specified build instance |
java.util.Vector |
getBuildInstanceModifications(java.lang.String buildId,
int policyId,
boolean includeModificationsIfPreviousBuildIsAbsent)
Returns modifications detected between the specified build instance and previous build, selected according to the specified policy |
java.lang.String |
getBuildParameter(java.lang.String buildTypeId,
java.lang.String key)
Returns build parameter by parameter name. |
java.lang.String |
getBuildParameters(java.lang.String buildTypeId)
Returns the serialized build parameters map of build type specified. |
java.lang.String |
getBuildsWithArtifacts(java.util.Vector paths,
java.util.Vector buildTypeIds)
Returns last finished builds those contain given artifact files. |
java.util.Vector |
getBuildTypesWithArtifactDependencies(java.util.Vector buildTypeIds)
Returns the list of build types that have artifact dependencies. |
java.util.Vector |
getCanRunAndCompatibleAgents(java.lang.String builtTypeId,
boolean includeDisabled)
Returns the agents those are compatible with the specified build type, and on those specified build type can be run |
java.util.Vector |
getCommitters(java.lang.String buildId,
int selectPrevBuildPolicy)
Returns list of committers who made changes between the previous build selected according to the policy, and the specified one |
java.util.Vector |
getCompilationErrors(java.lang.String buildInstanceId)
Returns compilation errors of the specified build |
byte[] |
getContentAfter(java.lang.String modificationId,
java.lang.String fileName)
Returns file content, specified by the VcsChange, at the moment right after specified modification has been made |
byte[] |
getContentBefore(java.lang.String modificationId,
java.lang.String fileName)
Returns file content, which corresponded to file before specified modification has been made |
byte[] |
getFileContent(java.lang.String relativePath,
java.lang.String buildId)
Returns specified file content at the moment when specified build has been run |
java.util.Vector |
getFinishedBuilds(java.lang.String buildTypeId)
Returns all finished build instances in the specified configuration |
java.util.Vector |
getGroupedByPoolCanRunAndCompatibleAgents(java.lang.String builtTypeId,
boolean includeDisabled)
Returns the grouped by pool agents those are compatible with the specified build type, and on those specified build type can be run. |
java.lang.String |
getLastFinished(java.lang.String buildTypeId)
Returns last finished build in the specified configuration |
java.lang.String |
getLastSuccessfullyFinished(java.lang.String buildTypeId)
Returns last successful finished build instance for the specified configuration |
java.util.Vector |
getModificationFiles(java.lang.String modId,
boolean personalChange)
Returns list of VcsChange structures (changed files) corresponding to modification with specified id. |
java.util.Vector |
getModificationsSinceLastSuccessful(java.lang.String buildTypeId)
Returns all modifications detected since last successfully finished build has been run |
java.lang.String |
getNewFinishedBuilds(java.util.Vector buildIds,
java.util.Vector buildTypeIds)
Returns newly finished builds |
java.lang.String |
getParameters(java.lang.String buildTypeId)
Returns the serialized build and config parameters map of build type specified. |
java.util.Vector |
getPendingChanges(java.lang.String buildTypeId)
Returns all changes detected but not run for the specified configuration |
byte[] |
getPersonalContentAfter(java.lang.String modificationId,
java.lang.String fileName)
Returns file content, specified by the VcsChange, at the moment right after specified modification has been made for personal change |
byte[] |
getPersonalContentBefore(java.lang.String modificationId,
java.lang.String fileName)
Returns file content, which corresponded to file before specified modification has been made for personal change |
java.util.Vector |
getProjectCommitters(java.lang.String projectId)
Returns list of project commiters |
java.util.Vector |
getRegisteredAgents()
Returns all agents registered on the server |
java.util.Vector |
getRegisteredProjects(boolean loadInstances)
Returns snapshots for all projects registered on the server |
java.lang.String |
getResolvedArtifactDependencies(java.util.Vector buildTypeIds)
Resolves artifact dependencies for the specified build types. |
java.util.Vector |
getResponsibilityIds(java.lang.String userId)
Returns id list of all the configuration which are under specified user responsibility |
java.util.Vector |
getRunningBuilds(java.lang.String buildTypeId)
Returns all running build for the specified configuration |
java.util.Vector |
getUsers()
Returns all users |
java.lang.Boolean |
haveCommitDecision(java.util.Vector personalChangeIds)
Returns true if at least one of the specified personal changes has non-UNKNOWN commit decision |
java.lang.Boolean |
isSequenceBuildType(java.lang.String buildTypeId)
Returns whether the build type is a sequence one (has snapshot dependencies) |
java.lang.String |
lookUpBuildsWithArtifacts(java.util.Vector paths,
java.util.Vector buildTypeIds)
Returns last finished builds those contain given artifact files. |
java.lang.Boolean |
removeBuild(java.lang.String buildId)
Removes build instance from the server history |
java.lang.Boolean |
removeResponsible(java.lang.String buildTypeId,
boolean buildWasFixed,
java.lang.String comment)
Deprecated. use removeResponsible(String, boolean, String, String) |
java.lang.Boolean |
removeResponsible(java.lang.String buildTypeId,
boolean buildWasFixed,
java.lang.String comment,
java.lang.String userWhoPerformsTheActionId)
Takes off responsibility with user comment if build has been actually fixed |
java.lang.Boolean |
resetResponsible(java.lang.String buildTypeId,
java.lang.String message)
Takes off responsibility for the specified configuration |
java.lang.Boolean |
resetResponsible(java.util.Vector testNames,
java.lang.String projectId,
boolean wasFixed,
java.lang.String responsibleUserId,
java.lang.String comment,
java.lang.String userWhoPerformsTheActionId)
Removes responsibilities of specified tests |
java.lang.Boolean |
schedulePersonalChangeForDeletion(java.lang.String changeId,
java.lang.String userId)
Mark personal change as deleted and makes it invisible for user |
java.lang.Boolean |
setIsFixed(java.lang.String buildTypeId,
java.lang.String userId,
java.lang.String comment)
Sets fixed state for the specified configuration. |
java.lang.Boolean |
setPersonalChangeStatus(java.lang.String changeId,
int statusPriority)
sets status of personal change |
java.lang.Boolean |
setResponsible(java.lang.String buildTypeId,
java.lang.String userId,
java.lang.String comment)
Deprecated. use setResponsible(String, String, String, String) |
java.lang.Boolean |
setResponsible(java.lang.String buildTypeId,
java.lang.String responsibleUserId,
java.lang.String comment,
java.lang.String userWhoPerformsTheActionId)
Sets responsible person for the specified sonfiguration |
java.lang.Boolean |
setResponsible(java.util.Vector testNames,
java.lang.String projectId,
java.lang.String responsibleUserId,
java.lang.String comment,
java.lang.String userWhoPerformsTheActionId)
Sets responsibilities for specified tests |
java.lang.Boolean |
stopBuild(java.lang.String buildId,
java.lang.String userId,
java.lang.String reason)
Schedules specified build to be stopped |
java.lang.Boolean |
updateResponsibility(java.util.Vector itemIds,
java.lang.String newStateName,
java.lang.String responsibleUserId,
java.lang.String reporterUserId,
java.lang.String comment)
Updates responsibility for the specified items. |
| Field Detail |
|---|
static final java.lang.String REMOTE_BUILD_SERVER
| Method Detail |
|---|
java.util.Vector getRegisteredAgents()
java.util.Vector getRegisteredProjects(boolean loadInstances)
loadInstances - should returned data contain runned and last finished builds data or not
java.util.Vector getBuildInstanceLogMessages(java.lang.String buildId,
int skipMessages)
buildId - build instance idskipMessages - how many messages should be skipped
java.util.Vector getBuildInstanceLogMessages(java.lang.String buildId,
int skipMessages,
int maxCount)
buildId - build instance idskipMessages - how many messages should be skippedmaxCount - returns no more messages than this parameter value
java.util.Vector getRunningBuilds(java.lang.String buildTypeId)
buildTypeId - configuration id
java.util.Vector getFinishedBuilds(java.lang.String buildTypeId)
buildTypeId - configuration id
java.util.Vector getBuildFailedTests(java.lang.String buildId,
int startFromIdx,
int maxTestsToLoad)
buildId - build instance idstartFromIdx - how many tests should be skippedmaxTestsToLoad - how many tests to load, -1 to load all tests
java.util.Vector getBuildInstanceModifications(java.lang.String buildId,
int policyId,
boolean includeModificationsIfPreviousBuildIsAbsent)
buildId - build instance idpolicyId - policy id, see jetbrains.buildServer.vcs.SelectPrevBuildPolicyincludeModificationsIfPreviousBuildIsAbsent - - should method return something if build, selected according to policy, is absent
byte[] getContentAfter(java.lang.String modificationId,
java.lang.String fileName)
throws VcsException
modificationId - modification idfileName - file name, from VcsChange
VcsException - error while receiving content from the vcs server.
byte[] getContentBefore(java.lang.String modificationId,
java.lang.String fileName)
throws VcsException
modificationId - modification idfileName - file name, from VcsChange
VcsException - error while receiving content from the vcs server.
byte[] getPersonalContentAfter(java.lang.String modificationId,
java.lang.String fileName)
throws VcsException
modificationId - modification idfileName - file name, from VcsChange
VcsException - error while receiving content from the vcs server.
byte[] getPersonalContentBefore(java.lang.String modificationId,
java.lang.String fileName)
throws VcsException
modificationId - modification idfileName - file name, from VcsChange
VcsException - error while receiving content from the vcs server.
java.lang.String addToQueue(java.util.Vector addToQueueRequests,
java.lang.String rawTriggeredBy)
AddToQueueRequest objects.
addToQueueRequests - vector of serialized AddToQueueRequest objectsrawTriggeredBy - triggered by text (see also TriggeredByBuilder)
AddToQueueResult
@NotNull
java.lang.String getResolvedArtifactDependencies(@NotNull
java.util.Vector buildTypeIds)
buildTypeIds - Ids of build types to resolve artifact dependencies for.
@NotNull
java.util.Vector getBuildTypesWithArtifactDependencies(@NotNull
java.util.Vector buildTypeIds)
buildTypeIds - Ids of build types to check. Pass empty vector to check all build types.
@NotNull
java.lang.String getBuildsWithArtifacts(@NotNull
java.util.Vector paths,
@NotNull
java.util.Vector buildTypeIds)
paths - vector of artifact paths that should be in the finished build.buildTypeIds - Ids of build types to check buils in. Pass empty vector to check all build types.
@NotNull
java.lang.String lookUpBuildsWithArtifacts(@NotNull
java.util.Vector paths,
@NotNull
java.util.Vector buildTypeIds)
paths - vector of artifact paths that should be in the finished build.buildTypeIds - Ids of build types to check buils in. Pass empty vector to check all build types.
@Nullable java.lang.String getLastFinished(java.lang.String buildTypeId)
buildTypeId - configuration id
java.lang.String getNewFinishedBuilds(java.util.Vector buildIds,
java.util.Vector buildTypeIds)
buildIds - For each build from this list this method will find later last finished build in the same build type.
If it exists it will be added to result.buildTypeId - Last finished build from each of these build types will be added to the result (if exists).
java.util.Vector getCompilationErrors(java.lang.String buildInstanceId)
buildInstanceId - build id
java.util.Vector getPendingChanges(java.lang.String buildTypeId)
buildTypeId - configuration id
java.util.Vector getModificationsSinceLastSuccessful(java.lang.String buildTypeId)
buildTypeId - configuration id
java.lang.String findBuildInstanceById(java.lang.String id)
id - buildId build instance id
java.lang.String getBuildParameters(java.lang.String buildTypeId)
buildTypeId - the build type id
BuildType.getBuildParameters()java.lang.String getParameters(java.lang.String buildTypeId)
buildTypeId - the build type id
BuildType.getParameters()java.lang.Boolean isSequenceBuildType(java.lang.String buildTypeId)
buildTypeId - the build type id
java.lang.Boolean updateResponsibility(java.util.Vector itemIds,
java.lang.String newStateName,
java.lang.String responsibleUserId,
java.lang.String reporterUserId,
java.lang.String comment)
itemIds - list of the item idsnewStateName - name of the new responsibility stateresponsibleUserId - id of the responsible userreporterUserId - id of the reporter usercomment - comment
java.lang.Boolean setResponsible(java.lang.String buildTypeId,
java.lang.String userId,
java.lang.String comment)
setResponsible(String, String, String, String)
buildTypeId - configuration iduserId - TeamCity user idcomment - user comment
java.lang.Boolean setResponsible(java.lang.String buildTypeId,
java.lang.String responsibleUserId,
java.lang.String comment,
java.lang.String userWhoPerformsTheActionId)
buildTypeId - configuration idresponsibleUserId - TeamCity user idcomment - user commentuserWhoPerformsTheActionId - user
java.lang.Boolean resetResponsible(java.lang.String buildTypeId,
java.lang.String message)
buildTypeId - configuration idmessage - responsibility reset message
java.lang.Boolean removeResponsible(java.lang.String buildTypeId,
boolean buildWasFixed,
java.lang.String comment)
removeResponsible(String, boolean, String, String)
buildTypeId - configuration idbuildWasFixed - user comment if build was actually fixedcomment - - user comment
java.lang.Boolean removeResponsible(java.lang.String buildTypeId,
boolean buildWasFixed,
java.lang.String comment,
java.lang.String userWhoPerformsTheActionId)
buildTypeId - configuration idbuildWasFixed - user comment if build was actually fixedcomment - - user commentuserWhoPerformsTheActionId - id fo user who performs the action
java.lang.Boolean setResponsible(java.util.Vector testNames,
java.lang.String projectId,
java.lang.String responsibleUserId,
java.lang.String comment,
java.lang.String userWhoPerformsTheActionId)
testNames - test name idsprojectId - project idresponsibleUserId - responsible user idcomment - user commentuserWhoPerformsTheActionId - id of user who performs the action
java.lang.Boolean resetResponsible(java.util.Vector testNames,
java.lang.String projectId,
boolean wasFixed,
java.lang.String responsibleUserId,
java.lang.String comment,
java.lang.String userWhoPerformsTheActionId)
testNames - test name idsprojectId - project idwasFixed - was fixedresponsibleUserId - responsible user idcomment - user commentuserWhoPerformsTheActionId - id of user who performs the action
java.util.Vector getResponsibilityIds(java.lang.String userId)
userId - TeamCity iser id
java.lang.String findRemoteBuildDataByInstanceId(java.lang.String buildInstanceId)
buildInstanceId - build instance id
java.lang.String findUserById(java.lang.String userId)
userId - TeamCity user id
java.util.Vector getUsers()
java.util.Vector getProjectCommitters(java.lang.String projectId)
projectId - TeamCity project id
java.lang.Boolean stopBuild(java.lang.String buildId,
java.lang.String userId,
java.lang.String reason)
buildId - build instance iduserId - current used id.reason - reason why build is stopped.
byte[] fetchData(java.lang.String userId,
java.lang.String buildId,
java.lang.String sourceId,
java.lang.String whatToFetch)
userId - current user id.buildId - build id to fetch data for.sourceId - data provider id ("Inspection", "Duplicator" e.t.c)whatToFetch - specified path to fetch data for.
java.util.Vector getCommitters(java.lang.String buildId,
int selectPrevBuildPolicy)
buildId - build instance idselectPrevBuildPolicy - - SelectPrevBuildPolicy enum element id
byte[] getFileContent(java.lang.String relativePath,
java.lang.String buildId)
relativePath - file path relative to project rootbuildId - build instance id
java.lang.String getLastSuccessfullyFinished(java.lang.String buildTypeId)
buildTypeId - build instance id
java.lang.Boolean removeBuild(java.lang.String buildId)
buildId - finished build isntace id
java.lang.Boolean schedulePersonalChangeForDeletion(java.lang.String changeId,
java.lang.String userId)
changeId - personal change iduserId - current user id.
java.lang.String getBuildParameter(java.lang.String buildTypeId,
java.lang.String key)
buildTypeId - configuration id.key - param name.
java.lang.Boolean setPersonalChangeStatus(java.lang.String changeId,
int statusPriority)
changeId - personal change idstatusPriority - status priority (see Status.getPriority())
java.lang.Boolean setIsFixed(java.lang.String buildTypeId,
java.lang.String userId,
java.lang.String comment)
buildTypeId - configuration for which fixed status has to be setuserId - unique user identifier, which corresponds to the user, which will be
responsible for the specified configuration fixcomment - user comment why this user sets fixed status for the configuration. Can be empty.
java.util.Vector getCanRunAndCompatibleAgents(java.lang.String builtTypeId,
boolean includeDisabled)
builtTypeId - Build type idincludeDisabled - includeDisabled
java.util.Vector getGroupedByPoolCanRunAndCompatibleAgents(java.lang.String builtTypeId,
boolean includeDisabled)
builtTypeId - Build type idincludeDisabled - includeDisabled
java.lang.Boolean haveCommitDecision(java.util.Vector personalChangeIds)
personalChangeIds - personal change ids
java.util.Vector getModificationFiles(java.lang.String modId,
boolean personalChange)
modId - id of VCS modificationpersonalChange - if true then files from personal change will be returned
java.lang.String findBuildRunnerByType(java.lang.String buildTypeId,
java.lang.String runnerType)
buildTypeId - build configuration idrunnerType - type of the runner
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||