com.atlassian.bamboo.plugins.github

Class GitHubConnectionTester

java.lang.Object

com.atlassian.bamboo.plugins.github.AbstractGitHubExecutor

com.atlassian.bamboo.plugins.github.GitHubConnectionTester

All Implemented Interfaces:

VcsConnectionTester

public class GitHubConnectionTester
extends AbstractGitHubExecutor
implements VcsConnectionTester

Field Summary

Fields inherited from class com.atlassian.bamboo.plugins.github.AbstractGitHubExecutor

vcsRepositoryManager

Fields inherited from interface com.atlassian.bamboo.vcs.runtime.VcsConnectionTester

HOST_KEY

Constructor Summary

Constructors

Constructor and Description
GitHubConnectionTester(VcsRepositoryManager vcsRepositoryManager)

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.

Methods inherited from class com.atlassian.bamboo.plugins.github.AbstractGitHubExecutor

getGitModuleDescriptor, githubToGitData

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

GitHubConnectionTester

@Inject
public GitHubConnectionTester(VcsRepositoryManager vcsRepositoryManager)

Method Detail

testConnection

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

Description copied from interface: VcsConnectionTester

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

Specified by:

testConnection in interface VcsConnectionTester

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.