Package jetbrains.buildServer.serverProxy

Interface RemoteBuildServer

  • All Known Implementing Classes:
    XmlRpcBasedRemoteServer
    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.

    • Method Detail

      • getRegisteredAgents

        Vector getRegisteredAgents()
        Returns all agents registered on the server
        Returns:
        Vector of strings. Each string is serialized with XStream object of class BuildAgentData

      • getRegisteredProjects

        Vector getRegisteredProjects​(boolean loadInstances)
        Returns snapshots for all projects registered on the server
        Parameters:
        loadInstances - should returned data contain running and last finished builds data or not
        Returns:
        Vector of strings. Each string is serialized with XStream object of class ProjectData @param loadInstances

      • getRelatedProjects

        Vector getRelatedProjects​(Vector buildTypeIds)
        Returns projects of specified build configurations and all their parents in project hierarchy.
        Parameters:
        buildTypeIds - Ids of build configuration
        Returns:
        Vector of strings. Each string is serialized with XStream object of class ProjectData. No running and last finished builds data is provided.
        Since:
        8.0

      • getBuildInstanceLogMessages

        Vector getBuildInstanceLogMessages​(String buildId,
                                   int skipMessages)
        Returns messages logged for the specified build instance
        Parameters:
        buildId - build instance id
        skipMessages - how many messages should be skipped
        Returns:
        Vector of strings.

      • getBuildInstanceLogMessages

        Vector getBuildInstanceLogMessages​(String buildId,
                                   int skipMessages,
                                   int maxCount)
        Returns limited number of messages logged for the specified build instance
        Parameters:
        buildId - build instance id
        skipMessages - how many messages should be skipped
        maxCount - returns no more messages than this parameter value
        Returns:
        Vector of strings.

      • getRunningBuilds

        Vector getRunningBuilds​(String buildTypeId)
        Returns all running build for the specified configuration
        Parameters:
        buildTypeId - configuration id
        Returns:
        Vector of strings. Each string is serialized with XStream object of class BuildInstanceData

      • getFinishedBuilds

        Vector getFinishedBuilds​(String buildTypeId)
        Returns all finished build instances in the specified configuration
        Parameters:
        buildTypeId - configuration id
        Returns:
        Vector of strings. Each string is serialized with XStream object of class BuildInstanceData

      • getBuildFailedTests

        Vector getBuildFailedTests​(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.
        Parameters:
        buildId - build instance id
        startFromIdx - how many tests should be skipped
        maxTestsToLoad - how many tests to load, -1 to load all tests
        Returns:
        Vector of strings.

      • getBuildInstanceModifications

        Vector getBuildInstanceModifications​(String buildId,
                                     int policyId,
                                     boolean includeModificationsIfPreviousBuildIsAbsent)
        Returns modifications detected between the specified build instance and previous build, selected according to the specified policy
        Parameters:
        buildId - build instance id
        policyId - policy id, see jetbrains.buildServer.vcs.SelectPrevBuildPolicy
        includeModificationsIfPreviousBuildIsAbsent - - should method return something if build, selected according to policy, is absent
        Returns:
        Vector of strings. Each string is serialized with XStream object of class VcsModificationData

      • getContentAfter

        byte[] getContentAfter​(String modificationId,
                       String fileName)
                throws VcsException
        Returns file content, specified by the VcsChange, at the moment right after specified modification has been made
        Parameters:
        modificationId - modification id
        fileName - file name, from VcsChange
        Returns:
        byte content of a specific file version after modification
        Throws:
        VcsException - error while receiving content from the vcs server.

      • getContentBefore

        byte[] getContentBefore​(String modificationId,
                        String fileName)
                 throws VcsException
        Returns file content, which corresponded to file before specified modification has been made
        Parameters:
        modificationId - modification id
        fileName - file name, from VcsChange
        Returns:
        byte content of a specific file version before modification
        Throws:
        VcsException - error while receiving content from the vcs server.

      • getPersonalContentAfter

        byte[] getPersonalContentAfter​(String modificationId,
                               String fileName)
                        throws VcsException
        Returns file content, specified by the VcsChange, at the moment right after specified modification has been made for personal change
        Parameters:
        modificationId - modification id
        fileName - file name, from VcsChange
        Returns:
        byte content of a specific file version after modification
        Throws:
        VcsException - error while receiving content from the vcs server.

      • getPersonalContentBefore

        byte[] getPersonalContentBefore​(String modificationId,
                                String fileName)
                         throws VcsException
        Returns file content, which corresponded to file before specified modification has been made for personal change
        Parameters:
        modificationId - modification id
        fileName - file name, from VcsChange
        Returns:
        byte content of a specific file version before modification
        Throws:
        VcsException - error while receiving content from the vcs server.

      • getResolvedArtifactDependencies

        @NotNull
String getResolvedArtifactDependencies​(@NotNull
                                       Vector buildTypeIds)
        Resolves artifact dependencies for the specified build types.
        Parameters:
        buildTypeIds - Ids of build types to resolve artifact dependencies for.
        Returns:
        serialized Map<String, List<ArtifactDependencyInfo>> (build type id -> list of resolved dependencies).
        Since:
        6.5

      • getBuildTypesWithArtifactDependencies

        @NotNull
Vector getBuildTypesWithArtifactDependencies​(@NotNull
                                             Vector buildTypeIds)
        Returns the list of build types that have artifact dependencies.
        Parameters:
        buildTypeIds - Ids of build types to check. Pass empty vector to check all build types.
        Returns:
        vector of build type ids.
        Since:
        6.5

      • getBuildTypesWithTests

        @NotNull
Vector getBuildTypesWithTests​(@NotNull
                              Vector buildTypeIds)
        Returns the list of build types those have tests.
        Parameters:
        buildTypeIds - Ids of build types to check. Pass empty vector to check all build types.
        Returns:
        vector of build type ids.
        Since:
        7.1

      • getBuildsWithArtifacts

        @NotNull
String getBuildsWithArtifacts​(@NotNull
                              Vector paths,
                              @NotNull
                              Vector buildTypeIds)
        Returns last finished builds those contain given artifact files. This method only checks last finished builds. No history lookup is performed to find older build that may have contained the path.
        Parameters:
        paths - vector of artifact paths that should be in the finished build.
        buildTypeIds - Ids of build types to check builds in. Pass empty vector to check all build types.
        Returns:
        List<BuildInstanceData>.
        Since:
        6.5

      • lookUpBuildsWithArtifacts

        @NotNull
String lookUpBuildsWithArtifacts​(@NotNull
                                 Vector paths,
                                 @NotNull
                                 Vector buildTypeIds)
        Returns last finished builds those contain given artifact files. Performs history lookup to find older build that may have contained the path.
        Parameters:
        paths - vector of artifact paths that should be in the finished build.
        buildTypeIds - Ids of build types to check builds in. Pass empty vector to check all build types.
        Returns:
        List<BuildInstanceData>.
        Since:
        6.5.6

      • getLastFinished

        @Nullable
String getLastFinished​(String buildTypeId)
        Returns last finished build in the specified configuration
        Parameters:
        buildTypeId - configuration id
        Returns:
        serialized with XStream object of class BuildInstanceData

      • getNewFinishedBuilds

        String getNewFinishedBuilds​(Vector buildIds,
                            Vector buildTypeIds)
        Returns newly finished builds
        Parameters:
        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.
        buildTypeIds - Last finished build from each of these build types will be added to the result (if exists).
        Returns:
        Serialized with XStream List of BuildInstanceData

      • getCompilationErrors

        Vector getCompilationErrors​(String buildInstanceId)
        Returns compilation errors of the specified build
        Parameters:
        buildInstanceId - build id
        Returns:
        Vector of strings

      • getPendingChanges

        Vector getPendingChanges​(String buildTypeId)
        Returns all changes detected but not run for the specified configuration
        Parameters:
        buildTypeId - configuration id
        Returns:
        Vector of strings. Each string is serialized with XStream object of class VcsModificationData

      • getModificationsSinceLastSuccessful

        Vector getModificationsSinceLastSuccessful​(String buildTypeId)
        Returns all modifications detected since last successfully finished build has been run
        Parameters:
        buildTypeId - configuration id
        Returns:
        Vector of strings. Each string is serialized with XStream object of class VcsModificationData

      • findBuildInstanceById

        String findBuildInstanceById​(String id)
        Returns build instance data for the specified id
        Parameters:
        id - buildId build instance id
        Returns:
        serialized with XStream object of class BuildInstanceData

      • getBuildParameters

        String getBuildParameters​(String buildTypeId)
        Returns the serialized build parameters map of build type specified.
        Parameters:
        buildTypeId - the build type id
        Returns:
        serialized with XStream object of Map<String, String>
        Since:
        5.1
        See Also:
        BuildType.getBuildParameters()

      • getParameters

        String getParameters​(String buildTypeId)
        Returns the serialized build and config parameters map of build type specified.
        Parameters:
        buildTypeId - the build type id
        Returns:
        serialized with XStream object of Map<String, String>
        Since:
        6.5
        See Also:
        BuildType.getParameters()

      • findFailedTests

        @NotNull
String findFailedTests​(String fileFullPath,
                       Vector testNames)
        Looks for the failed tests with the specified names in the build configurations, suitable with the specified file.
        Parameters:
        fileFullPath - full VCS file path
        testNames - test names
        Returns:
        serialized with XStream object of Map<String, List<BuildTestsData>> (build type id -> list of build tests datas)
        Since:
        8.0

      • findTests

        @NotNull
String findTests​(String fileFullPath,
                 Vector testNames)
        Looks for the tests (both failed and successful) with the specified names in the build configurations, suitable with the specified file.
        Parameters:
        fileFullPath - full VCS file path
        testNames - test names
        Returns:
        serialized with XStream object of Map<String, List<BuildTestsData>> (build type id -> list of build tests datas)
        Since:
        8.0

      • isSequenceBuildType

        Boolean isSequenceBuildType​(String buildTypeId)
        Returns whether the build type is a sequence one (has snapshot dependencies)
        Parameters:
        buildTypeId - the build type id
        Returns:
        true iff build type is a sequence one
        Since:
        5.1

      • muteProblems

        Boolean muteProblems​(Vector itemIds,
                     boolean unmuteWhenFixed,
                     String unmuteTimestamp,
                     Vector buildTypeIds,
                     Vector buildIds,
                     String userId,
                     String comment)
        Mutes the specified items. If both buildTypeIds and buildIds are empty, mutes items in projects.
        Parameters:
        itemIds - list of the item ids
        unmuteWhenFixed - true, if items must be unmuted automatically when fixed
        unmuteTimestamp - date of unmute in milliseconds, "-1" to not unmute by date
        buildTypeIds - build type ids to mute items in
        buildIds - build ids to mute items in
        userId - id of the user
        comment - comment
        Returns:
        fake
        Since:
        7.1

      • unmuteProblems

        Boolean unmuteProblems​(Vector itemIds,
                       String userId,
                       String comment)
        Unmutes the specified items.
        Parameters:
        itemIds - list of the item ids
        userId - id of the user
        comment - comment
        Returns:
        fake
        Since:
        7.1

      • updateResponsibility

        Boolean updateResponsibility​(Vector itemIds,
                             String newStateName,
                             String responsibleUserId,
                             String reporterUserId,
                             String comment,
                             String removeMethodName)
        Updates responsibility for the specified items.
        Parameters:
        itemIds - list of the item ids
        newStateName - name of the new responsibility state
        responsibleUserId - id of the responsible user
        reporterUserId - id of the reporter user
        comment - comment
        removeMethodName - remove method name
        Returns:
        fake
        Since:
        6.0

      • getResponsibilityIds

        Vector getResponsibilityIds​(String userId)
        Returns id list of all the configuration which are under specified user responsibility
        Parameters:
        userId - TeamCity user id
        Returns:
        Vector of strings. Each string is serialized with XStream object of class ResponsibilityInfoData

      • findUserById

        String findUserById​(String userId)
        Returns user for the specified id
        Parameters:
        userId - TeamCity user id
        Returns:
        serialized with XStream object of class User

      • getUsers

        Vector getUsers()
        Returns all users
        Returns:
        serialized with XStream vector of UserData
        Since:
        6.0

      • getProjectCommitters

        Vector getProjectCommitters​(String projectId)
        Returns list of project committers
        Parameters:
        projectId - TeamCity project id
        Returns:
        serialized with XStream vector of UserData
        Since:
        6.0

      • stopBuild

        Boolean stopBuild​(String buildId,
                  String userId,
                  String reason)
        Schedules specified build to be stopped
        Parameters:
        buildId - build instance id
        userId - current used id.
        reason - reason why build is stopped.
        Returns:
        fake return value.

      • stopPendingPersonalBuild

        Boolean stopPendingPersonalBuild​(String personalChangeId,
                                 String buildTypeId,
                                 String userId,
                                 String reason)
        Removes the specified personal build from the queue
        Parameters:
        personalChangeId - personal change id
        buildTypeId - build type id
        userId - current used id
        reason - reason why build is stopped
        Returns:
        fake return value

      • repeatRemoteDebugSession

        Boolean repeatRemoteDebugSession​(String personalChangeId,
                                 String buildTypeId)
        Repeats the current remote debug session on the certain agent, which is determined by personal change id and build type id
        Parameters:
        personalChangeId - personal change id
        buildTypeId - build type id
        Returns:
        fake return value

      • repeatRemoteDebugSessionWithNewChanges

        Boolean repeatRemoteDebugSessionWithNewChanges​(String personalChangeId,
                                               String buildTypeId,
                                               String newChangesPersonalPatchId)
        Applies new personal patch and repeats the current remote debug session on the certain agent, which is determined by personal change id and build type id
        Parameters:
        personalChangeId - personal change id
        buildTypeId - build type id
        Returns:
        fake return value

      • finishRemoteDebugSession

        Boolean finishRemoteDebugSession​(String personalChangeId,
                                 String buildTypeId)
        Finishes the current remote debug session on the certain agent, which is determined by personal change id and build type id
        Parameters:
        personalChangeId - personal change id
        buildTypeId - build type id
        Returns:
        fake return value

      • fetchData

        byte[] fetchData​(String userId,
                 String buildId,
                 String sourceId,
                 String whatToFetch)
        Fetches binary data from the server.
        Parameters:
        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.
        Returns:
        data binary array.

      • getCommitters

        Vector getCommitters​(String buildId,
                     int selectPrevBuildPolicy)
        Returns list of committers who made changes between the previous build selected according to the policy, and the specified one
        Parameters:
        buildId - build instance id
        selectPrevBuildPolicy - - SelectPrevBuildPolicy enum element id
        Returns:
        Vector of strings. Each string is serialized with XStream object of class User

      • getFileContent

        byte[] getFileContent​(String relativePath,
                      String buildId)
        Returns specified file content at the moment when specified build has been run
        Parameters:
        relativePath - file path relative to project root
        buildId - build instance id
        Returns:
        byte content of specific file in specific build

      • getLastSuccessfullyFinished

        String getLastSuccessfullyFinished​(String buildTypeId)
        Returns last successful finished build instance for the specified configuration
        Parameters:
        buildTypeId - build instance id
        Returns:
        serialized object of type BuildInstanceData

      • removeBuild

        Boolean removeBuild​(String buildId)
        Removes build instance from the server history
        Parameters:
        buildId - finished build instance id
        Returns:
        fake

      • schedulePersonalChangeForDeletion

        Boolean schedulePersonalChangeForDeletion​(String changeId,
                                          String userId)
        Mark personal change as deleted and makes it invisible for user
        Parameters:
        changeId - personal change id
        userId - current user id.
        Returns:
        fake

      • getBuildParameter

        String getBuildParameter​(String buildTypeId,
                         String key)
        Returns build parameter by parameter name.
        Parameters:
        buildTypeId - configuration id.
        key - param name.
        Returns:
        serialized with XStream object of class String

      • setPersonalChangeStatus

        Boolean setPersonalChangeStatus​(String changeId,
                                int statusPriority)
        sets status of personal change
        Parameters:
        changeId - personal change id
        statusPriority - status priority (see Status.getPriority())
        Returns:
        Ignored. Used for XmlRpc

      • getCanRunAndCompatibleAgents

        Vector getCanRunAndCompatibleAgents​(String builtTypeId,
                                    boolean includeDisabled)
        Returns the agents those are compatible with the specified build type, and on those specified build type can be run
        Parameters:
        builtTypeId - Build type id
        includeDisabled - includeDisabled
        Returns:
        Vector of serialized BuildAgentData objects

      • getGroupedByPoolCanRunAndCompatibleAgents

        Vector getGroupedByPoolCanRunAndCompatibleAgents​(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. If there is only one pool in the system, then result contains only one pair, and the pool data in that pair is null.
        Parameters:
        builtTypeId - Build type id
        includeDisabled - includeDisabled
        Returns:
        Vector of serialized Pair<AgentPoolData, List<BuildAgentData>> objects

      • haveCommitDecision

        Boolean haveCommitDecision​(Vector personalChangeIds)
        Returns true if at least one of the specified personal changes has non-UNKNOWN commit decision
        Parameters:
        personalChangeIds - personal change ids
        Returns:
        see above

      • getModificationFiles

        Vector getModificationFiles​(String modId,
                            boolean personalChange)
        Returns list of VcsChange structures (changed files) corresponding to modification with specified id.
        Parameters:
        modId - id of VCS modification
        personalChange - if true then files from personal change will be returned
        Returns:
        see above

      • findBuildRunnerByType

        String findBuildRunnerByType​(String buildTypeId,
                             String runnerType)
        Returns the first found build runner of the specified type in the specified build configuration.
        Parameters:
        buildTypeId - build configuration id
        runnerType - type of the runner
        Returns:
        the first found runner
        Since:
        6.0

      • getBuildRunners

        String getBuildRunners​(Vector buildTypeIds)
        Returns map from build type ids to lists of enabled build runners for the specified build types.
        Parameters:
        buildTypeIds - build configuration ids
        Returns:
        serialized object of type Map<String, List<BuildRunnerData>>
        Since:
        8.0

      • getProblemRelatedEventCounters

        String getProblemRelatedEventCounters​(Vector projectIds)
        Returns problem related event counters for specified projects.
        Parameters:
        projectIds - project ids
        Returns:
        serialized map (project id -> counter)
        Since:
        7.1