jetbrains.buildServer.notification
Interface Notificator

All Known Implementing Classes:

NotificatorAdapter

public interface Notificator

Custom notificator interface. Implement it to provide new notification facilities.

Method Summary

java.lang.String	getDisplayName() Notificator display name.
java.lang.String	getNotificatorType() Unique type of the notificator.
void	notifyBuildFailed(SRunningBuild build, java.util.Set<SUser> users) Called when build failed.
void	notifyBuildFailedToStart(SRunningBuild build, java.util.Set<SUser> users) Called when build failed with internal error, i.e.
void	notifyBuildFailing(SRunningBuild build, java.util.Set<SUser> users) Called when the first failed message occurred.
void	notifyBuildProbablyHanging(SRunningBuild build, java.util.Set<SUser> users) Called when build is not sending messages to server for some time.
void	notifyBuildStarted(SRunningBuild build, java.util.Set<SUser> users) Called when new build started.
void	notifyBuildSuccessful(SRunningBuild build, java.util.Set<SUser> users) Called when build finished successfully.
void	notifyLabelingFailed(Build build, VcsRoot root, java.lang.Throwable exception, java.util.Set<SUser> users) Called when labeling failed for the build.
void	notifyResponsibleAssigned(java.util.Collection<TestName> testNames, ResponsibilityEntry entry, SProject project, java.util.Set<SUser> users) Called when responsibility for several tests at once is assigned.
void	notifyResponsibleAssigned(SBuildType buildType, java.util.Set<SUser> users) Called when responsibility for the build type is assigned on certain users.
void	notifyResponsibleAssigned(TestNameResponsibilityEntry oldValue, TestNameResponsibilityEntry newValue, SProject project, java.util.Set<SUser> users) Called when responsibility for the test is assigned on certain users.
void	notifyResponsibleChanged(java.util.Collection<TestName> testNames, ResponsibilityEntry entry, SProject project, java.util.Set<SUser> users) Called when responsibility for several tests at once is changed.
void	notifyResponsibleChanged(SBuildType buildType, java.util.Set<SUser> users) Called when responsibility for configuration changed.
void	notifyResponsibleChanged(TestNameResponsibilityEntry oldValue, TestNameResponsibilityEntry newValue, SProject project, java.util.Set<SUser> users) Called when responsibility for the test changed.
void	notifyTestsMuted(java.util.Collection<STest> tests, MuteInfo muteInfo, java.util.Set<SUser> users) Called when a set of tests are unmuted (with same mute properties).
void	notifyTestsUnmuted(java.util.Collection<STest> tests, MuteInfo muteInfo, SUser user, java.util.Set<SUser> users) Called when a set of tests are unmuted (with same mute properties).

Method Detail

notifyBuildStarted

void notifyBuildStarted(SRunningBuild build,
                        java.util.Set<SUser> users)

Called when new build started.

Parameters:

build - started build.

users - users to be notified.

notifyBuildSuccessful

void notifyBuildSuccessful(SRunningBuild build,
                           java.util.Set<SUser> users)

Called when build finished successfully.

Parameters:

build - finished build.

users - users to be notified.

notifyBuildFailed

void notifyBuildFailed(SRunningBuild build,
                       java.util.Set<SUser> users)

Called when build failed.

Parameters:

build - finished build

users - users to be notified.

notifyBuildFailedToStart

void notifyBuildFailedToStart(SRunningBuild build,
                              java.util.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(Build build,
                          VcsRoot root,
                          java.lang.Throwable exception,
                          java.util.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(SRunningBuild build,
                        java.util.Set<SUser> users)

Called when the first failed message occurred.

Parameters:

build - running build.

users - users to be notified.

notifyBuildProbablyHanging

void notifyBuildProbablyHanging(SRunningBuild build,
                                java.util.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(SBuildType buildType,
                              java.util.Set<SUser> users)

Called when responsibility for configuration changed.

Parameters:

buildType - configuration.

users - users to be notified.

notifyResponsibleAssigned

void notifyResponsibleAssigned(SBuildType buildType,
                               java.util.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(TestNameResponsibilityEntry oldValue,
                              TestNameResponsibilityEntry newValue,
                              SProject project,
                              java.util.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(TestNameResponsibilityEntry oldValue,
                               TestNameResponsibilityEntry newValue,
                               SProject project,
                               java.util.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(java.util.Collection<TestName> testNames,
                              ResponsibilityEntry entry,
                              SProject project,
                              java.util.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(java.util.Collection<TestName> testNames,
                               ResponsibilityEntry entry,
                               SProject project,
                               java.util.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

notifyTestsMuted

void notifyTestsMuted(java.util.Collection<STest> tests,
                      MuteInfo muteInfo,
                      java.util.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

muteInfoBeforeUnmute - the mute info on the moment of unmute

users - users to be notified

Since:

6.5

notifyTestsUnmuted

void notifyTestsUnmuted(java.util.Collection<STest> tests,
                        MuteInfo muteInfo,
                        SUser user,
                        java.util.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)

getNotificatorType

@NotNull
@NonNls
java.lang.String getNotificatorType()

Unique type of the notificator.

Returns:

notificator unique key.

getDisplayName

@NotNull
java.lang.String getDisplayName()

Notificator display name.

Returns:

nodificator display name.