The document outlines the process of creating server add-ons for Atlassian products like Confluence and Jira using the Atlassian Plugin Framework 2. It covers the advantages and disadvantages of building for server, the required tools, and how to generate and test plugins using the Atlassian SDK and Spring Scanner. Additionally, it highlights the differences between REST APIs and Java APIs for developing add-ons, along with available resources for developers.

1. Creating your own server add-on
to customise Confluence or JIRA
MEL PAISLEY | DEVELOPER SUPPORT | ATLASSIAN | @MELISSAJPAISLEY

2. I wish Confluence or JIRA
would do ….
MELISSA PAISLEY

3. The Atlassian P2 ecosystem lets you do this

4. What is P2?
The Atlassian Plugin Framework 2 is a
set of components for the Atlassian
Platform that allows you to build
plugins that extend the functionality
of Atlassian Server applications.

5. Building for Server - the Good
Customers
Server products have a large
established customer base.
Access
Atlassian JAVA API’s give
much less restricted access
to JIRA / Confluence.

6. Building for Server - the Bad
Environment(s)
There are multiple
supported platforms for
JIRA and Confluence server.
Access
Having all this extra access
can be a problem.

7. Agenda
Technologies
APIs
Demo

8. Technologies
What makes a Confluence or JIRA server add-on?

9. What is a server add-on?
An Atlassian server add-on is an OSGi
bundle JAR with some extras.

10. Tomcat web Apps
Confluence and JIRA server
are tomcat web applications
How do server add-ons work?
Felix OSGi container
Within the web application is
a Felix OSGi container
OSGi Bundle
The plugin JAR is a specially
modified OSGi bundle

11. Sayoko Shimoyama, CC2.0 flickr.com

12. The Atlassian SDK
Along with AMPS the Atlassian SDK
will help you generate a plugin
skeleton and get JIRA or Confluence
running to test it.
Know your
tools
Atlassian SDK
Spring Scanner
Quickreload

13. Creating your Plugin
atlas-create-jira-plugin
Create a jira plugin skeleton
atlas-create-jira-plugin-module
Add a plugin module to an existing jira plugin

14. Testing your plugin in product
atlas-run
Run from plugin source directory
atlas-run-standalone
Does not need a plugin to run

15. Packaging your plugin
atlas-mvn package
compile and package your code

16. Build your Plugin
Generate a plugin skeleton
for JIRA or Confluence
Test your Plugin
Start a temporary JIRA or
Confluence instance with
your plugin installed
The Plugin SDK lets you

17. Spring Scanner
Spring Scanner works with AMPS to
make plugins faster to load and easier
to easier to develop.
https
Know your
tools
Atlassian SDK
Spring Scanner
Quickreload

18. Plugin Transformation with Spring Scanner
Scanning
The source code
is scanned for
special
annotations
Storage
The information
from the
annotations is
stored in a set of
index files
Runtime
At runtime the
index files are
read and
interpreted
accordingly

19. Quickreload
Scans for changes to plugin jar files
and automatically reloads when it
detects a change.
Know your
tools
Atlassian SDK
Spring Scanner
Quickreload

20. Agenda
Technologies
APIs
Demo

21. APIs
Rest and Java APIs for building Add-ons

22. Remote Access Point
Product REST APIs provide an access point for
developing remote applications
Change Tolerant
Product REST APIs provide better change-
tolerance than JAVA APIs
JIRA and
Confluence
REST APIs

23. Remote Access Point
Product REST APIs provide an access point for
developing remote applications
Change Tolerant
Product REST APIs provide better change-
tolerance than JAVA APIs
JIRA and
Confluence
REST APIs

24. RESOURCES
API Browser
The REST API browser is
available within your JIRA and
Confluence development
environments.
API Doc
The REST API is also
documented at
docs.atlassian.com.

25. RESOURCES
API Browser
The REST API browser is
available within your JIRA and
Confluence development
environments.
API Doc
The REST API is also
documented at
docs.atlassian.com.

26. Mutable
Parts of the Java API may change even in bug-
fix releases. In addition, the Java API does not
always have in-depth documentation as certain
features may not be considered public.
Powerful
The Java API provides fast response times,
allows you to access more than is available in
the REST APIs
JIRA and
Confluence
Java APIs

27. With great power comes
great responsibility.
BEN PARKER, SPIDERMAN

28. Mutable
Parts of the Java API may change even in bug-
fix releases. In addition, the Java API does not
always have in-depth documentation as certain
features may not be considered public.
Powerful
The Java API provides fast response times, and
allows you access to almost everything.
JIRA and
Confluence
Java APIs

29. RESOURCES
Java Doc
The Java Documentation is
available for both Confluence
and JIRA
docs.atlassian.com

30. Developer Docs
https://
developer.atlassian.com
Community Forums
https://
developer.atlassian.com/
community
More Learning Resources

31. Agenda
Technologies
APIs
Demo

32. Demo
http://go.atlassian.com/holabarcelona

33. Part 1
Generating the Plugin skeleton using the Atlassian SDK

38. Part 2
Adding a REST resource

42. Part 3
Use the REST point by displaying it in the UI

49. Agenda
Technologies
APIs
Demo

50. Agenda
Technologies
APIs
Demo

51. Agenda
Technologies
APIs
Demo

52. Thank you!
MELISSA PAISLEY | DEVELOPER SUPPORT | ATLASSIAN | @MELISSAJPAISLEY