Package jetbrains.buildServer.web.systemProblems

Interface SystemProblemWebSpecificsManager

All Known Implementing Classes:

LinkProviderManagerImpl

public interface SystemProblemWebSpecificsManager

The registry of SystemProblemWebSpecificsProvider instances.

Since:

5.0

See Also:

SystemProblemWebSpecificsProvider, SystemProblem

Method Summary

Modifier and Type	Method	Description
SystemProblemWebSpecificsProvider	findProvider(String problemType)	Returns the provider registered for the given problem type
SystemProblemWebSpecifics	getWebSpecifics(SystemProblemEntry problemEntry, Object inContextOf, WebLink currentPage)	Returns an object containing web specific information for the given system problem.
void	registerProvider(String problemType, SystemProblemWebSpecificsProvider provider)	Register a SystemProblemWebSpecificsProvider instance for the specified system problem type.
void	unregisterProvider(String problemType)	Unregisters a SystemProblemWebSpecificsProvider instance for the specified system problem type.

Method Detail

registerProvider

void registerProvider(@NotNull
                      String problemType,
                      @NotNull
                      SystemProblemWebSpecificsProvider provider)

Register a SystemProblemWebSpecificsProvider instance for the specified system problem type. The provider previously registered for this problem type is thrown away.

Parameters:

problemType - problem type

provider - provider

unregisterProvider

void unregisterProvider(@NotNull
                        String problemType)

Unregisters a SystemProblemWebSpecificsProvider instance for the specified system problem type.

Parameters:

problemType - problem type

Since:

2018.2

findProvider

@Nullable
SystemProblemWebSpecificsProvider findProvider(@NotNull
                                               String problemType)

Returns the provider registered for the given problem type

Parameters:

problemType - problem type

Returns:

the provider or null if no provider registered for the problem type

getWebSpecifics

@Nullable
SystemProblemWebSpecifics getWebSpecifics(@NotNull
                                          SystemProblemEntry problemEntry,
                                          @Nullable
                                          Object inContextOf,
                                          @Nullable
                                          WebLink currentPage)

Returns an object containing web specific information for the given system problem.

Parameters:

problemEntry - system problem

inContextOf - the system entity -- Project (SProject), Build Type (SBuildType), VCS Root (SVcsRoot), etc. -- on the context of which the problem is displayed/handled. For example, on the build configuration page each problem is displayed in the context of this Build Type, even if it isn't directly related (say, a VCS Root problem). Null means the context is the whole system.

currentPage - the web link of the page the problem is currently diplayed on.

Returns:

the SystemProblemWebSpecifics object or null if the web specific information cannot be constructed/gathered for this problem