Package jetbrains.buildServer.agent
Interface BuildAgent
-
- All Superinterfaces:
Agent
,AgentLogListener
public interface BuildAgent extends Agent
- Author:
- Kir
-
-
Field Summary
-
Fields inherited from interface jetbrains.buildServer.agentServer.Agent
AGENT_PLUGIN_NAME_FILTER, AGENT_PLUGIN_NAMES_FILTER, AGENT_PLUGIN_PART_NAME, AGENT_PLUGINS_DIR, AGENT_UPDATE_CONTENTS_PATH, AGENT_UPDATE_CONTENTS_PATH_NEW, AGENT_UPDATE_CONTENTS_XML, BUILD_AGENT, DISTRIBUTION_ARCH_NAME, FULL_AGENT_FILE_NAME, UPDATE_PATH
-
-
Method Summary
All Methods Instance Methods Abstract Methods Deprecated Methods Modifier and Type Method Description void
ensureIdle()
Blocks until currently running build finishes and all build messages are sent to the serverjava.lang.String
getBuildId()
Current build idBuildAgentConfiguration
getConfiguration()
Returns agent configurationjava.lang.Integer
getId()
Agent id.java.util.Collection<AgentBuildRunner>
getRunners()
Returns array of registered runnersServer
getServerProxy()
XmlRpcHandlerManager
getXmlRpcHandlerManager()
Deprecated.since 9.1 useServerCommandsHandlersRegistry
.void
init(java.lang.String[] args)
Deprecated.should not be called from plugin codeboolean
isRunning()
Agent is running buildboolean
registerOnBuildServer(java.lang.String buildId)
Register on serverAgentBuildResult
runBuild(AgentBuild agentBuild)
Starts a build on agentboolean
shutdown()
immediate shutdown, running build will be terminatedboolean
shutdownWaitForBuild()
shutdown after build has finishedvoid
start()
starts agentvoid
unregisterFromBuildServer()
Disconnect build agent from server-
Methods inherited from interface jetbrains.buildServer.agentServer.Agent
ping2, runBuild, stopBuild, upgrade
-
Methods inherited from interface jetbrains.buildServer.agentServer.AgentLogListener
buildDetachedFromAgent, buildFinished, buildInterrupted, buildInterrupted, isBuildFailing, log
-
-
-
-
Method Detail
-
start
void start()
starts agent
-
shutdown
boolean shutdown()
immediate shutdown, running build will be terminated- Returns:
- true
-
shutdownWaitForBuild
boolean shutdownWaitForBuild()
shutdown after build has finished- Returns:
- true
-
getId
java.lang.Integer getId()
Agent id.- Returns:
- Agent id
-
getBuildId
@Nullable java.lang.String getBuildId()
Current build id- Returns:
- Current build id
-
ensureIdle
void ensureIdle()
Blocks until currently running build finishes and all build messages are sent to the server
-
init
@Deprecated void init(java.lang.String[] args)
Deprecated.should not be called from plugin code
-
getRunners
java.util.Collection<AgentBuildRunner> getRunners()
Returns array of registered runners- Returns:
- array of registered runners
-
getServerProxy
@Nullable Server getServerProxy()
- Returns:
- remote server proxy
-
getConfiguration
BuildAgentConfiguration getConfiguration()
Returns agent configuration- Returns:
- agent configuration
-
registerOnBuildServer
boolean registerOnBuildServer(java.lang.String buildId)
Register on server- Parameters:
buildId
- running build id- Returns:
- success flag
-
unregisterFromBuildServer
void unregisterFromBuildServer()
Disconnect build agent from server
-
isRunning
boolean isRunning()
Agent is running build- Returns:
- running flag
-
getXmlRpcHandlerManager
@Deprecated XmlRpcHandlerManager getXmlRpcHandlerManager()
Deprecated.since 9.1 useServerCommandsHandlersRegistry
. Handlers registered using this method will be available only by XML RPC.XML-RPC handler manager to manage XML-RPC handlers- Returns:
- XML-RPC handler manager to register/unregister handlers
-
runBuild
@NotNull AgentBuildResult runBuild(@NotNull AgentBuild agentBuild)
Starts a build on agent
-
-