Package jetbrains.buildServer.issueTracker

Interface IssueProviderEx

All Superinterfaces:

IssueBatchProviderSupport, IssueProvider, SIssueProvider

All Known Implementing Classes:

IssueProviderWrapper

public interface IssueProviderEx
extends SIssueProvider

Since:

5.0

Author:

Maxim Podkolzine (maxim.podkolzine@jetbrains.com)

Field Summary

Fields inherited from interface jetbrains.buildServer.issueTracker.IssueProvider

SECURE_PROPERTY_PREFIX

Method Summary

Modifier and Type	Method	Description
String	describeError(RetrieveIssueException e)	Returns a human-readable description of the RetrieveIssueException error.
SIssueProvider	getActualProvider()	Unwraps this provider and returns actual provider instance.
Set<String>	getAssociatedProjects()	Returns the list of project internal ids associated with this provider.
String	getId()	Returns a short id of the provider, e.g.
String	getName()	Returns the name of the issue tracking system corresponding to this provider.
SProject	getProject()	Returns project to which current issue provider belongs
String	getUrl()	Returns the provider's URL, e.g.
String	getUsername()	Returns the username configured for the provider, or empty string if not set.
boolean	isApplicableInProjectFreeContext()	Returns whether the provider can be applied in the context without any project.

Methods inherited from interface jetbrains.buildServer.issueTracker.IssueBatchProviderSupport

findIssuesByIds, isBatchFetchSupported

Methods inherited from interface jetbrains.buildServer.issueTracker.IssueProvider

dispose, findIssueById, getCommentTransformationHelper, getProperties, getRelatedIssues, getRelatedIssues, getType, isHasRelatedIssues, isHasRelatedIssues, setProperties

Methods inherited from interface jetbrains.buildServer.issueTracker.SIssueProvider

findPossiblyExpiredIssue, getAdditionalTestData, getConfigurationSummary, getPropertiesProcessor, getTestConnectionSupport, isFailedToFetch, isFetched

Method Detail

getProject

@NotNull
SProject getProject()

Returns project to which current issue provider belongs

Returns:

id of the project

Since:

9.0

getId

@NotNull
String getId()

Returns a short id of the provider, e.g. "jira", "bugzilla", "youtrack", etc. The id is unique, immutable and consists of alpha-numeric characters.

Returns:

provider id

getName

@NotNull
String getName()

Returns the name of the issue tracking system corresponding to this provider.

Returns:

provider name

getUrl

@NotNull
String getUrl()

Returns the provider's URL, e.g. "http://www.jetbrains.net/tracker/".

Returns:

provider's url

getUsername

@NotNull
String getUsername()

Returns the username configured for the provider, or empty string if not set.

Returns:

provider's username

Since:

7.0

describeError

@NotNull
String describeError(@NotNull
                     RetrieveIssueException e)

Returns a human-readable description of the RetrieveIssueException error.

Parameters:

e - exception to describe

Returns:

a string description

Since:

7.1

getAssociatedProjects

@Nullable
Set<String> getAssociatedProjects()

Returns the list of project internal ids associated with this provider. If the value is not null, the provider will only be applied to returned projects. If the value is null, all projects are applied.

Compatibility: in earlier TeamCity versions the effective value used in null.

Returns:

list of associated project internal ids, or null

Since:

8.0

isApplicableInProjectFreeContext

boolean isApplicableInProjectFreeContext()

Returns whether the provider can be applied in the context without any project.

Compatibility: in earlier TeamCity versions the effective value used is true.

Returns:

true iff the provider is applicable in the project-free context

Since:

8.0

getActualProvider

@NotNull
SIssueProvider getActualProvider()

Unwraps this provider and returns actual provider instance.

Returns:

actual SIssueProvider instance

Since:

9.0