jetbrains.buildServer.serverSide
Class BuildServerAdapter

java.lang.Object
  jetbrains.buildServer.serverSide.BuildServerAdapter

All Implemented Interfaces:

java.util.EventListener, BuildServerListener

public class BuildServerAdapter
extends java.lang.Object
implements BuildServerListener

A helper for writing BuildServerListeners.

Constructor Summary

BuildServerAdapter()

Method Summary

void	agentDescriptionUpdated(SBuildAgent agent) Called when build agent description update is finished.
void	agentRegistered(SBuildAgent agent, long currentlyRunningBuildId) Called when build agent is registered (connected)
void	agentRemoved(SBuildAgent agent) Called when agent was completely removed from server storage.
void	agentStatusChanged(SBuildAgent agent, boolean wasEnabled, boolean wasAuthorized) Called when the status of an agent is changed by a user
void	agentUnregistered(SBuildAgent agent) Called after build agent unregistration
void	beforeAgentUnregistered(SBuildAgent agent) Called before build agent unregistration
void	beforeBuildFinish(SRunningBuild runningBuild) Called right before build finishing, allows to write additional messages to the build log, update build status.
void	beforeBuildFinish(SRunningBuild runningBuild, boolean buildFailed)
void	beforeBuildTypeDeleted(java.lang.String buildTypeId) Called before cleaning the build configuration data from the database.
void	beforeEntryDelete(SFinishedBuild entry) Called before deletion of the build history entry
void	buildChangedStatus(SRunningBuild build, Status oldStatus, Status newStatus) Called when build status changes from successful to failed
void	buildCommented(SBuild build, User user, java.lang.String comment) Called when user comment the build
void	buildFinished(SRunningBuild build) Called after build finishing, only if build was not interrupted
void	buildInterrupted(SRunningBuild build) Called after build finishing, only if build was interrupted
void	buildPinned(SBuild build, User user, java.lang.String comment) Called when user pinned the build
void	buildQueueOrderChanged() Called when user reordered build queue order.
void	buildRemovedFromQueue(SQueuedBuild queued, User user, java.lang.String comment) Called when build configuration removed from build queue
void	buildStarted(SRunningBuild build) Called when build is about to start.
void	buildTagsChanged(SBuild build, java.util.List<java.lang.String> oldTags, java.util.List<java.lang.String> newTags) Called when build tags have been set to specifiled values
void	buildTagsChanged(SBuild build, User user, java.util.List<java.lang.String> oldTags, java.util.List<java.lang.String> newTags) Called when build tags have been set to specifiled values
void	buildTypeActiveStatusChanged(SBuildType buildType) Called when build configuration status changed from active to paused and vice versa.
void	buildTypeAddedToQueue(SBuildType buildType) Called when build configration was added to build queue
void	buildTypeAddedToQueue(SQueuedBuild queuedBuild) Called when build configration was added to build queue
void	buildTypeDeleted(java.lang.String buildTypeId) Called after the cleaning the build configuration data from the database.
void	buildTypeMoved(SBuildType buildType, SProject original) Called when build configuration is moved to another project.
void	buildTypeRegistered(SBuildType buildType) Called when build configuration is created or build configuration is reloaded from the disk
void	buildTypeTemplateDeleted(java.lang.String buildTypeTemplateId) Called when build configuration template is deleted
void	buildTypeUnregistered(SBuildType buildType) Called when build configuration is deleted
void	buildUnpinned(SBuild build, User user, java.lang.String comment) Called when user unpinned the build
void	changeAdded(VcsModification modification, VcsRoot root, java.util.Collection<SBuildType> buildTypes) Called when a new modification (user commit) was detected.
void	changesLoaded(SRunningBuild build) Occurres when changes for a newly started build has been loaded
void	cleanupFinished() Called when database cleanup has been finished.
void	cleanupStarted() Called when database cleanup is going to start.
void	entryDeleted(SFinishedBuild entry) Called after deletion of the build history entry
void	labelingFailed(SBuild build, VcsRoot root, java.lang.Throwable exception) Labeling process failed for the specified build and root with the specified problem.
void	labelingSucceed(SBuild build, BuildRevision revision) Labeling process succeed for the specified build and revision
void	messageReceived(SRunningBuild build, BuildMessage1 message) Called each time when running build got a message from build agent
void	pluginsLoaded() Called when all server plugins are loaded
void	projectArchived(java.lang.String projectId) Called when project has been archived
void	projectCreated(java.lang.String projectId) Generated when new project was created
void	projectDearchived(java.lang.String projectId) Called when project has been dearchived
void	projectPersisted(java.lang.String projectId) Generated when project configuration persisted on a disk
void	projectRemoved(java.lang.String projectId) Generated when project was removed
void	projectRestored(java.lang.String projectId) Generated when project configuration reloaded from disk
void	responsibleChanged(SBuildType bt, ResponsibilityInfo oldValue, ResponsibilityInfo newValue, boolean isUserAction) Called when build configuration responsible has changed, or responsibility status has changed
void	responsibleChanged(SProject project, java.util.Collection<TestName> testNames, ResponsibilityEntry entry, boolean isUserAction) Called when responsibility for several tests at once is changed.
void	responsibleChanged(SProject project, TestNameResponsibilityEntry oldValue, TestNameResponsibilityEntry newValue, boolean isUserAction) Called when test responsibility is changed.
void	serverConfigurationReloaded() Called when the main server configuration file is reloaded
void	serverShutdown() Called when server shutdown has been started
void	serverShutdownComplete() Event called after server shutdown complete.
void	serverStartup() Called when server has been started and its configuration has been loaded from the disk
void	sourcesVersionReleased(BuildAgent agent) Clean sources performed for the given agent
void	sourcesVersionReleased(BuildType configuration) Clean sources performed for the given configuraton on all agents
void	sourcesVersionReleased(BuildType configuration, BuildAgent agent) Clean sources performed for the given configuraton on the given agent
void	testsMuted(MuteInfo muteInfo) Called when a set of tests are muted (with same mute properties).
void	testsUnmuted(SProject project, java.util.Collection<com.intellij.openapi.util.Pair<MuteInfo,java.util.Collection<STest>>> unmutedGroups) Called when several of tests have been unmuted.
void	vcsRootRemoved(SVcsRoot root) Called when VCS root was removed
void	vcsRootsPersisted() Called when VCS roots are saved to disk
void	vcsRootUpdated(SVcsRoot oldVcsRoot, SVcsRoot newVcsRoot) Called when VCS root settings has c

Methods inherited from class java.lang.Object

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

Constructor Detail

BuildServerAdapter

public BuildServerAdapter()

Method Detail

agentRegistered

public void agentRegistered(SBuildAgent agent,
                            long currentlyRunningBuildId)

Description copied from interface: BuildServerListener

Called when build agent is registered (connected)

Specified by:

agentRegistered in interface BuildServerListener

Parameters:

agent - which was registered

currentlyRunningBuildId - id of the build which is running on this build agent

agentDescriptionUpdated

public void agentDescriptionUpdated(@NotNull
                                    SBuildAgent agent)

Description copied from interface: BuildServerListener

Called when build agent description update is finished. This event is executed update synchronization on agent instance.

Specified by:

agentDescriptionUpdated in interface BuildServerListener

Parameters:

agent - agent with updated agent description

agentUnregistered

public void agentUnregistered(SBuildAgent agent)

Description copied from interface: BuildServerListener

Called after build agent unregistration

Specified by:

agentUnregistered in interface BuildServerListener

Parameters:

agent - which was unregistered

beforeAgentUnregistered

public void beforeAgentUnregistered(SBuildAgent agent)

Description copied from interface: BuildServerListener

Called before build agent unregistration

Specified by:

beforeAgentUnregistered in interface BuildServerListener

Parameters:

agent - which is about to unregister

agentRemoved

public void agentRemoved(SBuildAgent agent)

Description copied from interface: BuildServerListener

Called when agent was completely removed from server storage.

Specified by:

agentRemoved in interface BuildServerListener

Parameters:

agent - removed agent

buildTypeAddedToQueue

public void buildTypeAddedToQueue(SBuildType buildType)

Description copied from interface: BuildServerListener

Called when build configration was added to build queue

Specified by:

buildTypeAddedToQueue in interface BuildServerListener

Parameters:

buildType - build configuration added to build queue

buildTypeAddedToQueue

public void buildTypeAddedToQueue(@NotNull
                                  SQueuedBuild queuedBuild)

Description copied from interface: BuildServerListener

Called when build configration was added to build queue

Specified by:

buildTypeAddedToQueue in interface BuildServerListener

Parameters:

queuedBuild - queued build added to the queue

buildRemovedFromQueue

public void buildRemovedFromQueue(@NotNull
                                  SQueuedBuild queued,
                                  User user,
                                  java.lang.String comment)

Description copied from interface: BuildServerListener

Called when build configuration removed from build queue

Specified by:

buildRemovedFromQueue in interface BuildServerListener

Parameters:

queued - queued build removed from the queue

user - if build was removed manually, contains the user who removed build configuration from queue

comment - provided by user when removeding build from queue

buildPinned

public void buildPinned(@NotNull
                        SBuild build,
                        @Nullable
                        User user,
                        @Nullable
                        java.lang.String comment)

Description copied from interface: BuildServerListener

Called when user pinned the build

Specified by:

buildPinned in interface BuildServerListener

Parameters:

build - pinned build

user - the user who pinned the build

comment - comment provided by user when pinning build

buildUnpinned

public void buildUnpinned(@NotNull
                          SBuild build,
                          @Nullable
                          User user,
                          @Nullable
                          java.lang.String comment)

Description copied from interface: BuildServerListener

Called when user unpinned the build

Specified by:

buildUnpinned in interface BuildServerListener

Parameters:

build - unpinned build

user - the user who unpinned the build

comment - comment provided by user when unpinning build

buildQueueOrderChanged

public void buildQueueOrderChanged()

Description copied from interface: BuildServerListener

Called when user reordered build queue order. Is not called when build is started.

Specified by:

buildQueueOrderChanged in interface BuildServerListener

buildTypeRegistered

public void buildTypeRegistered(SBuildType buildType)

Description copied from interface: BuildServerListener

Called when build configuration is created or build configuration is reloaded from the disk

Specified by:

buildTypeRegistered in interface BuildServerListener

Parameters:

buildType - registered build configuration

buildTypeUnregistered

public void buildTypeUnregistered(SBuildType buildType)

Description copied from interface: BuildServerListener

Called when build configuration is deleted

Specified by:

buildTypeUnregistered in interface BuildServerListener

Parameters:

buildType - unregistered build configuration

buildTypeMoved

public void buildTypeMoved(SBuildType buildType,
                           SProject original)

Description copied from interface: BuildServerListener

Called when build configuration is moved to another project.

Specified by:

buildTypeMoved in interface BuildServerListener

Parameters:

buildType - build type

original - the original project

beforeBuildTypeDeleted

public void beforeBuildTypeDeleted(@NotNull
                                   java.lang.String buildTypeId)

Description copied from interface: BuildServerListener

Called before cleaning the build configuration data from the database.

Specified by:

beforeBuildTypeDeleted in interface BuildServerListener

Parameters:

buildTypeId - id of build configuration

buildTypeDeleted

public void buildTypeDeleted(@NotNull
                             java.lang.String buildTypeId)

Description copied from interface: BuildServerListener

Called after the cleaning the build configuration data from the database.

Specified by:

buildTypeDeleted in interface BuildServerListener

Parameters:

buildTypeId - id of build configuration

buildTypeTemplateDeleted

public void buildTypeTemplateDeleted(@NotNull
                                     java.lang.String buildTypeTemplateId)

Description copied from interface: BuildServerListener

Called when build configuration template is deleted

Specified by:

buildTypeTemplateDeleted in interface BuildServerListener

Parameters:

buildTypeTemplateId - id of build configuration template

buildTypeActiveStatusChanged

public void buildTypeActiveStatusChanged(SBuildType buildType)

Description copied from interface: BuildServerListener

Called when build configuration status changed from active to paused and vice versa.

Specified by:

buildTypeActiveStatusChanged in interface BuildServerListener

Parameters:

buildType - build configuration whose status has changed

buildStarted

public void buildStarted(SRunningBuild build)

Description copied from interface: BuildServerListener

Called when build is about to start. Changes are not loaded yet, and build agent didn't start the build yet.

Specified by:

buildStarted in interface BuildServerListener

Parameters:

build - build configuration whose status has changed

changesLoaded

public void changesLoaded(SRunningBuild build)

Description copied from interface: BuildServerListener

Occurres when changes for a newly started build has been loaded

Specified by:

changesLoaded in interface BuildServerListener

Parameters:

build - build, whose changes are loaded

buildChangedStatus

public void buildChangedStatus(SRunningBuild build,
                               Status oldStatus,
                               Status newStatus)

Description copied from interface: BuildServerListener

Called when build status changes from successful to failed

Specified by:

buildChangedStatus in interface BuildServerListener

Parameters:

build - corresponding running build

oldStatus - previous status

newStatus - new status

buildFinished

public void buildFinished(SRunningBuild build)

Description copied from interface: BuildServerListener

Called after build finishing, only if build was not interrupted

Specified by:

buildFinished in interface BuildServerListener

Parameters:

build - running build // TODO: shall pass SFinishedBuild as parameter

beforeBuildFinish

public void beforeBuildFinish(SRunningBuild runningBuild)

Description copied from interface: BuildServerListener

Called right before build finishing, allows to write additional messages to the build log, update build status.

Specified by:

beforeBuildFinish in interface BuildServerListener

Parameters:

runningBuild - corresponding running build

beforeBuildFinish

public void beforeBuildFinish(SRunningBuild runningBuild,
                              boolean buildFailed)

Specified by:

beforeBuildFinish in interface BuildServerListener

messageReceived

public void messageReceived(SRunningBuild build,
                            BuildMessage1 message)

Description copied from interface: BuildServerListener

Called each time when running build got a message from build agent

Specified by:

messageReceived in interface BuildServerListener

Parameters:

build - running build

message - message sent to the build

responsibleChanged

public void responsibleChanged(@NotNull
                               SBuildType bt,
                               @NotNull
                               ResponsibilityInfo oldValue,
                               @NotNull
                               ResponsibilityInfo newValue,
                               boolean isUserAction)

Description copied from interface: BuildServerListener

Called when build configuration responsible has changed, or responsibility status has changed

Specified by:

responsibleChanged in interface BuildServerListener

Parameters:

bt - build configuration

oldValue - previous responsibility state

newValue - new responsibility state

isUserAction - true if responsibility status was changed manually via Web UI

responsibleChanged

public void responsibleChanged(@NotNull
                               SProject project,
                               @Nullable
                               TestNameResponsibilityEntry oldValue,
                               @NotNull
                               TestNameResponsibilityEntry newValue,
                               boolean isUserAction)

Description copied from interface: BuildServerListener

Called when test responsibility is changed.

Specified by:

responsibleChanged in interface BuildServerListener

Parameters:

project - the project in which test responsibility has changed

oldValue - old responsibility entry

newValue - new responsibility entry

isUserAction - true if responsibility status was changed manually via Web UI

responsibleChanged

public void responsibleChanged(@NotNull
                               SProject project,
                               @NotNull
                               java.util.Collection<TestName> testNames,
                               @NotNull
                               ResponsibilityEntry entry,
                               boolean isUserAction)

Description copied from interface: BuildServerListener

Called when responsibility for several tests at once is changed.

Specified by:

responsibleChanged in interface BuildServerListener

Parameters:

project - the project

testNames - test names

entry - the new responsibility entry for each test

isUserAction - true if responsibility status was changed manually via Web UI

beforeEntryDelete

public void beforeEntryDelete(SFinishedBuild entry)

Description copied from interface: BuildServerListener

Called before deletion of the build history entry

Specified by:

beforeEntryDelete in interface BuildServerListener

Parameters:

entry - build to be deleted

entryDeleted

public void entryDeleted(SFinishedBuild entry)

Description copied from interface: BuildServerListener

Called after deletion of the build history entry

Specified by:

entryDeleted in interface BuildServerListener

Parameters:

entry - deleted build

projectCreated

public void projectCreated(java.lang.String projectId)

Description copied from interface: BuildServerListener

Generated when new project was created

Specified by:

projectCreated in interface BuildServerListener

Parameters:

projectId - id of the created project

projectRemoved

public void projectRemoved(java.lang.String projectId)

Description copied from interface: BuildServerListener

Generated when project was removed

Specified by:

projectRemoved in interface BuildServerListener

Parameters:

projectId - deleted projectId

projectPersisted

public void projectPersisted(java.lang.String projectId)

Description copied from interface: BuildServerListener

Generated when project configuration persisted on a disk

Specified by:

projectPersisted in interface BuildServerListener

Parameters:

projectId - id of the saved project

projectRestored

public void projectRestored(java.lang.String projectId)

Description copied from interface: BuildServerListener

Generated when project configuration reloaded from disk

Specified by:

projectRestored in interface BuildServerListener

Parameters:

projectId - id of the reloaded project

projectArchived

public void projectArchived(java.lang.String projectId)

Description copied from interface: BuildServerListener

Called when project has been archived

Specified by:

projectArchived in interface BuildServerListener

Parameters:

projectId - id of archived project

projectDearchived

public void projectDearchived(java.lang.String projectId)

Description copied from interface: BuildServerListener

Called when project has been dearchived

Specified by:

projectDearchived in interface BuildServerListener

Parameters:

projectId - id of dearchived project

serverShutdown

public void serverShutdown()

Description copied from interface: BuildServerListener

Called when server shutdown has been started

Specified by:

serverShutdown in interface BuildServerListener

serverStartup

public void serverStartup()

Description copied from interface: BuildServerListener

Called when server has been started and its configuration has been loaded from the disk

Specified by:

serverStartup in interface BuildServerListener

pluginsLoaded

public void pluginsLoaded()

Description copied from interface: BuildServerListener

Called when all server plugins are loaded

Specified by:

pluginsLoaded in interface BuildServerListener

buildInterrupted

public void buildInterrupted(SRunningBuild build)

Description copied from interface: BuildServerListener

Called after build finishing, only if build was interrupted

Specified by:

buildInterrupted in interface BuildServerListener

Parameters:

build - running build // TODO: shall pass SFinishedBuild as parameter

changeAdded

public void changeAdded(@NotNull
                        VcsModification modification,
                        @NotNull
                        VcsRoot root,
                        @Nullable
                        java.util.Collection<SBuildType> buildTypes)

Description copied from interface: BuildServerListener

Called when a new modification (user commit) was detected. Vcs modification can be detected during periodical process of changes collecting (in this case buildTypes parameter is null) or during build(s) startup phase. In the latter case buildTypes parameter will contain collection of build configurations for which changes collection was performed.

Specified by:

changeAdded in interface BuildServerListener

Parameters:

modification - detected VCS modification

root - VCS root where modification was detected

buildTypes - if changes were detected when a build starts collection of buildTypes where changes collection was performed

agentStatusChanged

public void agentStatusChanged(@NotNull
                               SBuildAgent agent,
                               boolean wasEnabled,
                               boolean wasAuthorized)

Description copied from interface: BuildServerListener

Called when the status of an agent is changed by a user

Specified by:

agentStatusChanged in interface BuildServerListener

Parameters:

agent - the agent

wasEnabled - the previous status

wasAuthorized - previous authorized state

cleanupStarted

public void cleanupStarted()

Description copied from interface: BuildServerListener

Called when database cleanup is going to start.

Specified by:

cleanupStarted in interface BuildServerListener

cleanupFinished

public void cleanupFinished()

Description copied from interface: BuildServerListener

Called when database cleanup has been finished.

Specified by:

cleanupFinished in interface BuildServerListener

serverShutdownComplete

public void serverShutdownComplete()

Description copied from interface: BuildServerListener

Event called after server shutdown complete. Used to terminate hung child processes.

Specified by:

serverShutdownComplete in interface BuildServerListener

sourcesVersionReleased

public void sourcesVersionReleased(@NotNull
                                   BuildAgent agent)

Description copied from interface: BuildServerListener

Clean sources performed for the given agent

Specified by:

sourcesVersionReleased in interface BuildServerListener

Parameters:

agent - build agent whose sources are about to clean todo: change to S-interfaces

sourcesVersionReleased

public void sourcesVersionReleased(@NotNull
                                   BuildType configuration)

Description copied from interface: BuildServerListener

Clean sources performed for the given configuraton on all agents

Specified by:

sourcesVersionReleased in interface BuildServerListener

Parameters:

configuration - build configuration, whose sources to clean todo: change to S-interfaces

sourcesVersionReleased

public void sourcesVersionReleased(@NotNull
                                   BuildType configuration,
                                   @NotNull
                                   BuildAgent agent)

Description copied from interface: BuildServerListener

Clean sources performed for the given configuraton on the given agent

Specified by:

sourcesVersionReleased in interface BuildServerListener

Parameters:

configuration - build configuration, whose sources to clean

agent - agent where to clean sources todo: change to S-interfaces

labelingFailed

public void labelingFailed(SBuild build,
                           VcsRoot root,
                           java.lang.Throwable exception)

Description copied from interface: BuildServerListener

Labeling process failed for the specified build and root with the specified problem.

Specified by:

labelingFailed in interface BuildServerListener

Parameters:

build - build for which labeling failed.

root - root for which labeling failed.

exception - labeling cause.

labelingSucceed

public void labelingSucceed(SBuild build,
                            BuildRevision revision)

Description copied from interface: BuildServerListener

Labeling process succeed for the specified build and revision

Specified by:

labelingSucceed in interface BuildServerListener

Parameters:

build - build for which labeling failed.

revision - labeled.

buildTagsChanged

public void buildTagsChanged(SBuild build,
                             java.util.List<java.lang.String> oldTags,
                             java.util.List<java.lang.String> newTags)

Description copied from interface: BuildServerListener

Called when build tags have been set to specifiled values

Specified by:

buildTagsChanged in interface BuildServerListener

Parameters:

build - corresponding build, which tags have been set

oldTags - previous tags on the build

newTags - new tags on the build

buildTagsChanged

public void buildTagsChanged(SBuild build,
                             User user,
                             java.util.List<java.lang.String> oldTags,
                             java.util.List<java.lang.String> newTags)

Description copied from interface: BuildServerListener

Called when build tags have been set to specifiled values

Specified by:

buildTagsChanged in interface BuildServerListener

Parameters:

build - corresponding build, which tags have been set

user - user who set new tags

oldTags - previous tags on the build

newTags - new tags on the build

buildCommented

public void buildCommented(@NotNull
                           SBuild build,
                           @Nullable
                           User user,
                           @Nullable
                           java.lang.String comment)

Description copied from interface: BuildServerListener

Called when user comment the build

Specified by:

buildCommented in interface BuildServerListener

Parameters:

build - commented build

user - the user who commented the build

comment - comment provided by user

serverConfigurationReloaded

public void serverConfigurationReloaded()

Description copied from interface: BuildServerListener

Called when the main server configuration file is reloaded

Specified by:

serverConfigurationReloaded in interface BuildServerListener

vcsRootsPersisted

public void vcsRootsPersisted()

Description copied from interface: BuildServerListener

Called when VCS roots are saved to disk

Specified by:

vcsRootsPersisted in interface BuildServerListener

vcsRootRemoved

public void vcsRootRemoved(@NotNull
                           SVcsRoot root)

Description copied from interface: BuildServerListener

Called when VCS root was removed

Specified by:

vcsRootRemoved in interface BuildServerListener

Parameters:

root - vcs root

vcsRootUpdated

public void vcsRootUpdated(@NotNull
                           SVcsRoot oldVcsRoot,
                           @NotNull
                           SVcsRoot newVcsRoot)

Description copied from interface: BuildServerListener

Called when VCS root settings has c

Specified by:

vcsRootUpdated in interface BuildServerListener

testsMuted

public void testsMuted(@NotNull
                       MuteInfo muteInfo)

Description copied from interface: BuildServerListener

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

Specified by:

testsMuted in interface BuildServerListener

Parameters:

muteInfo - mute info

testsUnmuted

public void testsUnmuted(@NotNull
                         SProject project,
                         @NotNull
                         java.util.Collection<com.intellij.openapi.util.Pair<MuteInfo,java.util.Collection<STest>>> unmutedGroups)

Description copied from interface: BuildServerListener

Called when several of tests have been unmuted. All tests belong to one project.

Specified by:

testsUnmuted in interface BuildServerListener

Parameters:

project - project where tests were unmuted.

unmutedGroups - groups of tests that were unmuted.