jetbrains.vcs.api.services

Interface TestConnectionService

All Superinterfaces:

VcsRemoteService, VcsService

public interface TestConnectionService
extends VcsService, VcsRemoteService

Support for testing VCS connection for current VcsSettings

Author:

kir

Method Summary

Modifier and Type	Method and Description
java.lang.String	testConnection() Called to test connection for current VcsSettings

Method Detail

testConnection

@Nullable
java.lang.String testConnection()
                                   throws VcsException

Called to test connection for current VcsSettings

Returns:

current connection description or null if no additional information shall be displayed to the user in case of successful connection.

Throws:

VcsException - - if test connection failed