com.atlassian.bamboo.vcs.runtime

Interface VcsConnectionTester

All Known Implementing Classes:

BitbucketCloudConnectionTester, GitConnectionTester, LegacyConnectionTester, MercurialConnectionTester, SvnConnectionTester

public interface VcsConnectionTester

Class responsible for testing connection to a repository. Implementation should be stateless. Used agent-side.

Since:

5.14

Field Summary

Fields

Modifier and Type	Field and Description
static String	HOST_KEY Marker field for error messages related to host key verification.

Method Summary

Modifier and Type	Method and Description
ErrorCollection	testConnection(VcsRepositoryData repositoryData, long timeout, TimeUnit unit) Test connection to the repository within the given timeout.

Field Detail

HOST_KEY

static final String HOST_KEY

Marker field for error messages related to host key verification.

See Also:

Constant Field Values

Method Detail

testConnection

@NotNull
ErrorCollection testConnection(@NotNull
                                        VcsRepositoryData repositoryData,
                                        long timeout,
                                        @NotNull
                                        TimeUnit unit)

Test connection to the repository within the given timeout. The method should stop executing after the given time elapses.

Parameters:

repositoryData - configuration to be tested

timeout - the maximum time to wait

unit - the time unit of the timeout argument

Returns:

Errors discovered during testing connection. Empty error collection should be returned if connection was successful. The errors should be translated to error messages, rather than field errors.

Since:

5.10