jetbrains.buildServer.agent.vcs

Interface AgentVcsSupportCore

All Superinterfaces:

AgentExtension, AgentVcsExtension, TeamCityExtension

All Known Implementing Classes:

AgentVcsSupport

@UserImplemented(adapterClass=AgentVcsSupport.class)
public interface AgentVcsSupportCore
extends AgentVcsExtension

Implement this interface for your version control name to provide agent environment check for your vcs plugin.

Since:

4.5

Method Summary

Modifier and Type	Method and Description
AgentCheckoutAbility	canCheckout(VcsRoot vcsRoot, CheckoutRules checkoutRules, AgentRunningBuild build) Check whether this Vcs Support can checkout sources from the specified vcs root.
boolean	canRun(BuildAgentConfiguration agentConfiguration, TextLogger messageLog) This method may be called at any time.
java.lang.String	getName() Name of the VCS plugin.

Method Detail

getName

@NotNull
java.lang.String getName()

Name of the VCS plugin. Should be the same as jetbrains.buildServer.vcs.VcsSupport#getName

Returns:

see above

canRun

boolean canRun(@NotNull
               BuildAgentConfiguration agentConfiguration,
               @NotNull
               TextLogger messageLog)

This method may be called at any time. It's guaranteed vcs plugin will be disabled if it has returned false from this method. But subsequent calls to canRun are still possible.

Parameters:

agentConfiguration - - current agent configuration

messageLog - - logger to log user-related information on plugin availability

Returns:

true if the vcs support 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 vcs support and it won't be advertised to the build server server during agent's registration

canCheckout

@NotNull
AgentCheckoutAbility canCheckout(@NotNull
                                          VcsRoot vcsRoot,
                                          @NotNull
                                          CheckoutRules checkoutRules,
                                          @NotNull
                                          AgentRunningBuild build)

Check whether this Vcs Support can checkout sources from the specified vcs root.

Since:

10.0