Bamboo Event Listeners

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

1
2
<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>

Example Event Listener

In the example below the CustomerListener class implements HibernateEventListener. By overriding the getHandledEventClasses method you can filter which events this listener will handle. In this case it the BambooErrorEvent event. In the handleEvent method the code checks the event to ensure it is an instanceof the BambooErrorEvent. In this example it is redundant since it should only be the BambooErrorEvent due to the implementation of the getHandledEventClasses method. However, if the class were implemented to listen for multiple events then the check using instanceof for each event would be necessary.

Example Event Listener

1
2
public class CustomListener implements HibernateEventListener {

    @Override
    public Class[] getHandledEventClasses() {
        return new Class[]{BambooErrorEvent.class};
    }

    @Override
    public void handleEvent(Event event) {

        if (event instanceof BambooErrorEvent) {
            BambooErrorEvent errorEvent = (BambooErrorEvent) event;

            ErrorDetails details = errorEvent.getErrorDetails();
            // do something with ErrorDetails
        }
    }
}

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.

Most of these events either extend a BuildEvent (build key available) or a BuildResultEvent (build key and build number available).