jetbrains.buildServer.issueTracker
Interface IssueTestConnectionSupport

public interface IssueTestConnectionSupport

This instance of this class is responsible for testing the connection to the issue tracker, i.e. for validating provider properties, such as server URL, proxy, credentials, etc.

Class doesn't necessarily verify the parsing properties, i.e. how the issues are extracted out of the comments, but it can check the validness of the issue as well as connection.

Since:

5.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Method Summary

java.lang.String

testConnection(IssueProvider provider, java.lang.String issueId) Called to test connection for the given issue provider.

Method Detail

testConnection

@Nullable
java.lang.String testConnection(@NotNull
                                         IssueProvider provider,
                                         @NotNull
                                         java.lang.String issueId)

Called to test connection for the given issue provider.

The simpliest implementation needs to know the issue id to verify the connection, and the implementation might look like:

   @NotNull
   public String testConnection(@NotNull IssueProvider provider,
                                @NotNull String issueId) {
     return (provider.findIssueById(issueId) != null) ?
              null :
              "Error: failed to fetch issue";
   }
 

Hint: provider should not cache null results.

Some providers can be able to test the connection without particular issue.

Parameters:

provider - the issue provider to check

issueId - the issue id (is provided by the end user in a special dialog);

Returns:

null, if connection is ok, or a string message otherwise