Listen to events

In Release your custom code can react on the activity log events that are happening inside releases or triggers. These events are published in a lot of different moments during the release or trigger execution.

Example

In the following example, you will see how to listen to one of the Release events and react to it.

Important: If you are using maven or gradle to build your plugin, you must add the Digital.ai Deploy/Release Maven repository: https://dist.xebialabs.com/public/maven2 and the following dependency: com.xebialabs.xlrelease:xlr-api:9.8.x.

Gradle

repositories {
  ...
  maven {
    url 'https://dist.xebialabs.com/public/maven2'
  }
}
dependencies {
  ...
  compile: "com.xebialabs.xlrelease:xlr-api:9.8.0"
}

Maven

<project>
  ...
  <repositories>
    <repository>
      <id>xebialabs-dist-repo</id>
      <name>XebiaLabs maven repository</name>
      <url>https://dist.xebialabs.com/public/maven2</url>
    </repository>
  </repositories>
  ...
  <dependencies>
    ...
    <dependency>
      <groupId>com.xebialabs.xlrelease</groupId>
      <artifactId>xlr-api</artifactId>
      <version>9.8.0</version>
    </dependency>
  </dependencies>
  ...
</project>

Here is a sample of the directories inside your plugin structure:

phase-notify-plugin
├── META-INF/services
│   └── com.xebialabs.xlrelease.events.XLReleaseEventListener
└── com/example/plugin
    └── PhaseNotifiyListener.java

Release uses java ServiceLoader to discover your custom listeners.

You must create a file with the name com.xebialabs.xlrelease.events.XLReleaseEventListener inside your .jar file under the META-INF/services directory.

META-INF/services/com.xebialabs.xlrelease.events.XLReleaseEventListener

The content of the file is a line with the implementation of the XLReleaseEventListener, in this case:

com.example.plugin.PhaseNotifiyListener

Create a Java class PhaseNotifiyListener inside the com.example.plugin package:

package com.example.plugin;

import com.xebialabs.xlrelease.domain.events.ActivityLogEvent;
import com.xebialabs.xlrelease.events.AsyncSubscribe;
import com.xebialabs.xlrelease.events.XLReleaseEventListener;

public class PhaseNotifiyListener implements XLReleaseEventListener {

  private NotificationApi notificationApi = new ....

  @AsyncSubscribe
  public void notifyCriticalPhaseStarted(ActivityLogEvent event) {
    if (e.activityType().equals(PHASE\_STARTED) && e.message().contains(Critical phase)) {
      notificationApi.sendAlert(Critical phase started!, all@xebialabs.com);
    }
  }

}

Your Java class must implement the interface XLReleaseEventListener (this is the same as the file created under META-INF/services). The method with the event logic must be annotated with @AsyncSubscribe. This TestListener is listening to all ActivityLogEvent. If the event type is PHASE_STARTED and contains the critical phase name, it sends an alert to all@xebialabs.com that a critical phase has started.

Important: As this class is instantiated by Release, the constructor cannot have any argument.

Note: As of Release 8.5.3, ActivityLogEvent has an additional property releaseId of type string.

Using the Configuration API

It is also possible to use the Configuration API from your java class. You must create a private field with the @Resource annotation and Release will inject the interface for you.

package com.example.plugin;

import javax.annotation.Resource;

import com.xebialabs.xlrelease.api.v1.ConfigurationApi;
import com.xebialabs.xlrelease.domain.events.ActivityLogEvent;
import com.xebialabs.xlrelease.events.AsyncSubscribe;
import com.xebialabs.xlrelease.events.XLReleaseEventListener;

public class PhaseNotifiyListener implements XLReleaseEventListener {

  @Resource
  private ConfigurationApi configurationApi;

  @AsyncSubscribe
  public void notifyCriticalPhaseStarted(ActivityLogEvent event) {
    configurationApi.searchByTypeAndTitle(.......)
    ...
  }

}

Update plugins to replace DeployitEventListener with XLReleaseEventListener

The DeployitEventListener property has been removed and is no longer supported. If you are using this property in your custom plugins, follow these steps to update your custom plugins:

1. Add a new dependency in build.gradle:

   compile "com.xebialabs.xlrelease:xlr-api:8.2.x"

   You can now add the new events dependencies on the plugin scope.

2. All classes that have the @DeployitEventListener annotation must be changed to implement XLReleaseEventListener.
3. All methods on your old classes containing @Subscribe must be replaced with @AsyncSubscribe and the parameter must be changed to ActivityLogEvent.
4. In the resources folder, create two new folders (META-INF/services) and a file named com.xebialabs.xlrelease.events.XLReleaseEventListener. Using a text editor, open com.xebialabs.xlrelease.events.XLReleaseEventListener and add a text line with the full name of your old class. This is required from Release to detect these “listener” classes outside the Release package.

List of activity types

The following table shows the different activity log types that you can receive in different moments for a release:

The following table shows the different activity log types that you can receive in different moments for a trigger: