Package jetbrains.buildServer.serverSide.oauth.reports

Class UnavailableTokenReport

java.lang.Object

jetbrains.buildServer.serverSide.healthStatus.HealthStatusReport

jetbrains.buildServer.serverSide.oauth.reports.UnavailableTokenReport

All Implemented Interfaces:

ServerExtension, TeamCityExtension

public class UnavailableTokenReport
extends HealthStatusReport

Field Summary

Fields

Modifier and Type	Field	Description
static String	MISSING_TOKEN_DATA_KEY
static String	VCS_ROOT_DATA_KEY
static String	WRONG_PROJECT_DATA_KEY
static String	WRONG_SCOPE_TOKEN_DATA_KEY

Constructor Summary

Constructors

Constructor	Description
UnavailableTokenReport(OAuthTokensStorage oAuthTokensStorage)

Method Summary

Modifier and Type	Method	Description
boolean	canReportItemsFor(HealthStatusScope scope)	Check whether the report can produce any items accepted by the specified scope.
Collection<ItemCategory>	getCategories()	Problems categories producing by this problem finder.
String	getDisplayName()	User presentable name of the problem finder.
String	getType()
boolean	isEnabled()
void	report(HealthStatusScope scope, HealthStatusItemConsumer resultConsumer)	When called must report all found problems to result consumer according to the received scope.

Methods inherited from class jetbrains.buildServer.serverSide.healthStatus.HealthStatusReport

equals, hashCode

Methods inherited from class java.lang.Object

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

Field Detail

VCS_ROOT_DATA_KEY

public static final String VCS_ROOT_DATA_KEY

See Also:

Constant Field Values

WRONG_PROJECT_DATA_KEY

public static final String WRONG_PROJECT_DATA_KEY

See Also:

Constant Field Values

MISSING_TOKEN_DATA_KEY

public static final String MISSING_TOKEN_DATA_KEY

See Also:

Constant Field Values

WRONG_SCOPE_TOKEN_DATA_KEY

public static final String WRONG_SCOPE_TOKEN_DATA_KEY

See Also:

Constant Field Values

Constructor Detail

UnavailableTokenReport

public UnavailableTokenReport(@NotNull
                              OAuthTokensStorage oAuthTokensStorage)

Method Detail

getType

@NotNull
public String getType()

Specified by:

getType in class HealthStatusReport

Returns:

unique identifier of the problem finder

getDisplayName

@NotNull
public String getDisplayName()

Description copied from class: HealthStatusReport

User presentable name of the problem finder.

Specified by:

getDisplayName in class HealthStatusReport

Returns:

name of the problem finder to show in the user interface.

getCategories

@NotNull
public Collection<ItemCategory> getCategories()

Description copied from class: HealthStatusReport

Problems categories producing by this problem finder. All problems of 'undeclared' categories will be filtered even if they were consumed.

Specified by:

getCategories in class HealthStatusReport

Returns:

Unmodifiable not-empty collection of unique categories producing by this problem finder.

canReportItemsFor

public boolean canReportItemsFor(@NotNull
                                 HealthStatusScope scope)

Description copied from class: HealthStatusReport

Check whether the report can produce any items accepted by the specified scope. HealthStatusReport.report(HealthStatusScope, HealthStatusItemConsumer) will not be called if this method return false. Implementations should not perform any complex calculations, they are expected to quickly analyze HealthStatusScope and return false if it is clear that they can not report any acceptable items. For example, they can return false if they can't produce items with the requested severity (that is accepted by HealthStatusScope.isItemWithSeverityAccepted(ItemSeverity)).

Specified by:

canReportItemsFor in class HealthStatusReport

report

public void report(@NotNull
                   HealthStatusScope scope,
                   @NotNull
                   HealthStatusItemConsumer resultConsumer)

Description copied from class: HealthStatusReport

When called must report all found problems to result consumer according to the received scope. Always called with system privileges (in all permissions mode) so no permission checks are required.

Note that this method can be called quite often, so long-running implementations should return false from HealthStatusReport.canReportItemsFor(HealthStatusScope) if it's clear that they can't produce any items for the requested scope.

Implementations of this method should always return in a reasonable time. For example, long running computations or network calls should not be made in this method, but rather called in some background thread, their result saved to a cache, and then be read from the cache in this method.

Specified by:

report in class HealthStatusReport

Parameters:

scope - health status code

resultConsumer - health status item consumer

isEnabled

public boolean isEnabled()