TestConnectionSupport (javadoc 2024.12-174331 API)

All Superinterfaces:

VcsExtension

All Known Implementing Classes:

MockBranchSupport, MockVcsSupport, VcsSupport
```
public interface TestConnectionSupport
extends VcsExtension
```
Author:

Sergey.Anchipolevsky Date: 09.02.2009

- Method Summary
  
  All Methods Instance Methods Abstract Methods
  Modifier and Type Method Description
  
  String testConnection(VcsRoot vcsRoot)
  Called to test connection to the given VCS root.

- Method Detail
  - testConnection
```
@Nullable
String testConnection(@NotNull
                      VcsRoot vcsRoot)
               throws VcsException
```
    Called to test connection to the given VCS root.
    
    Parameters:
    
    vcsRoot - root to be tested
    
    Returns:
    
    current connection description or null if no additional information shall be displayed to the user in case of successful connection.
    
    Throws:
    
    VcsException - - throw this exception if connection failed