Package jetbrains.buildServer.agentServer

Interface AgentLogListener

  • All Known Subinterfaces:
    Agent, BuildAgent, Server
    All Known Implementing Classes:
    XmlRpcAgentLogListener
    public interface AgentLogListener
    This is XML-RPC interface for events, related to build running and build messages collecting. It is implemented both on the agent side (to accept messages locally) and on the server side.

    • Method Summary

      All Methods Instance Methods Abstract Methods 
      Modifier and Type Method Description
      boolean buildDetachedFromAgent​(java.lang.String buildId, java.lang.String lastStepId)
      Indicates that the build tasks are finished on the agent but the build itself should continue until some external process finishes it
      boolean buildFinished​(java.lang.String buildId, java.util.Date finishDate, boolean buildFailed)  
      boolean buildInterrupted​(java.lang.String buildId)
      Same as buildInterrupted(String, String, boolean) with parameters: build, "", true
      boolean buildInterrupted​(java.lang.String buildId, java.lang.String comment, boolean needRequeue)  
      boolean isBuildFailing​(java.lang.String buildId)
      Checks for build status on the build server.
      boolean log​(java.lang.String buildId, java.util.Vector messagesXml)  

    • Method Detail

      • log

        boolean log​(java.lang.String buildId,
            java.util.Vector messagesXml)
        Parameters:
        buildId - - build id
        messagesXml - - message in XML format
        Returns:
        - returns value which indicates, whether this message was accepted by server; if false, no other messages with given buildId should be sent for corresponding buildId

      • buildFinished

        boolean buildFinished​(java.lang.String buildId,
                      java.util.Date finishDate,
                      boolean buildFailed)
        Parameters:
        buildId - - build id
        finishDate - - finish date
        buildFailed - - build failed sign
        Returns:
        - fake return type to conform XML-RPC requirements

      • buildDetachedFromAgent

        boolean buildDetachedFromAgent​(java.lang.String buildId,
                               java.lang.String lastStepId)
        Indicates that the build tasks are finished on the agent but the build itself should continue until some external process finishes it
        Parameters:
        buildId - - build id
        lastStepId - - id of last step
        Returns:
        - fake return type to conform XML-RPC requirements
        Since:
        2019.2

      • buildInterrupted

        boolean buildInterrupted​(java.lang.String buildId)
        Same as buildInterrupted(String, String, boolean) with parameters: build, "", true
        Parameters:
        buildId - - build id
        Returns:
        - fake return type to conform XML-RPC requirements

      • buildInterrupted

        boolean buildInterrupted​(java.lang.String buildId,
                         java.lang.String comment,
                         boolean needRequeue)
        Parameters:
        comment - a comment to interrupt the build with
        needRequeue - if true, build should be re-added to the build queue
        Returns:
        fake value, to conform XML-RPC requirements
        Since:
        2019.1

      • isBuildFailing

        boolean isBuildFailing​(java.lang.String buildId)
                throws java.lang.InterruptedException
        Checks for build status on the build server. The call is synchronous, it makes sure that previous logged messages are sent to the server.
        Returns:
        true if build status on the server is failing
        Throws:
        java.lang.InterruptedException - if action was removed from the queue for some reason, and could not be completed (for instance, build is obsolete)
        Since:
        8.0