All Versions
Bamboo 5.13Bamboo 5.7.x
Bamboo 5.6.x
More...
Available: |
Bamboo 2.2 and later |
|---|
On this page:
Description
The Bamboo Event Listener module allows developers to register an event listener against any event that is currently thrown in Bamboo and perform arbitrary operations. Some examples include sending off notifications or terminating a build when it hung.
It would be wise to note that currently Bamboo does not support using Atlassian Event 2.x listeners or events from this extension type.
Interface
All event listener modules implement the com.atlassian.event.EventListener interface or alternatively the com.atlassian.bamboo.event.HibernateEventListener which will automatically provide you with a hibernate session to access to the database (required for writing notification plugins).
Sample Module Descriptor Element
<bambooEventListener key="buildHungNotificationListener" name="Build Hung Notification Listener"
class="com.atlassian.bamboo.notification.buildhung.BuildHungNotificationListener">
<description>Listens for if a build has hung.</description>
</bambooEventListener>
Available Events to listen to
There is a number of events currently available in Bamboo. Each event contains information regarding the context in which it was thrown.
Event |
Notes |
|---|---|
Occurs when a specific agent is updated (e.g the agent has been create or disabled) |
|
Occurs when a specific agent goes offline |
|
Occurs if there is an update that will effect all agents e.g. disabling/enabling all agents or updating capability sets |
|
These are any errors generated by the Bamboo system. These are the same errors which are displayed as System Errors in the Bamboo UI. This may include failing checkouts, agents going offline etc. |
|
Occurs when a Job or Build is canceled via the PlanExecutionManager |
|
Occurs when a result has been commented on by the User |
|
Occurs after a Job or Build has completed and results saved to the database but not necessarily before or after any CustomBuildCompleteActions are performed |
|
Occurs when the the build configuration has been updated |
|
Occurs when a Job or Build has been created |
|
Occurs when a Job or Build has been deleted |
|
Occurs when BuildExecutionManager.finishBuild() has been called on a Job or Build. This is guaranteed to be fired even if the system has encountered an irrecoverable error and as such a corresponding BuildResultSummary may not be available. |
|
Occurs when a Job or Build has been queued |
|
Occurs when a Job or Build has timed out whilst being on the queue. |
|
Occurs when Bamboo's build monitoring detects the build has met the configured build hanging criteria |
|
Occurs when a Requirement has changed on a Job or Build |
|
Occurs when a result for a Job or Build has been deleted |
|
Occurs when a result for a Job or Build has been updated. Currently the only way to edit a build summary is editing the JIRA issues associated with the build. |
|
Occurs when moving plans between projects. |
|
In Bamboo 2.6 and earlier, this event occurs after a bamboo has detected that the Build needs building, before the build is placed on the queue. In Bamboo 2.7 and later, this event occurs when a job has been executed. |
|
Event which signifies that Bamboo should check repositories for changes |
|
Occurs when a Plan finishes executing |
|
Occurs when a Plan is created |
|
Occurs when a Plan is deleted |
|
Occurs when a Plan Result has been deleted |
|
Occurs after the deletion action has finished |
|
Occurs when an Elastic Configuration has been updated |
|
Occurs when an email is to be sent |
|
Occurs when an instant message is to be sent |
|
Occurs when bamboo detects that an initial clean build is required for a plan (usually after plan creation or importing data) |
|
Occurs when a [Job] has finished executing |
|
Thrown after the build is saved AND the build process has been completely cleaned up |
|
This event is fired when the Bamboo server has completed its initialisation process — that is, after Bamboo has completed the following tasks:
|
|
Occurs when a stage has completed executing |
Most of these events either extend a BuildEvent (build key available) or a BuildResultEvent (build key and build number available).
Overview
Content Tools
Apps
Except where otherwise noted, content in this space is licensed under a Creative Commons Attribution 2.5 Australia License.