Jira Event Listener for Jira 7+

Question

Hello,

I wanted to create a Jira Event Listener with this Tutorial (https://developer.atlassian.com/server/jira/platform/writing-jira-event-listeners-with-the-atlassian-event-library/), but it is outdated and the listener won't work.

I found some posts with the same topic, but nothing helps me to get the listener working. I always create some errors, because there's nowhere a step by step instruction how to do it.

Could you please help me in saying what I have to change from the above linked tutorial to get it working in Jira 7+? Or do you have a downloadable source that I can use and that is working?

I know that all component-tags must disappear in the "atlassian-plugin.xml".

But how should the "IssueCreatedResolvedListener.java" file look like? And all the files beneath that. The pom.xml and stuff?

My last try with the "IssueCreatedResolvedListener.java" was this one:

package com.example.tutorial.plugins;

import com.atlassian.event.api.EventListener;
import com.atlassian.event.api.EventPublisher;
import com.atlassian.jira.event.issue.IssueEvent;
import com.atlassian.jira.event.type.EventType;
import com.atlassian.jira.issue.Issue;
//import com.atlassian.plugin.spring.scanner.annotation.export.ExportAsService;
import com.atlassian.sal.api.lifecycle.LifecycleAware;

//import javax.inject.Named;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.DisposableBean;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.stereotype.Component;

/**
 * Simple JIRA listener using the atlassian-event library and demonstrating
 * plugin lifecycle integration.
 */
//@ExportAsService
@Component
//@Named("IssueCreatedResolvedListener")
public class IssueCreatedResolvedListener implements InitializingBean, DisposableBean, LifecycleAware {

private static final Logger log = LoggerFactory.getLogger(IssueCreatedResolvedListener.class);

private final EventPublisher eventPublisher;

/**
     * Constructor.
     * @param eventPublisher injected {@code EventPublisher} implementation.
     */
    public IssueCreatedResolvedListener(EventPublisher eventPublisher) {
        this.eventPublisher = eventPublisher;
    }

/**
     * Called when the plugin has been enabled.
     * @throws Exception
     */
    @Override
    public void afterPropertiesSet() throws Exception {
        // register ourselves with the EventPublisher
        eventPublisher.register(this);
    }

/**
     * Called when the plugin is being disabled or removed.
     * @throws Exception
     */
    @Override
    public void destroy() throws Exception {
        // unregister ourselves with the EventPublisher
        eventPublisher.unregister(this);
    }

/**
     * Receives any {@code IssueEvent}s sent by JIRA.
     * @param issueEvent the IssueEvent passed to us
     */
    @EventListener
    public void onIssueEvent(IssueEvent issueEvent) {
        Long eventTypeId = issueEvent.getEventTypeId();
        Issue issue = issueEvent.getIssue();
        // if it's an event we're interested in, log it
        if (eventTypeId.equals(EventType.ISSUE_CREATED_ID)) {
            log.info("Issue {} has been created at {}.", issue.getKey(), issue.getCreated());
        } else if (eventTypeId.equals(EventType.ISSUE_RESOLVED_ID)) {
            log.info("Issue {} has been resolved at {}.", issue.getKey(), issue.getResolutionDate());
        } else if (eventTypeId.equals(EventType.ISSUE_CLOSED_ID)) {
            log.info("Issue {} has been closed at {}.", issue.getKey(), issue.getUpdated());
        }
    }

@Override
    public void onStart() {
        // TODO Auto-generated method stub
        
    }

@Override
    public void onStop() {
        // TODO Auto-generated method stub
        
    }
}

But it is not working.

Thank you very much. I hope that you can help me out a bit. I'm totally confused what to do here...

Best regards,

Hauke

karim -Atlassway- · Answer

hello @Hauke Hörhold

Thank you very much.

Regards

Hauke Hörhold · Answer

I just found another version of IssueEventListener, it should be it bit newer. Good luck with it: XXXIssueEventListener.java: package com.XXX.jira; import com.atlassian.jira.component.ComponentAccessor; import com.atlassian.jira.event.issue.IssueEvent; import com.atlassian.jira.event.type.EventType; import com.atlassian.jira.issue.Issue; import java.util.Map; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.stereotype.Component; import com.atlassian.jira.event.issue.IssueEventListener; import com.atlassian.jira.issue.CustomFieldManager; import com.atlassian.jira.issue.fields.CustomField; @Component public class XXXIssueEventListener implements IssueEventListener { private static Logger log; private final CustomFieldManager customFieldManager; public XXXIssueEventListener() { log = LoggerFactory.getLogger(XXXIssueEventListener.class); this.customFieldManager = ComponentAccessor.getCustomFieldManager(); } @Override public void workflowEvent(IssueEvent issueEvent) { if (issueEvent.getEventTypeId() == EventType.ISSUE_WORKLOGGED_ID) { Issue issue = issueEvent.getIssue(); CustomField customField = customFieldManager.getCustomFieldObject("customfield_10000"); // "customfield_10000" = "PSP-Element", siehe http://localhost:2990/jira/rest/api/2/field Object customFieldValue = customField.getValue(issue); System.out.println(); System.out.println("Working hours updated!"); System.out.println("Issue Name: " + issue); System.out.println("Issue ID: " + issue.getId()); System.out.println("Bearbeitet von: " + issueEvent.getWorklog().getUpdateAuthorObject()); System.out.println("Datum: " + issueEvent.getWorklog().getUpdated()); System.out.println("Gebuchte Zeit (min): " + issueEvent.getWorklog().getTimeSpent() / 60); System.out.println("Kommentar: " + issueEvent.getWorklog().getComment()); System.out.println("Custom Field: " + customFieldValue); log.info("Issue {} has been updated at {}.", issue.getKey(), issue.getCreated()); } } @Override public String[] getAcceptedParams() { return null; } @Override public String getDescription() { return null; } @Override public void init(Map arg0) { } @Override public boolean isInternal() { return false; } @Override public boolean isUnique() { return false; } @Override public void customEvent(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueAssigned(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueClosed(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueCommented(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueCreated(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueDeleted(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueGenericEvent(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueMoved(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueReopened(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueResolved(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueStarted(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueStopped(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueUpdated(IssueEvent arg0) { this.workflowEvent(arg0); } @Override public void issueWorkLogged(IssueEvent arg0) { this.workflowEvent(arg0); } } pom.xml: 4.0.0 com.XXX.jira listenerPlugin 1.0 XXX http://www.XXX.com/ listenerPlugin This is the com.XXX.jira:listenerPlugin plugin for Atlassian JIRA. atlassian-plugin com.atlassian.jira jira-api ${jira.version} provided junit junit 4.10 test com.atlassian.plugin atlassian-spring-scanner-annotation ${atlassian.spring.scanner.version} provided com.atlassian.plugin atlassian-spring-scanner-runtime ${atlassian.spring.scanner.version} provided javax.inject javax.inject 1 provided com.atlassian.plugins atlassian-plugins-osgi-testrunner ${plugin.testrunner.version} test javax.ws.rs jsr311-api 1.1.1 provided com.google.code.gson gson 2.2.2-atlassian-1 org.springframework spring 2.5.6 jar provided org.springframework spring-context 2.5.6.SEC02 jar provided org.springframework.security spring-security-config 5.0.5.RELEASE provided com.atlassian.labs.plugins quickreload 2.0.1 provided com.atlassian.jira atlassian-jira-webapp 7.7.1 war com.atlassian.maven.plugins maven-jira-plugin ${amps.version} true ${jira.version} ${jira.version} true false false false false true false true false com.atlassian.labs.plugins quickreload 2.0.1

${atlassian.plugin.key}

com.XXX.jira.api,

org.springframework.osgi.*;resolution:="optional", org.eclipse.gemini.blueprint.*;resolution:="optional", *;version="0";resolution:=optional

*

com.atlassian.plugin atlassian-spring-scanner-maven-plugin ${atlassian.spring.scanner.version} atlassian-spring-scanner process-classes com.atlassian.plugin atlassian-spring-scanner-external-jar false atlassian Atlassian Repository https://maven.atlassian.com/content/groups/public/ true true atlassian-public https://m2proxy.atlassian.com/repository/public/ true true 7.7.1 6.3.15 1.2.3 1.2.13 ${project.groupId}.${project.artifactId} 6.3.11 UTF-8 1.8 1.8 C:\Applications\Atlassian\atlassian-plugin-sdk-6.3.10\repository 3.3 3.1 2.0.1

Hauke Hörhold · Answer

I don't know exactly if this is working, because it is 1 year ago and I stopped using a listener for my needs, now I override the CreateWorklog Class. But I think this was working Listener code: XXXIssueEventListener: package com.example.tutorial.plugins; //import com.atlassian.event.api.EventPublisher; import com.atlassian.jira.event.issue.IssueEvent; import com.atlassian.jira.event.type.EventType; import com.atlassian.jira.issue.Issue; //import com.atlassian.plugin.spring.scanner.annotation.imports.JiraImport; import java.util.Map; import org.slf4j.Logger; import org.slf4j.LoggerFactory; //import org.springframework.beans.factory.DisposableBean; //import org.springframework.beans.factory.InitializingBean; //import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; import com.atlassian.jira.event.issue.IssueEventListener; @Component public class XXXIssueEventListener implements IssueEventListener { private static Logger log; public XXXIssueEventListener() { log = LoggerFactory.getLogger(XXXIssueEventListener.class); } @Override public String[] getAcceptedParams() { // TODO Auto-generated method stub return null; } @Override public String getDescription() { // TODO Auto-generated method stub return null; } @Override public void init(Map arg0) { // TODO Auto-generated method stub } @Override public boolean isInternal() { // TODO Auto-generated method stub return false; } @Override public boolean isUnique() { // TODO Auto-generated method stub return false; } @Override public void customEvent(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueAssigned(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueClosed(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueCommented(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueCreated(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueDeleted(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueGenericEvent(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueMoved(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueReopened(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueResolved(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueStarted(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueStopped(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueUpdated(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void issueWorkLogged(IssueEvent arg0) { // TODO Auto-generated method stub this.workflowEvent(arg0); } @Override public void workflowEvent(IssueEvent issueEvent) { if (issueEvent.getEventTypeId() == EventType.ISSUE_WORKLOGGED_ID) { Issue issue = issueEvent.getIssue(); System.out.println(issueEvent.getWorklog().getTimeSpent() / 60 ); System.out.println("Working hours updated!"); System.out.println("Issue: " + issue.getKey()); System.out.println("Bearbeitet von: " + issue.getReporter()); System.out.println("Datum: " + issue.getUpdated()); System.out.println("Stunden: " + issue.getTimeSpent()); log.info("Issue {} has been updated at {}.", issue.getKey(), issue.getCreated()); } } } IssueCreatedResolvedListener: package com.example.tutorial.plugins; import com.atlassian.event.api.EventListener; import com.atlassian.event.api.EventPublisher; import com.atlassian.jira.event.issue.IssueEvent; import com.atlassian.jira.event.type.EventType; import com.atlassian.jira.issue.Issue; import com.atlassian.plugin.spring.scanner.annotation.imports.JiraImport; //import java.util.Map; import org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.DisposableBean; import org.springframework.beans.factory.InitializingBean; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; //import com.atlassian.jira.event.issue.IssueEventListener; @Component public class IssueCreatedResolvedListener implements InitializingBean, DisposableBean { private static final Logger log = LoggerFactory.getLogger(IssueCreatedResolvedListener.class); @JiraImport private final EventPublisher eventPublisher; @Autowired public IssueCreatedResolvedListener(EventPublisher eventPublisher) { this.eventPublisher = eventPublisher; } /** * Called when the plugin has been enabled. * @throws Exception */ @Override public void afterPropertiesSet() throws Exception { log.info("Enabling plugin"); eventPublisher.register(this); } /** * Called when the plugin is being disabled or removed. * @throws Exception */ @Override public void destroy() throws Exception { log.info("Disabling plugin"); eventPublisher.unregister(this); } @EventListener public void onIssueEvent(IssueEvent issueEvent) { Long eventTypeId = issueEvent.getEventTypeId(); Issue issue = issueEvent.getIssue(); if (eventTypeId.equals(EventType.ISSUE_CREATED_ID)) { System.out.println("TEST created"); log.info("Issue {} has been created at {}.", issue.getKey(), issue.getCreated()); } else if (eventTypeId.equals(EventType.ISSUE_RESOLVED_ID)) { System.out.println("TEST ISSUE_RESOLVED_ID"); log.info("Issue {} has been resolved at {}.", issue.getKey(), issue.getResolutionDate()); } else if (eventTypeId.equals(EventType.ISSUE_CLOSED_ID)) { System.out.println("TEST created"); log.info("Issue {} has been closed at {}.", issue.getKey(), issue.getUpdated()); } else if (eventTypeId.equals(EventType.ISSUE_UPDATED_ID)) { System.out.println("TEST created"); log.info("Issue {} has been closed at {}.", issue.getKey(), issue.getUpdated()); } } } And this is the pom.xml: 4.0.0 com.example.tutorial.plugins new-listener-plugin 1.0-SNAPSHOT XXX http://XXX.XXX/ new-listener-plugin This should listen... atlassian-plugin com.atlassian.jira jira-api ${jira.version} provided junit junit 4.10 test com.atlassian.plugin atlassian-spring-scanner-annotation ${atlassian.spring.scanner.version} compile com.atlassian.plugin atlassian-spring-scanner-runtime ${atlassian.spring.scanner.version} runtime javax.inject javax.inject 1 provided com.atlassian.plugins atlassian-plugins-osgi-testrunner ${plugin.testrunner.version} test javax.ws.rs jsr311-api 1.1.1 provided com.google.code.gson gson 2.2.2-atlassian-1 org.springframework spring-context 4.3.6.RELEASE provided org.mockito mockito-all 1.8.5 test com.atlassian.maven.plugins maven-jira-plugin ${amps.version} true src/aps/log4j.properties jira-software ${jira.version} ${jira.version} ${jira.version} true false false false true false true false com.atlassian.labs.plugins quickreload ${quick.reload.version}

${atlassian.plugin.key}

com.example.tutorial.plugins.api,

org.springframework.osgi.*;resolution:="optional", org.eclipse.gemini.blueprint.*;resolution:="optional", *

*

true com.atlassian.plugin atlassian-spring-scanner-maven-plugin ${atlassian.spring.scanner.version} atlassian-spring-scanner process-classes com.atlassian.plugin atlassian-spring-scanner-external-jar false 7.7.1 6.3.15 1.2.3 1.2.13 ${project.groupId}.${project.artifactId} 6.3.11 UTF-8 1.8 1.8