Interface BuildRunner

    • Method Detail

      • getType

        @NonNls
        java.lang.String getType()
        Deprecated.
        Returns name of the runner, should match RunType.getType
        Returns:
        name of the runner, should match RunType.getType
      • run

        void run​(java.util.Map<java.lang.String,​java.lang.String> runnerParameters,
                 java.util.Map<java.lang.String,​java.lang.String> buildParameters,
                 BuildPostRunnable postRunnable,
                 java.io.File tempDir)
          throws RunBuildException
        Deprecated.
        Main method which is used to run the build. Method can be asynchronous, but it is required to call postRunnable upon build completion. Temp files should be created in tempDir.
        Parameters:
        runnerParameters - build runner parameters
        buildParameters - build parameters
        postRunnable - action to invoke after build runner finishes
        tempDir - temp directory
        Throws:
        RunBuildException - if error occurs
      • setLogger

        void setLogger​(BuildProgressLogger logger)
        Deprecated.
        sets build logger instance to the runner
        Parameters:
        logger - logger instance
      • getBuildLogger

        BuildProgressLogger getBuildLogger()
        Deprecated.
        Returns build server logger
        Returns:
        build server logger
      • canRun

        boolean canRun​(BuildAgentConfiguration agentConfiguration)
        Deprecated.
        Parameters:
        agentConfiguration - - current agent configuration
        Returns:
        true if the runner can run in this particular environment or not. For example, returning 'false' is a way for a runner to refuse to run on a system that is not supported by the runner If 'false' is returned, the Agent won't register the runner and it won't be advertised to the build server server during agent's registration
      • stopBuild

        void stopBuild()
        Deprecated.
        Method is invoked upon attempt to stop the build
      • isStopped

        boolean isStopped()
        Deprecated.
        Returns true if #stopBuild was invoked in the current build
        Returns:
        true if build stopped