Interface BuildAgentManager

    • Method Detail

      • getRegisteredAgents

        <T extends SBuildAgentList<T> getRegisteredAgents()
        Returns all registered authorized agents. Registered means connected at the moment of call.
        Returns:
        see above
      • getRegisteredAgents

        <T extends SBuildAgentList<T> getRegisteredAgents​(boolean includeUnauthorized)
        Returns all registered agents. Registered means connected at the moment of call.
        Parameters:
        includeUnauthorized - if true, unauthorized agents, i.e. agents which cannot run builds until authorized by admin
        Returns:
        see above
      • getUnregisteredAgents

        <T extends SBuildAgentList<T> getUnregisteredAgents()
        Returns list of all currently unregistered and authorized agents, i.e. agents registered on server some time ago, but currently unregistered by server because they are either not responding, or upgrading. This list doesn't include unauthorized agents. The list is sorted by agent registration date in reverse order.
        Returns:
        list of all currently unregistered agents
      • getUnregisteredAgents

        <T extends SBuildAgentList<T> getUnregisteredAgents​(boolean includeUnauthorized)
        Returns list of all currently unregistered agents, with additional filter based on authorization status. See also getUnregisteredAgents()
        Parameters:
        includeUnauthorized - whether to include or exclude unauthorized agents
        Returns:
        list of all currently unregistered agents
        Since:
        2017.1.1
      • findAgentById

        @Nullable
        <T extends SBuildAgent> T findAgentById​(int agentId,
                                                boolean searchUnregistered)
        Searches for an agent with specified id among registered and unregistered agents.
        Parameters:
        agentId - id of the agent to search
        searchUnregistered - true if unregistered agents should be searched too
        Returns:
        found agent or null
      • findAgentByName

        @Nullable
        <T extends SBuildAgent> T findAgentByName​(String agentName,
                                                  boolean searchUnregistered)
        Searches for an agent with specified name among registered and unregistered agents.
        Parameters:
        agentName - name of the agent to search
        searchUnregistered - true if unregistered agents should be searched too
        Returns:
        found agent or null
      • removeAgent

        void removeAgent​(@NotNull
                         SBuildAgent agent,
                         @Nullable
                         SUser user)
                  throws AgentCannotBeRemovedException
        Removes specified agent and cleans up this agent state from the database. Only unregistered agents can be removed.
        Parameters:
        agent - agent
        user - user who removes agent (can be null)
        Throws:
        AgentCannotBeRemovedException - if agent is connected/registered
      • setCanRunConfiguration

        <T extends SBuildAgent> void setCanRunConfiguration​(T agent,
                                                            String buildTypeId,
                                                            boolean canRun)
        If BuildAgentManager.RunConfigurationPolicy.SELECTED_COMPATIBLE_CONFIGURATIONS policy is selected for the agent, sets whether configuration with specified id can or can't run on the agent.
        Parameters:
        agent - the agent
        buildTypeId - id of the configuration
        canRun - if true then this configuration can run on the agent, if false it can't
      • getCanRunConfigurations

        <T extends SBuildAgentSet<String> getCanRunConfigurations​(T agent)
        Returns list of build configurations this agent can potentially run.
        Parameters:
        agent - the agent
        Returns:
        list of ids of potentially available for this agent configurations
      • getNumberOfCompatibleConfigurations

        <T extends SBuildAgent> int getNumberOfCompatibleConfigurations​(T agent)
        Returns number of configurations compatible with specified agent
        Parameters:
        agent - agent
        Returns:
        number of compatible configurations
      • getNumberOfIncompatibleConfigurations

        <T extends SBuildAgent> int getNumberOfIncompatibleConfigurations​(T agent)
        Returns number of configurations incompatible with specified agent
        Parameters:
        agent - agent
        Returns:
        number of incompatible configurations
      • getAgentCompatibilities

        <T extends SBuildAgentList<AgentCompatibility> getAgentCompatibilities​(T agent)
        Returns build configuration compatibility information for the specified agent
        Parameters:
        agent - agent
        Returns:
        build configuration compatibility information
      • getNumberOfRegisteredAgents

        int getNumberOfRegisteredAgents()
        Returns number of registered and authorized agents
        Returns:
        see above
        Since:
        2024.12