Writing Jira event listeners with the atlassian-event library

Overview of the tutorial

Jira supported a simple listener API for a long time. However, that API has several problems and its installation and configuration are difficult. Also, starting from Jira 4.0 it’s impossible to share code between listeners and apps.

Fortunately, you can use the atlassian-event library to implement the same functionality and avoid these problems.

In this tutorial, you will create an app that listens for events generated when an issue is created or resolved. When the events occur, the app will log the event.

Your completed app will consist of the following components:

• Java classes encapsulating the app logic.
• An app descriptor (that is, XML file) to enable the plugin module in the Atlassian application.

When you are finished, all these components will be packaged in a single JAR file.

Before you begin

To complete this tutorial, you need to know the following: 

1. The basics of Java development: classes, interfaces, methods, how to use the compiler, and so on.
2. How to create an Atlassian plugin project using the Atlassian Plugin SDK.
3. The basics of using and administering Jira.

App source

We encourage you to work through this tutorial. If you want to skip ahead or check your work when you are finished, you can find the app source code on Atlassian Bitbucket.

To clone the repository, run the following command:

1

git clone https://bitbucket.org/atlassian_tutorial/jira-event-listener

Alternatively, you can download the source as a ZIP archive. 

Step 1. Create the app project

In this step, you’ll use an atlas command to generate stub code for your app. The atlas commands are part of the Atlassian Plugin SDK and automate much of the work of app development for you.

1. Set up the Atlassian Plugin SDK and build a project if you did not do it yet.
2. Open a Terminal and navigate to directory where you would like to keep your app code.

3. To create an app skeleton, run the following command:

   1	atlas-create-jira-plugin

4. To identify your app, enter the following information.

   group-id	com.example.tutorial.plugins
   artifact-id	new-listener-plugin
   version	1.0-SNAPSHOT
   package	com.example.tutorial.plugins

5. Confirm your entries when prompted.

6. Delete the test directories.

   Setting up testing for your app isn’t part of this tutorial. To delete the generated test skeleton, run the following commands:

   1 2	rm -rf src/test/resources rm -rf src/test/java

7. Delete the unneeded Java class files.

   1	rm -rf src/main/java/com/example/tutorial/plugins/*

8. Import the project to your favorite IDE.

Step 2. Modify the POM metadata and add a dependency

The POM (that is, Project Object Model definition file) declares your app’s dependencies, build settings, and metadata (information about your app). Modify the POM as follows:

1. Navigate to the new-listener-plugin directory created by the SDK.
2. Open the pom.xml file.

3. Add your company or organization name and your website URL to the organization element.

   1 2 3 4

   <organization> <name>Example Company</name> <url>http://www.example.com/</url> </organization>

4. Update the description element:

   1	<description>This plugin implements a simple issue event listener for JIRA using atlassian-event.</description>

5. Add the following dependency as a child of the dependencies element:

   1 2 3 4 5 6

   <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>4.3.6.RELEASE</version> <scope>provided</scope> </dependency>

   The org.springframework version should match the version used by the UPM (that is, Universal Plugin Manager).

6. We’ll use a custom log4j.properties file for this app. Add the following element as a child of the project.build.plugins.plugin.configuration element:

   1	<log4jProperties>src/aps/log4j.properties</log4jProperties>

   The complete plugin element should look like this:

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25

   <plugin> <groupId>com.atlassian.maven.plugins</groupId> <artifactId>maven-jira-plugin</artifactId> <version>${amps.version}</version> <extensions>true</extensions> <configuration> <productVersion>${jira.version}</productVersion> <productDataVersion>${jira.version}</productDataVersion> <log4jProperties>src/aps/log4j.properties</log4jProperties> <enableQuickReload>true</enableQuickReload> <enableFastdev>false</enableFastdev> <instructions> <Atlassian-Plugin-Key>${atlassian.plugin.key}</Atlassian-Plugin-Key> <Export-Package> com.example.tutorial.plugins.api, </Export-Package> <Import-Package> org.springframework.osgi.*;resolution:="optional", org.eclipse.gemini.blueprint.*;resolution:="optional", * </Import-Package> <Spring-Context>*</Spring-Context> </instructions> </configuration> </plugin>

7. Save the file.

Step 3. Write the Java class

This tutorial doesn’t require any updates to app descriptor. The steps for creating an event listener are the following:

1. Inject the EventPublisher implementation into your class.
2. Add an @EventListener annotation to any method that should receive events.
3. Handle events as they come in.

To demonstrate this, we’ll create a listener that will log a notification when an issue is created, resolved, or closed.

You can use same approach to send notifications to email or IRC (that is, Internet Relay Chat).

In the following steps, you’ll create the class file and build on it.

1. Navigate to src/main/java/com/example/tutorial/plugins/ and create a file named IssueCreatedResolvedListener.java.

2. Add the following code to the file:

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18

   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 org.slf4j.Logger; import org.slf4j.LoggerFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Component; @Component public class IssueCreatedResolvedListener { private static final Logger log = LoggerFactory.getLogger(IssueCreatedResolvedListener.class); }

   So far, we’ve declared a few import statements and instantiated a logger that we’ll use to record events. 

3. Add a constructor that injects an EventPublisher instance into the app and register our listener using the EventPublisher:

   1 2 3 4

   @Autowired public IssueCreatedResolvedListener(@JiraImport EventPublisher eventPublisher) { eventPublisher.register(this); // Demonstration only -- don't do this in real code! }

   We added a @JiraImport annotation for EventPublisher, so Atlassian Spring Scanner will import it for us. The EventPublisher object handles publication of events and registration of event listeners.

4. To handle the event, add the following method:

   1 2 3 4 5 6 7 8 9 10 11 12 13

   @EventListener public void onIssueEvent(IssueEvent issueEvent) { Long eventTypeId = issueEvent.getEventTypeId(); Issue issue = issueEvent.getIssue(); 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()); } }

   Notice that the method is annotated with EventListener. You can apply the EventListener annotation to any public method. The method must take a parameter corresponding to the event it should handle, IssueEvent in this case.

   Jira provides several events, for descriptions see the page about Jira-Specific Atlassian events.

5. Navigate to src/aps and create the file called log4j.properties.

   This is the custom resource we added to the app’s configuration in the POM. We need a custom
   file because the Jira log4j implementation doesn’t know anything about our app logger. And, because our package name is com.example.tutorial.plugins, we don’t inherit any of the com.atlassian hierarchical loggers.

6. Add the following code to the file:

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539

   ##################################################### # LOGGING LEVELS ##################################################### # To turn more verbose logging on - change "WARN" to "DEBUG" log4j.rootLogger=WARN, console, filelog ##################################################### # LOG FILE LOCATIONS ##################################################### log4j.appender.console=org.apache.log4j.ConsoleAppender log4j.appender.console.Threshold=DEBUG log4j.appender.console.layout=org.apache.log4j.PatternLayout log4j.appender.console.layout.ConversionPattern=%d %t %p %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.ipaddr} %X{jira.request.url} [%c{4}] %m%n log4j.appender.nowarnconsole=org.apache.log4j.ConsoleAppender log4j.appender.nowarnconsole.Threshold=DEBUG log4j.appender.nowarnconsole.layout=org.apache.log4j.PatternLayout log4j.appender.nowarnconsole.layout.ConversionPattern=%d %t %p %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.ipaddr} %X{jira.request.url} [%c{4}] %m%n log4j.appender.filelog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.filelog.File=atlassian-jira.log log4j.appender.filelog.MaxFileSize=20480KB log4j.appender.filelog.MaxBackupIndex=5 log4j.appender.filelog.layout=com.atlassian.logging.log4j.FilteredPatternLayout log4j.appender.filelog.layout.ConversionPattern=%d %t %p %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.ipaddr} %X{jira.request.url} [%c{4}] %m%n log4j.appender.filelog.layout.MinimumLines=6 log4j.appender.filelog.layout.FilteringApplied=true log4j.appender.filelog.layout.ShowEludedSummary=true # # These are the Java stack frames that will be filtered out when an exception is logged. This is to help reduce the # noise to information ratio in the JIRA logs. Its a long comma seperated list with .properties line continuation # provided by the / character. # # It will always how the 'MinimumLines' value above regardless of these settings. Also DEBUG level stack traces will always # be shown in their entirety. # # You can quickly revert to full stack traces by setting 'FilteringApplied'=false above or by removing the lines below # and restarting JIRA. # log4j.appender.filelog.layout.FilteredFrames=\ sun.reflect, \ \ org.apache.catalina, \ org.apache.coyote, \ org.apache.tomcat.util.net, \ org.apache.catalina.core.ApplicationFilterChain, \ \ webwork.interceptor, \ webwork.dispatcher, \ webwork.action.ActionSupport, \ com.opensymphony.sitemesh, \ \ com.sun.jersey.server.impl, \ com.sun.jersey.spi.container.servlet, \ \ com.atlassian.jira.web.dispatcher, \ com.atlassian.jira.web.filters, \ com.atlassian.jira.web.filters.steps, \ com.atlassian.jira.startup.JiraStartupChecklistFilter, \ com.atlassian.jira.security.xsrf.XsrfTokenAdditionRequestFilter, \ \ com.atlassian.seraph.filter, \ com.atlassian.security.auth.trustedapps.filter, \ com.atlassian.plugin.servlet.filter, \ com.atlassian.plugins.rest.common, \ com.atlassian.core.filters, \ com.atlassian.util.profiling.filters, \ com.atlassian.johnson.filters, \ \ com.atlassian.gzipfilter.GzipFilter, \ com.atlassian.applinks.core.rest.context.ContextFilter, \ com.atlassian.plugins.rest.module.servlet.RestServletUtilsUpdaterFilter, \ com.atlassian.oauth.serviceprovider.internal.servlet.OAuthFilter, \ \ org.tuckey.web.filters.urlrewrite.UrlRewriteFilter, \ com.sysbliss.jira.plugins.workflow.servlet.JWDSendRedirectFilter, \ log4j.appender.soapaccesslog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.soapaccesslog.File=atlassian-jira-soap-access.log log4j.appender.soapaccesslog.MaxFileSize=20480KB log4j.appender.soapaccesslog.MaxBackupIndex=5 log4j.appender.soapaccesslog.layout=org.apache.log4j.PatternLayout log4j.appender.soapaccesslog.layout.ConversionPattern=%m%n log4j.appender.soapdumplog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.soapdumplog.File=atlassian-jira-soap-dump.log log4j.appender.soapdumplog.MaxFileSize=20480KB log4j.appender.soapdumplog.MaxBackupIndex=5 log4j.appender.soapdumplog.layout=org.apache.log4j.PatternLayout log4j.appender.soapdumplog.layout.ConversionPattern=%m%n log4j.appender.httpaccesslog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.httpaccesslog.File=atlassian-jira-http-access.log log4j.appender.httpaccesslog.MaxFileSize=20480KB log4j.appender.httpaccesslog.MaxBackupIndex=5 log4j.appender.httpaccesslog.layout=org.apache.log4j.PatternLayout log4j.appender.httpaccesslog.layout.ConversionPattern=%m%n log4j.appender.httpdumplog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.httpdumplog.File=atlassian-jira-http-dump.log log4j.appender.httpdumplog.MaxFileSize=20480KB log4j.appender.httpdumplog.MaxBackupIndex=5 log4j.appender.httpdumplog.layout=org.apache.log4j.PatternLayout log4j.appender.httpdumplog.layout.ConversionPattern=%m%n log4j.appender.sqllog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.sqllog.File=atlassian-jira-sql.log log4j.appender.sqllog.MaxFileSize=20480KB log4j.appender.sqllog.MaxBackupIndex=5 log4j.appender.sqllog.layout=org.apache.log4j.PatternLayout log4j.appender.sqllog.layout.ConversionPattern=%d %t %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.url} %m%n log4j.appender.slowquerylog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.slowquerylog.File=atlassian-jira-slow-queries.log log4j.appender.slowquerylog.MaxFileSize=20480KB log4j.appender.slowquerylog.MaxBackupIndex=5 log4j.appender.slowquerylog.layout=org.apache.log4j.PatternLayout log4j.appender.slowquerylog.layout.ConversionPattern=%d %t %p %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.url} [%c{4}] %m%n log4j.appender.xsrflog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.xsrflog.File=atlassian-jira-xsrf.log log4j.appender.xsrflog.MaxFileSize=20480KB log4j.appender.xsrflog.MaxBackupIndex=5 log4j.appender.xsrflog.layout=org.apache.log4j.PatternLayout log4j.appender.xsrflog.layout.ConversionPattern=%d %t %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.url} %m%n log4j.appender.securitylog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.securitylog.File=atlassian-jira-security.log log4j.appender.securitylog.MaxFileSize=20480KB log4j.appender.securitylog.MaxBackupIndex=5 log4j.appender.securitylog.layout=org.apache.log4j.PatternLayout log4j.appender.securitylog.layout.ConversionPattern=%d %t %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.ipaddr} %X{jira.request.url} %m%n log4j.appender.outgoingmaillog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.outgoingmaillog.File=atlassian-jira-outgoing-mail.log log4j.appender.outgoingmaillog.MaxFileSize=20480KB log4j.appender.outgoingmaillog.MaxBackupIndex=5 log4j.appender.outgoingmaillog.layout=org.apache.log4j.PatternLayout log4j.appender.outgoingmaillog.layout.ConversionPattern=%d %p [%X{jira.mailserver}] %t %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.ipaddr} %X{jira.request.url} %m%n log4j.appender.incomingmaillog=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.incomingmaillog.File=atlassian-jira-incoming-mail.log log4j.appender.incomingmaillog.MaxFileSize=20480KB log4j.appender.incomingmaillog.MaxBackupIndex=5 log4j.appender.incomingmaillog.layout=org.apache.log4j.PatternLayout log4j.appender.incomingmaillog.layout.ConversionPattern=%d %p [%X{jira.mailserver}] %t %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.ipaddr} %X{jira.request.url} %m%n log4j.appender.remoteappssecurity=com.atlassian.jira.logging.JiraHomeAppender log4j.appender.remoteappssecurity.File=atlassian-remoteapps-security.log log4j.appender.remoteappssecurity.MaxFileSize=20480KB log4j.appender.remoteappssecurity.MaxBackupIndex=5 log4j.appender.remoteappssecurity.layout=org.apache.log4j.PatternLayout log4j.appender.remoteappssecurity.layout.ConversionPattern=%d %t %p %X{jira.username} %X{jira.request.id} %X{jira.request.assession.id} %X{jira.request.ipaddr} %X{jira.request.url} [%c{4}] %m%n ##################################################### # Log Marking ##################################################### log4j.logger.com.atlassian.jira.util.log.LogMarker = INFO, console, filelog, soapaccesslog, soapdumplog, httpaccesslog, httpdumplog, sqllog, slowquerylog, xsrflog, securitylog, outgoingmaillog, incomingmaillog, remoteappssecurity log4j.additivity.com.atlassian.jira.util.log.LogMarker = false ##################################################### # Access logs ##################################################### log4j.logger.com.atlassian.jira.soap.axis.JiraAxisSoapLog = OFF, soapaccesslog log4j.additivity.com.atlassian.jira.soap.axis.JiraAxisSoapLog = false log4j.logger.com.atlassian.jira.soap.axis.JiraAxisSoapLogDump = OFF, soapdumplog log4j.additivity.com.atlassian.jira.soap.axis.JiraAxisSoapLogDump = false log4j.logger.com.atlassian.jira.web.filters.accesslog.AccessLogFilter = OFF, httpaccesslog log4j.additivity.com.atlassian.jira.web.filters.accesslog.AccessLogFilter = false log4j.logger.com.atlassian.jira.web.filters.accesslog.AccessLogFilterIncludeImages = OFF, httpaccesslog log4j.additivity.com.atlassian.jira.web.filters.accesslog.AccessLogFilterIncludeImages = false log4j.logger.com.atlassian.jira.web.filters.accesslog.AccessLogFilterDump = OFF, httpdumplog log4j.additivity.com.atlassian.jira.web.filters.accesslog.AccessLogFilterDump = false ##################################################### # SQL logs ##################################################### # # Beware of turning this log level on. At INFO level it will log every SQL statement # and at DEBUG level it will also log the calling stack trace. Turning this on will DEGRADE your # JIRA database throughput. # log4j.logger.com.atlassian.jira.ofbiz.LoggingSQLInterceptor = OFF, sqllog log4j.additivity.com.atlassian.jira.ofbiz.LoggingSQLInterceptor = false log4j.logger.com.atlassian.jira.security.xsrf.XsrfVulnerabilityDetectionSQLInterceptor = OFF, xsrflog log4j.additivity.com.atlassian.jira.security.xsrf.XsrfVulnerabilityDetectionSQLInterceptor = false ##################################################### # Security logs ##################################################### log4j.logger.com.atlassian.jira.login.security = INFO, securitylog log4j.additivity.com.atlassian.jira.login.security = false # # # The following log levels can be useful to set when login problems occur within JIRA # log4j.logger.com.atlassian.jira.login = WARN, securitylog log4j.additivity.com.atlassian.jira.login = false log4j.logger.com.atlassian.jira.web.session.currentusers = WARN, securitylog log4j.additivity.com.atlassian.jira.web.session.currentusers = false # # BEWARE - Turning on Seraph debug logs will result in many logs lines per web request. # log4j.logger.com.atlassian.seraph = WARN, securitylog log4j.additivity.com.atlassian.seraph = false # #--------------- ##################################################### # CLASS-SPECIFIC LOGGING LEVELS ##################################################### # This stuff you may wish to debug, but it produces a high volume of logs. # Uncomment only if you want to debug something particular log4j.logger.com.atlassian = WARN, console, filelog log4j.additivity.com.atlassian = false log4j.logger.com.atlassian.jira = INFO, console, filelog log4j.additivity.com.atlassian.jira = false log4j.logger.com.atlassian.plugin = INFO, console, filelog log4j.additivity.com.atlassian.plugin = false log4j.logger.atlassian.plugin = INFO, console, filelog log4j.additivity.atlassian.plugin = false log4j.logger.org.twdata.pkgscanner = WARN, console, filelog log4j.additivity.org.twdata.pkgscanner = false log4j.logger.com.atlassian.plugin.osgi.factory = WARN, console, filelog log4j.additivity.com.atlassian.plugin.osgi.factory = false log4j.logger.com.atlassian.plugin.osgi.container = WARN, console, filelog log4j.additivity.com.atlassian.plugin.osgi.container = false log4j.logger.org.apache.shindig = ERROR, console, filelog log4j.additivity.org.apache.shindig = false log4j.logger.com.atlassian.gadgets = WARN, console, filelog log4j.additivity.com.atlassian.gadgets = false log4j.logger.com.atlassian.jira.gadgets.system.MarketingGadgetSpecProvider = INFO, console, filelog log4j.additivity.com.atlassian.jira.gadgets.system.MarketingGadgetSpecProvider = false # The directory may produce errors of interest to admins when adding gadgets with features that aren't supported # (for example). log4j.logger.com.atlassian.gadgets.directory = INFO, console, filelog log4j.additivity.com.atlassian.gadgets.directory = false # Felix annoyingly dumps some pretty silly INFO level messages. So we have to set logging to WARN here. Means # we miss out on some useful startup logging. Should probably remove this if Felix ever fix this. log4j.logger.com.atlassian.plugin.osgi.container.felix.FelixOsgiContainerManager = WARN, console, filelog log4j.additivity.com.atlassian.plugin.osgi.container.felix.FelixOsgiContainerManager = false log4j.logger.com.atlassian.plugin.servlet = WARN, console, filelog log4j.additivity.com.atlassian.plugin.servlet = false log4j.logger.com.atlassian.plugin.classloader = WARN, console, filelog log4j.additivity.com.atlassian.plugin.classloader = false log4j.logger.com.atlassian.jira.util.system.JiraSystemRestarterImpl = INFO, console, filelog log4j.additivity.com.atlassian.jira.util.system.JiraSystemRestarterImpl = false log4j.logger.com.atlassian.jira.upgrade = INFO, console, filelog log4j.additivity.com.atlassian.jira.upgrade = false log4j.logger.com.atlassian.jira.startup = INFO, console, filelog log4j.additivity.com.atlassian.jira.startup = false log4j.logger.com.atlassian.jira.config.database = INFO, console, filelog log4j.additivity.com.atlassian.jira.config.database = false log4j.logger.com.atlassian.jira.web.action.util.LDAPConfigurer = INFO, console, filelog log4j.additivity.com.atlassian.jira.web.action.util.LDAPConfigurer = false log4j.logger.com.atlassian.jira.imports = INFO, console, filelog log4j.additivity.com.atlassian.jira.imports = false log4j.logger.com.atlassian.jira.plugin = INFO, console, filelog log4j.additivity.com.atlassian.jira.plugin = false log4j.logger.com.atlassian.jira.bc.dataimport = INFO, console, filelog log4j.additivity.com.atlassian.jira.bc.dataimport = false log4j.logger.com.atlassian.jira.security = INFO, console, filelog log4j.additivity.com.atlassian.jira.security = false log4j.logger.com.atlassian.jira.issue.index = INFO, console, filelog log4j.additivity.com.atlassian.jira.issue.index = false # DefaultIndexManager should run at INFO level, because we want to see messages when we force an optimise etc. log4j.logger.com.atlassian.jira.issue.index.DefaultIndexManager = INFO, console, filelog log4j.additivity.com.atlassian.jira.issue.index.DefaultIndexManager = false # Allow the optimise job to log at info level so that we can see the last time it ran log4j.logger.com.atlassian.jira.issue.index.job.OptimizeIndexJob = INFO, console, filelog log4j.additivity.com.atlassian.jira.issue.index.job.OptimizeIndexJob = false # Allow the Composite IndexLifecycleManager to log info log4j.logger.com.atlassian.jira.util.index = INFO, console, filelog log4j.additivity.com.atlassian.jira.util.index = false log4j.logger.com.atlassian.jira.project = INFO, console, filelog log4j.additivity.com.atlassian.jira.project = false log4j.logger.com.atlassian.jira.project.version = INFO, console, filelog log4j.additivity.com.atlassian.jira.project.version = false log4j.logger.com.atlassian.jira.user.job.RefreshActiveUserCountJob = INFO, console, filelog log4j.additivity.com.atlassian.jira.user.job.RefreshActiveUserCountJob = false log4j.logger.com.atlassian.jira.issue.search.providers = INFO, console, filelog log4j.additivity.com.atlassian.jira.issue.search.providers = false log4j.logger.com.atlassian.jira.issue.search.providers.LuceneSearchProvider_SLOW = INFO, slowquerylog log4j.additivity.com.atlassian.jira.issue.search.providers.LuceneSearchProvider_SLOW = false log4j.logger.com.atlassian.jira.action.admin = INFO, console, filelog log4j.additivity.com.atlassian.jira.action.admin = false log4j.logger.com.opensymphony = WARN, console, filelog log4j.additivity.com.opensymphony = false log4j.logger.com.atlassian.jira.user = INFO, console, filelog log4j.additivity.com.atlassian.jira.user = false log4j.logger.com.atlassian.jira.bc.user = INFO, console, filelog log4j.additivity.com.atlassian.jira.bc.user = false log4j.logger.com.atlassian.jira.workflow = INFO, console, filelog log4j.additivity.com.atlassian.jira.workflow = false log4j.logger.com.atlassian.jira.service = INFO, console, filelog log4j.additivity.com.atlassian.jira.service = false log4j.logger.com.atlassian.jira.service.services.DebugService = DEBUG, console, filelog log4j.additivity.com.atlassian.jira.service.services.DebugService = false log4j.logger.com.atlassian.jira.web.dispatcher.JiraWebworkActionDispatcher = WARN, nowarnconsole, filelog log4j.additivity.com.atlassian.jira.web.dispatcher.JiraWebworkActionDispatcher = false log4j.logger.webwork = WARN, console, filelog log4j.additivity.webwork = false log4j.logger.webwork.util.ServletValueStack = WARN, console, filelog log4j.logger.org.ofbiz.core.entity.jdbc.DatabaseUtil = INFO, nowarnconsole, filelog log4j.additivity.org.ofbiz.core.entity.jdbc.DatabaseUtil = false log4j.logger.org.ofbiz = WARN, console, filelog log4j.additivity.org.ofbiz = false log4j.logger.com.atlassian.jira.web.servlet.rpc = INFO, console, filelog log4j.additivity.com.atlassian.jira.web.servlet.rpc = false log4j.logger.com.atlassian.jira.soap = INFO, console, filelog log4j.additivity.com.atlassian.jira.soap = false log4j.logger.com.atlassian.jira.rpc = INFO, console, filelog log4j.additivity.com.atlassian.jira.rpc = false log4j.logger.com.atlassian.jira.plugin.ext.perforce = INFO, console, filelog log4j.additivity.com.atlassian.jira.plugin.ext.perforce = false log4j.logger.jelly = INFO, console, filelog log4j.additivity.jelly = false log4j.logger.logMessage.jsp = INFO, console, filelog log4j.additivity.logMessage.jsp = false log4j.logger.com.atlassian.jira.issue.views = INFO, console, filelog log4j.additivity.com.atlassian.jira.issue.views = false # Project Imports should be logged at INFO level so we can see the steps running. log4j.logger.com.atlassian.jira.imports.project = INFO, console, filelog log4j.additivity.com.atlassian.jira.imports.project = false log4j.logger.com.atlassian.jira.plugin.userformat.DefaultUserFormats = INFO, console, filelog log4j.additivity.com.atlassian.jira.plugin.userformat.DefaultUserFormats = false log4j.logger.com.atlassian.jira.scheduler.JiraSchedulerLauncher = INFO, console, filelog log4j.additivity.com.atlassian.jira.scheduler.JiraSchedulerLauncher = false log4j.logger.com.atlassian.sal.jira.scheduling = INFO, console, filelog log4j.additivity.com.atlassian.sal.jira.scheduling = false ##################################################### # Crowd Embedded ##################################################### # We want to get INFO level logs about Directory events log4j.logger.com.atlassian.crowd.directory = INFO, console, filelog log4j.additivity.com.atlassian.crowd.directory = false ##################################################### # REST ##################################################### # only show WARN for WADL generation doclet log4j.logger.com.atlassian.plugins.rest.doclet = WARN, console, filelog log4j.additivity.com.atlassian.plugins.rest.doclet = false # JRADEV-12012: suppress irrelevant warnings. log4j.logger.com.sun.jersey.spi.container.servlet.WebComponent = ERROR, console, filelog log4j.additivity.com.sun.jersey.spi.container.servlet.WebComponent = false ##################################################### # JQL ##################################################### log4j.logger.com.atlassian.jira.jql = INFO, console, filelog log4j.additivity.com.atlassian.jira.jql = false log4j.logger.com.atlassian.jira.jql.resolver = INFO, console, filelog log4j.additivity.com.atlassian.jira.jql.resolver = false ##################################################### # UAL ##################################################### log4j.logger.com.atlassian.applinks = WARN, console, filelog log4j.additivity.com.atlassian.applinks = false ##################################################### # ActiveObjects ##################################################### log4j.logger.net.java.ao = WARN, console, filelog log4j.additivity.net.java.ao = false log4j.logger.net.java.ao.sql = WARN, console, filelog log4j.additivity.net.java.ao.sql = false ##################################################### # Long Running Tasks ##################################################### log4j.logger.com.atlassian.jira.workflow.migration = INFO, console, filelog log4j.additivity.com.atlassian.jira.workflow.migration = false log4j.logger.com.atlassian.jira.web.action.admin.index.IndexAdminImpl = INFO, console, filelog log4j.additivity.com.atlassian.jira.web.action.admin.index.IndexAdminImpl = false ##################################################### # PROFILING ##################################################### log4j.logger.com.atlassian.util.profiling.filters = INFO, console, filelog log4j.additivity.com.atlassian.util.profiling.filters = false log4j.logger.com.atlassian.util.profiling = DEBUG, console, filelog log4j.additivity.com.atlassian.util.profiling = false log4j.logger.com.atlassian.jira.web.filters.ThreadLocalQueryProfiler = DEBUG, console, filelog log4j.additivity.com.atlassian.jira.web.filters.ThreadLocalQueryProfiler = false # # By default we ignore some usually harmless exception such as Client Abort Exceptions. However # if this proves problematic then we can turn this to DEBUG log on. # log4j.logger.com.atlassian.jira.web.exception.WebExceptionChecker = OFF, console, filelog log4j.additivity.com.atlassian.jira.web.exception.WebExceptionChecker = false # # Errors in the logs occur at this logger if the user cancels a form upload. The actual exception # is rethrown and dealt with elsewhere so there is no need to keep these logs around. # log4j.logger.webwork.multipart.MultiPartRequestWrapper = OFF, console, filelog log4j.additivity.webwork.multipart.MultiPartRequestWrapper = false log4j.logger.com.atlassian.jira.plugins.monitor = INFO, console, filelog log4j.additivity.com.atlassian.jira.plugins.monitor = false ##################################################### # Mails ##################################################### # # outgoing mail log includes also some logging information from classes which handle both incoming and outgoing mails # that's why the appender is configured at com.atlassian.mail level (not com.atlassian.mail.outgoing) # log4j.logger.com.atlassian.mail = INFO, console, outgoingmaillog log4j.additivity.com.atlassian.mail = false log4j.logger.com.atlassian.mail.incoming = INFO, console, incomingmaillog log4j.additivity.com.atlassian.mail.incoming = false # changes in mail settings need to be logged log4j.logger.com.atlassian.jira.mail.settings.MailSetting = INFO, console, filelog log4j.additivity.com.atlassian.jira.mail.settings.MailSetting = false # # Need to ensure that the actual discovery of duplicates is logged # log4j.logger.com.atlassian.jira.upgrade.tasks.UpgradeTask_Build663 = INFO, console, filelog log4j.additivity.com.atlassian.jira.upgrade.tasks.UpgradeTask_Build663 = false # JRADEV-19240: Suppress useless warnings (will be fixed in atlassian-soy-templates-2.0.0, see SOY-18) log4j.logger.com.atlassian.soy.impl.GetTextFunction = ERROR, console, filelog log4j.additivity.com.atlassian.soy.impl.GetTextFunction = false # JRADEV-19613: Remote should log security messages to a separate log file log4j.logger.com.atlassian.plugin.remotable.plugin.module.oauth.OAuth2LOAuthenticator = INFO, console, remoteappssecurity log4j.additivity.com.atlassian.plugin.remotable.plugin.module.oauth.OAuth2LOAuthenticator = false log4j.logger.com.atlassian.plugin.remotable.plugin.module.permission.ApiScopingFilter = INFO, console, remoteappssecurity log4j.additivity.com.atlassian.plugin.remotable.plugin.module.permission.ApiScopingFilter = false log4j.logger.com.atlassian.plugin.remotable.plugin.OAuthLinkManager = INFO, console, remoteappssecurity log4j.additivity.com.atlassian.plugin.remotable.plugin.OAuthLinkManager = false log4j.logger.com.atlassian.plugin.remotable.plugin.util.http.CachingHttpContentRetriever = INFO, console, remoteappssecurity log4j.additivity.com.atlassian.plugin.remotable.plugin.util.http.CachingHttpContentRetriever = false log4j.logger.com.atlassian.plugin.remotable.plugin.service.LocalSignedRequestHandler = INFO, console, remoteappssecurity log4j.additivity.com.atlassian.plugin.remotable.plugin.service.LocalSignedRequestHandler = false log4j.logger.com.atlassian.plugin.remotable.host.common.service.http.bigpipe.DefaultBigPipeManager = INFO, console, remoteappssecurity log4j.additivity.com.atlassian.plugin.remotable.host.common.service.http.bigpipe.DefaultBigPipeManager = false log4j.logger.com.example.tutorial.plugins = DEBUG, console, filelog log4j.additivity.com.example.tutorial.plugins = false

   The key lines are the last two. This is the preferred approach.

7. Save changed files.

Step 4. Test the app

Now you’re ready to test the app.

1. Configure SDK to run Jira Software.
2. Open a Terminal and navigate to the project root directory where the pom.xml file is located.

3. Run the following SDK command:

   1

   atlas-run

   This builds your app code, starts a Jira instance, and installs your app. This could take a few minutes.

4. Go to Jira home page in a browser (the URL is indicated in the Terminal output).

5. Create a new project based on the Software Development project type. This gives us the workflow we need to test each event type, that is, one that includes transitions for resolving and closing issues.  

6. While keeping an eye on the Terminal where you started Jira, create an issue, and then resolve it. You should see an event logged to the Terminal output, like this:

   1 2

   [INFO] [talledLocalContainer] 2013-07-24 12:52:42,347 http-2990-3 INFO admin 772x1164x1 slv00c 127.0.1.1 /secure/QuickCreateIssue.jspa [example.tutorial.plugins.IssueCreatedResolvedListener] Issue TST-1 has been created at 2013-07-24 12:52:42.105. [INFO] [talledLocalContainer] 2013-07-24 17:11:42,562 http-2990-8 INFO admin 1031x1858x1 slv00c 127.0.1.1 /secure/CommentAssignIssue.jspa [example.tutorial.plugins.IssueCreatedResolvedListener] Issue TST-1 has been resolved at 2013-07-24 17:11:42.512.

It works! However, the app is not yet ready for prime time. We have a little more to do to make sure that our event listener plays well given the normal app life cycle in a production deployment, as described next. You can keep Jira running while you continue your work. 

Step 5. Mind the app life cycle

The code so far makes two assumptions about the app life cycle:

1. The constructor will only ever be called once.
2. The app will only shut down when the system itself shuts down.

Neither is true. Developers should expect their apps to be enabled or disabled at any time. Since our app registers with an external service, this needs to be taken into account.

As a @Component, IssueCreatedResolvedListener will become a Spring bean, so we can apply the Spring interfaces InitializingBean and DisposableBean. Spring guarantees that the bean – in this case, our listener class – will have a chance to get its act together before it’s put into active service, or retired from it.

1. To coordinate our sample event listener with the app life cycle, replace the IssueCreatedResolvedListener.java contents with the following:

   1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62

   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 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; @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)) { 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()); } } }

   Here, we’ve moved the EventPublisher reference to a member variable and bound the registration to the afterPropertiesSet() and destroy() methods, which come from InitializingBean and DisposableBean respectively. This guarantees the correct behavior even when our app is disabled and later re-enabled, perhaps by an administrator using the Universal app manager.

2. Install the app using atlas-package command that triggers QuickReload.

Next Steps

Although writing a listener as explained here has the advantage of working inside a fully-fledged app, it doesn’t support the properties feature of legacy (pre-4.0) Jira listeners. In those listeners, administrators could set properties to configure a listener. For example, a listener that forwarded issue events to IRC might have properties for the IRC server, username and password to use. Atlassian event listeners don’t automatically integrate with the Jira listener configuration screen.

To make your listener configurable by a Jira administrator, implement your own administration page that can configure not only your listener but any other information your users might need to input. For guidance on how to do this, see Writing an Admin Configuration Screen.