Package jetbrains.buildServer.notification

Interface Notificator

All Known Implementing Classes:

MockNotificator, NotificatorAdapter

public interface Notificator

Custom notificator interface. Implement it to provide new notification facilities. Plugin developers are encouraged to extend NotificatorAdapter class, as it makes the plugin more robust in case of new notification events.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Notificator display name.
String	getNotificatorType()	Unique type of the notificator.
void	notifyBuildFailed(SRunningBuild build, Set<SUser> users)	Called when build failed.
void	notifyBuildFailedToStart(SRunningBuild build, Set<SUser> users)	Called when build failed with internal error, i.e.
void	notifyBuildFailing(SRunningBuild build, Set<SUser> users)	Called when the first failed message occurred.
void	notifyBuildProbablyHanging(SRunningBuild build, Set<SUser> users)	Called when build is not sending messages to server for some time.
void	notifyBuildProblemResponsibleAssigned(Collection<BuildProblemInfo> buildProblems, ResponsibilityEntry entry, SProject project, Set<SUser> users)	Called when responsibility for several build problems is assigned.
void	notifyBuildProblemResponsibleChanged(Collection<BuildProblemInfo> buildProblems, ResponsibilityEntry entry, SProject project, Set<SUser> users)	Called when responsibility for several build problems is changed.
void	notifyBuildProblemsMuted(Collection<BuildProblemInfo> buildProblems, MuteInfo muteInfo, Set<SUser> users)	Called when a set of build problems are muted (with same mute properties).
void	notifyBuildProblemsUnmuted(Collection<BuildProblemInfo> buildProblems, MuteInfo muteInfo, SUser user, Set<SUser> users)	Called when a set of build problems are unmuted (with same mute properties).
void	notifyBuildStarted(SRunningBuild build, Set<SUser> users)	Called when new build started.
void	notifyBuildSuccessful(SRunningBuild build, Set<SUser> users)	Called when build finished successfully.
void	notifyLabelingFailed(Build build, VcsRoot root, Throwable exception, Set<SUser> users)	Called when labeling failed for the build.
void	notifyQueuedBuildWaitingForApproval(SQueuedBuild queuedBuild, Set<SUser> users)	Called when a build that requires approval from the user is added into the build queue.
void	notifyResponsibleAssigned(Collection<TestName> testNames, ResponsibilityEntry entry, SProject project, Set<SUser> users)	Called when responsibility for several tests at once is assigned.
void	notifyResponsibleAssigned(TestNameResponsibilityEntry oldValue, TestNameResponsibilityEntry newValue, SProject project, Set<SUser> users)	Called when responsibility for the test is assigned on certain users.
void	notifyResponsibleAssigned(SBuildType buildType, Set<SUser> users)	Called when responsibility for the build type is assigned on certain users.
void	notifyResponsibleChanged(Collection<TestName> testNames, ResponsibilityEntry entry, SProject project, Set<SUser> users)	Called when responsibility for several tests at once is changed.
void	notifyResponsibleChanged(TestNameResponsibilityEntry oldValue, TestNameResponsibilityEntry newValue, SProject project, Set<SUser> users)	Called when responsibility for the test changed.
void	notifyResponsibleChanged(SBuildType buildType, Set<SUser> users)	Called when responsibility for configuration changed.
void	notifyTestsMuted(Collection<STest> tests, MuteInfo muteInfo, Set<SUser> users)	Called when a set of tests are unmuted (with same mute properties).
void	notifyTestsUnmuted(Collection<STest> tests, MuteInfo muteInfo, SUser user, Set<SUser> users)	Called when a set of tests are unmuted (with same mute properties).

Method Detail

notifyBuildStarted

void notifyBuildStarted(@NotNull
                        SRunningBuild build,
                        @NotNull
                        Set<SUser> users)

Called when new build started.

Parameters:

build - started build.

users - users to be notified.

notifyBuildSuccessful

void notifyBuildSuccessful(@NotNull
                           SRunningBuild build,
                           @NotNull
                           Set<SUser> users)

Called when build finished successfully.

Parameters:

build - finished build.

users - users to be notified.

notifyBuildFailed

void notifyBuildFailed(@NotNull
                       SRunningBuild build,
                       @NotNull
                       Set<SUser> users)

Called when build failed.

Parameters:

build - finished build

users - users to be notified.

notifyBuildFailedToStart

void notifyBuildFailedToStart(@NotNull
                              SRunningBuild build,
                              @NotNull
                              Set<SUser> users)

Called when build failed with internal error, i.e. could not actually start.

Parameters:

build - failed build

users - users to be notified

Since:

6.0

notifyLabelingFailed

void notifyLabelingFailed(@NotNull
                          Build build,
                          @NotNull
                          VcsRoot root,
                          @NotNull
                          Throwable exception,
                          @NotNull
                          Set<SUser> users)

Called when labeling failed for the build.

Parameters:

build - finished build.

root - problem root.

exception - cause.

users - users to be notified.

notifyBuildFailing

void notifyBuildFailing(@NotNull
                        SRunningBuild build,
                        @NotNull
                        Set<SUser> users)

Called when the first failed message occurred.

Parameters:

build - running build.

users - users to be notified.

notifyBuildProbablyHanging

void notifyBuildProbablyHanging(@NotNull
                                SRunningBuild build,
                                @NotNull
                                Set<SUser> users)

Called when build is not sending messages to server for some time.

Parameters:

build - running build.

users - users to be notified.

notifyResponsibleChanged

void notifyResponsibleChanged(@NotNull
                              SBuildType buildType,
                              @NotNull
                              Set<SUser> users)

Called when responsibility for configuration changed.

Parameters:

buildType - configuration.

users - users to be notified.

notifyResponsibleAssigned

void notifyResponsibleAssigned(@NotNull
                               SBuildType buildType,
                               @NotNull
                               Set<SUser> users)

Called when responsibility for the build type is assigned on certain users.

Parameters:

buildType - configuration.

users - users to be notified.

Since:

5.0

notifyResponsibleChanged

void notifyResponsibleChanged(@Nullable
                              TestNameResponsibilityEntry oldValue,
                              @NotNull
                              TestNameResponsibilityEntry newValue,
                              @NotNull
                              SProject project,
                              @NotNull
                              Set<SUser> users)

Called when responsibility for the test changed.

Parameters:

oldValue - old responsibility entry (nullable).

newValue - new responsibility entry.

project - the project.

users - users to be notified.

Since:

5.0

notifyResponsibleAssigned

void notifyResponsibleAssigned(@Nullable
                               TestNameResponsibilityEntry oldValue,
                               @NotNull
                               TestNameResponsibilityEntry newValue,
                               @NotNull
                               SProject project,
                               @NotNull
                               Set<SUser> users)

Called when responsibility for the test is assigned on certain users.

Parameters:

oldValue - old responsibility entry (nullable).

newValue - new responsibility entry.

project - the project.

users - users to be notified.

Since:

5.0

notifyResponsibleChanged

void notifyResponsibleChanged(@NotNull
                              Collection<TestName> testNames,
                              @NotNull
                              ResponsibilityEntry entry,
                              @NotNull
                              SProject project,
                              @NotNull
                              Set<SUser> users)

Called when responsibility for several tests at once is changed.

Parameters:

testNames - the collection of test names

entry - new responsibility entry for each test

project - the project

users - users to be notified

Since:

6.0

notifyResponsibleAssigned

void notifyResponsibleAssigned(@NotNull
                               Collection<TestName> testNames,
                               @NotNull
                               ResponsibilityEntry entry,
                               @NotNull
                               SProject project,
                               @NotNull
                               Set<SUser> users)

Called when responsibility for several tests at once is assigned.

Parameters:

testNames - the collection of test names

entry - new responsibility entry for each test

project - the project

users - users to be notified

Since:

6.0

notifyBuildProblemResponsibleAssigned

void notifyBuildProblemResponsibleAssigned(@NotNull
                                           Collection<BuildProblemInfo> buildProblems,
                                           @NotNull
                                           ResponsibilityEntry entry,
                                           @NotNull
                                           SProject project,
                                           @NotNull
                                           Set<SUser> users)

Called when responsibility for several build problems is assigned.

Parameters:

buildProblems - affected build problems

entry - new responsibility entry

project - corresponding project

users - users to be notified

Since:

8.0

notifyBuildProblemResponsibleChanged

void notifyBuildProblemResponsibleChanged(@NotNull
                                          Collection<BuildProblemInfo> buildProblems,
                                          @NotNull
                                          ResponsibilityEntry entry,
                                          @NotNull
                                          SProject project,
                                          @NotNull
                                          Set<SUser> users)

Called when responsibility for several build problems is changed.

Parameters:

buildProblems - affected build problems

entry - new responsibility entry

project - corresponding project

users - users to be notified

Since:

8.0

notifyTestsMuted

void notifyTestsMuted(@NotNull
                      Collection<STest> tests,
                      @NotNull
                      MuteInfo muteInfo,
                      @NotNull
                      Set<SUser> users)

Called when a set of tests are unmuted (with same mute properties). All tests are in the same project.

Parameters:

tests - the unmuted tests

muteInfo - the mute info on the moment of unmute

users - users to be notified

Since:

6.5

notifyTestsUnmuted

void notifyTestsUnmuted(@NotNull
                        Collection<STest> tests,
                        @NotNull
                        MuteInfo muteInfo,
                        @Nullable
                        SUser user,
                        @NotNull
                        Set<SUser> users)

Called when a set of tests are unmuted (with same mute properties). All tests are in the same project.

Parameters:

tests - the unmuted tests

user - user who performed the action (if known)

users - users to be notified

Since:

6.5 (updated in 7.0)

notifyBuildProblemsMuted

void notifyBuildProblemsMuted(@NotNull
                              Collection<BuildProblemInfo> buildProblems,
                              @NotNull
                              MuteInfo muteInfo,
                              @NotNull
                              Set<SUser> users)

Called when a set of build problems are muted (with same mute properties). All problems belong the same project.

Parameters:

buildProblems - the muted problems

muteInfo - mute info

users - users to be notified

Since:

8.0

notifyBuildProblemsUnmuted

void notifyBuildProblemsUnmuted(@NotNull
                                Collection<BuildProblemInfo> buildProblems,
                                @NotNull
                                MuteInfo muteInfo,
                                @Nullable
                                SUser user,
                                @NotNull
                                Set<SUser> users)

Called when a set of build problems are unmuted (with same mute properties). All problems belong the same project.

Parameters:

buildProblems - the unmuted problems

user - user who performed the action (if known)

users - users to be notified

Since:

8.0

notifyQueuedBuildWaitingForApproval

void notifyQueuedBuildWaitingForApproval(@NotNull
                                         SQueuedBuild queuedBuild,
                                         @NotNull
                                         Set<SUser> users)

Called when a build that requires approval from the user is added into the build queue.

Parameters:

queuedBuild - queued build

users - users to be notified

Since:

2022.1

getNotificatorType

@NotNull
@NonNls
String getNotificatorType()

Unique type of the notificator.

Returns:

notificator unique key.

getDisplayName

@NotNull
String getDisplayName()

Notificator display name.

Returns:

notificator display name.