Package jetbrains.buildServer.web.systemProblems

Interface SystemProblemWebSpecificsProvider

All Known Implementing Classes:

BuildTriggerLinkProvider, InternalErrorsLinkProvider, VcsRootLinkProvider

public interface SystemProblemWebSpecificsProvider

Provides web UI specific information used for handling system problems.
A provider should compose URL(s) and textual data related to the given problem (see SystemProblemWebSpecifics), which then is presented to the user when he sees the problem in the UI.

Since:

5.0

See Also:

SystemProblemWebSpecifics, SystemProblem, SystemProblemNotification, SystemProblemList

Method Summary

Modifier and Type	Method	Description
SystemProblemWebSpecifics	getWebSpecifics(SystemProblemEntry problemEntry, Object inContextOf, WebLink currentPage)	Returns an object containing web specific information for the given system problem.

Method Detail

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