Connecting Connect with Spring Boot

VINCENT KOK • DEVELOPMENT MANAGER • ATLASSIAN • @VINCENTKOK
Connecting Connect
with Spring Boot

Atlassian Supported
Community Frameworks

go.atlassian.com/connectframeworks

STARTERS
SPRING BOOT
CONNECT STARTER
INCEPTION
Agenda
SPRING BOOT

http://geek-and-poke.com/geekandpoke/2014/1/2/games-for-the-real-geeks-part-2

A “vanilla” Spring web app

1. Dependencies
Setup the right Maven dependencies

1. Dependencies
web.xml
Setup your web.xml

1. Dependencies
application-context.xml
Enable component scanning and mvc
annotation driven
web.xml
Setup your web.xml

1. Dependencies
4. The actual controller
What you actually care about
annotation driven
web.xml
Setup your web.xml

5. Install Tomcat
And conﬁgure it as well
1. Dependencies
annotation driven
web.xml
Setup your web.xml

5. Install Tomcat
And conﬁgure it as well
6. It might work
You probably made a typo

1. Dependencies
annotation driven
web.xml
Setup your web.xml

• Big cool statistic
• 2,56
9
• Add-Ons in Marketplace
Repeatable pattern
https://ﬂic.kr/p/8ykpkW

Spring Boot
Repeatable patterns for services
Fast Opinionated Auto Configured No code generation

Example: Hello world
e
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.atlassian.connect.lighthing</groupId>
<artifactId>lightingdemo</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.3.1.RELEASE</version>
</parent>
<dependencies>
<dependency>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>

e
<parent>
</parent>
<dependencies>
<dependency>
</dependency>
<dependency>
<parent>
</parent>

e
<parent>
</parent>
<dependencies>
<dependency>
</dependency>
<dependency>
<dependency>
</dependency>

e
package hello;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.context.ApplicationContext;
@SpringBootApplication
public class HelloApplication {
public static void main(String[] args) {
SpringApplication.run(HelloApplication.class, args);
}
}

e
package hello;
}
}

e
package hello;
}
}
}

e
package hello;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.bind.annotation.RequestMapping;
@RestController
public class HelloController {
@RequestMapping("/")
public String index() {
return "Greetings from Spring Boot!";
}
}

e
package hello;
@RestController
}
}
@RestController

e
package hello;
@RestController
}
}
}

e
$> mvn spring-boot:run

e
$> curl http://localhost:8080/
Greetings from Spring Boot!

Provides production ready
features
Think health checks, metrics, security
and externalised configuration

STARTERS
SPRING BOOT
CONNECT STARTER
INCEPTION
Agenda
STARTERS

Spring Boot Starters
Building blocks Out of the box Build your own
Building blocks for your service

Example: Consume a starter
e
<dependencies>
<dependency>
</dependency>
<dependency>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<dependencies>

e
<dependencies>
<dependency>
</dependency>
<dependency>
</dependency>
<dependencies>
<dependency>
</dependency>

e

e
$> curl http://localhost:8080/health
{”status”:”UP”}

Available Starters
Out of the box
63*
* as counted by myself at midnight

STARTERS
SPRING BOOT
CONNECT STARTER
INCEPTION
Agenda
CONNECT STARTER

Three things every add-on requires
Lifecycle Descriptor JWT

Connecting Connect with Spring Boot

1: /atlassian-connect.json
2: Descriptor JSON

2: Descriptor JSON
3: /install

2: Descriptor JSON
3: /install
4. Store tenant data

2: Descriptor JSON
3: /install
5: Install OK / not OK
4. Store tenant data

Descriptor
e
{
"name": "Inception",
"description": “A page in a page",
"key": “com.atlassian.connect.atlascamp.inception”,
"baseUrl": “http://localhost:8080”,
"vendor": {
"name": "Atlassian",
"url": "http://www.atlassian.com"
},
"authentication": {
"type": "jwt"
},
"lifecycle": {
"installed": "/installed",
"uninstalled": "/uninstalled",
"enabled": "/enabled",
"disabled": "/disabled"
},
"apiVersion": 1,
"scopes": [
"read"
],
"modules": {
}
}

Descriptor
e
{
"vendor": {
},
"authentication": {
"type": "jwt"
},
"lifecycle": {
},
"apiVersion": 1,
"scopes": [
"read"
],
"modules": {
}
}
"vendor": {
},

Descriptor
e
{
"vendor": {
},
"authentication": {
"type": "jwt"
},
"lifecycle": {
},
"apiVersion": 1,
"scopes": [
"read"
],
"modules": {
}
}
"lifecycle": {
}

Descriptor
e
{
"vendor": {
},
"authentication": {
"type": "jwt"
},
"lifecycle": {
},
"apiVersion": 1,
"scopes": [
"read"
],
"modules": {
}
}
"modules": {
}

Lifecycle
e
{
"clientKey": "Confluence:5358671948",
"publicKey": "MIGf....ZRWzwIDAQAB",
"sharedSecret": "fda9e230-ba1b-4e8d-a76e-c9e4e6c28ea8",
"serverVersion": "6437",
"pluginsVersion": "1.1.81",
"baseUrl": “http://vincentkok.atlassian.net",
"productType": "confluence",
"description": "Atlassian Confluene at https://example.atlassian.net",
"eventType": "INSTALLED"
}

Lifecycle
e
{
}

Lifecycle
e
{
} “eventType": "INSTALLED",

JWT
e
<base64url-encoded header>.
<base64url-encoded claims>.
<base64url-encoded signature>

JWT
e
eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJleHAiOjEzODY4
OTkxMzEsImlzcyI6ImppcmE6MTU0ODk1OTUiLCJxc2giOiI4MDYzZ
mY0Y2ExZTQxZGY3YmM5MGM4YWI2ZDBmNjIwN2Q0OTFjZjZkYWQ3Yz
Y2ZWE3OTdiNDYxNGI3MTkyMmU5IiwiaWF0IjoxMzg2ODk4OTUxfQ.
uKqU9dTB6gKwG6jQCuXYAiMNdfNRw98Hw_IWuA5MaMo

JWT
e
{
"typ":"JWT",
"alg":"HS256"
}
{
"iss": "confluence:1314039",
"iat": 1300819370,
"exp": 1300819380,
"qsh": "8063ff4ca1e41df7bc90c8ab6d0f6207d491cf6dad7c66ea797b4614b71922e9",
"sub": "alana",
"context": {
"user": {
"userKey": "alana",
"username": "aaware",
"displayName": "Bruce Wayne"
}
}
}

JWT
e
{
"typ":"JWT",
"alg":"HS256"
}
{
"iat": 1300819370,
"exp": 1300819380,
"sub": "alana",
"context": {
"user": {
"userKey": "alana",
}
}
}
{
"typ":"JWT",
"alg":"HS256"
}

JWT
e
{
"typ":"JWT",
"alg":"HS256"
}
{
"iat": 1300819370,
"exp": 1300819380,
"sub": "alana",
"context": {
"user": {
"userKey": "alana",
}
}
}
"iat": 1300819370,
"exp": 1300819380,
"qsh": “8063ff4…2e9”,
"sub": "alana",

Authenticated requests
e
/inception-macro?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJl…

Authenticated requests
e"Authorization" : "JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJl..."
/inception-macro?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJl…

• 2,56
9
DRY
https://ﬂic.kr/p/qkUpu

Atlassian Supported
Community Frameworks
BETA

http://go.atlassian.com/ac-springboot

STARTERS
SPRING BOOT
CONNECT STARTER
IN UNDER 3 MINUTES
Agenda
INCEPTION

• 2,56
9
Let’s build a Connect add-on
from scratch
https://ﬂic.kr/p/rtmnT2

• 2,56
9
A page in a page
https://ﬂic.kr/p/216z4i

1: inception-macro?pageId=5&jwt=eyJhbGciOiJIUz

2:/rest/api/content/5?expand=body.export_view

3: Page content as JSON

3: Page content as JSON
4: Rendered macro HTML

Create a project
e
$> mvn archetype:generate -DgroupId=com.atlassian.labs.atlascamp
-DartifactId=inception -DarchetypeArtifactId=maven-archetype-
quickstart -DinteractiveMode=false

Create a project
e
$ ls inception
pom.xml 
src

Add dependencies
e
http://maven.apache.org/maven-v4_0_0.xsd">
<groupId>com.atlassian.labs.atlascamp</groupId>
<artifactId>inception</artifactId>
<packaging>jar</packaging>
<parent>
</parent>
<dependencies>
<dependency>
</dependency>
</dependencies>
</project>

Add dependencies
e
<parent>
</parent>
<dependencies>
<dependency>
</dependency>
</dependencies>
</project>
<parent>
</parent>

Add dependencies
e
<parent>
</parent>
<dependencies>
<dependency>
</dependency>
</dependencies>
</project>
<dependencies>
<dependency>
</dependency>
<dependency>
<groupId>com.atlassian.connect</groupId>
<artifactId>atlassian—spring-boot-starter</artifactId>
<version>1.0.0-beta-1</version>
</dependency>
</dependencies>

Create the application
e
package com.atlassian.connect.atlascamp;
public class InceptionApplication {
public static void main( String[] args ) {
SpringApplication.run(InceptionApplication.class, args);
}
}

e
}
}

e
}
}
}

Descriptor
e
$> touch src/main/resources/atlassian-connect.json

Descriptor
e
{
"vendor": {
},
"authentication": {
"type": "jwt"
},
"lifecycle": {
},
"apiVersion": 1,
"scopes": [
"read"
],
"modules": {
}
}
"baseUrl": “https://1c12a2cd.ngrok.io”,
"vendor": {
},

Descriptor
e
"modules": {
"dynamicContentMacros": [ {
"url": "/inception-macro?pageId={page.id}",
"description": {
"value": "A page in a page"
},
"name": {
"value": "Inception"
},
"categories": [
"visuals"
],
"outputType": "block",
"bodyType": "none",
"aliases": [
"inception"
],
"featured": true,
"parameters": [],
"key": "inception-macro"
}
]
}

Descriptor
e
"modules": {
"description": {
},
"name": {
"value": "Inception"
},
"categories": [
"visuals"
],
"outputType": "block",
"bodyType": "none",
"aliases": [
"inception"
],
"featured": true,
"parameters": [],
"key": "inception-macro"
}
]
}
"description": {
},

Tenant storage
e
HHH000227: Running hbm2ddl schema export

Tenant storage
e
spring.jpa.database=POSTGRESQL
spring.jpa.hibernate.ddl-auto=none
spring.datasource.url=jdbc:postgresql://localhost:5432/springbootdb

Macro template
e
<dependencies>
<dependency>
</dependency>
<dependency>
<artifactId>atlassian-connect-spring-boot-starter</artifactId>
</dependency>
<dependency>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
</dependencies>

Macro template
e
<dependencies>
<dependency>
</dependency>
<dependency>
<artifactId>atlassian-connect-spring-boot-starter</artifactId>
</dependency>
<dependency>
</dependency>
</dependencies>
<dependency>
</dependency>

Macro template
e
$> touch src/main/resources/templates/inception-macro.html

Macro template
e
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
<link rel="stylesheet" href="//aui-cdn.atlassian.com/aui.min.css" media="all"/>
<script th:src=“${js-all-url}” type="text/javascript"></script>
</head>
<body>
<section id="content" class="ac-content">
<p th:utext="${body}"/>
</section>
</body>
</html>

Macro template
e
<!DOCTYPE html>
<head>
</head>
<body>
</section>
</body>
</html>

Macro template
e
<!DOCTYPE html>
<head>
</head>
<body>
</section>
</body>
</html>
</section>

Controller
e
@Controller
public class InceptionController {
private static final String PAGE_URL = "%s/rest/api/content/%s?expand=body.export_view";
private static final String JS_URL = "%s/atlassian-connect/all.js";
@Autowired
private RestTemplate restTemplate;
@RequestMapping(value = "/inception-macro")
public String render(@RequestParam long pageId,
@AuthenticationPrincipal AtlassianHostUser hostUser, Model model) {
final String baseURL = hostUser.getHost().getBaseUrl();
final String contentUrl = String.format(PAGE_URL, baseURL, pageId);
final String pageContent = restTemplate.getForObject(contentUrl, String.class);
final String pageBody = extractPageBody(pageContent);
model.addAttribute("body", pageBody);
model.addAttribute("jsurl", String.format(JS_URL, baseURL));
return "inception-macro";
}

Controller
e
@Controller
@Autowired
}
@Controller

Controller
e
@Controller
@Autowired
}
private static final String PAGE_URL
private static final String JS_URL

Controller
e
@Controller
@Autowired
}
@Autowired

Controller
e
@Controller
@Autowired
}

Secure
e

Secure
e
$> curl http://localhost:8080/inception-macro
401

Install
e
$> npm install -g ngrok
$> ngrok http 8080
Forwarding https://1c12a2cd.ngrok.io -> localhost:8080

Install
$> curl http://localhost:8080/inception-macro
401

Executed requests
e
HTTP Requests
-------------
GET /inception-macro 200 OK
POST /installed 204 No Content
GET /atlassian-connect.json 200 OK

http://go.atlassian.com/inception

Connecting Atlassian Connect with Spring Boot
Why again?
Leverage skills Fast DRY Care free Connect

VINCENT KOK • DEVELOPMENT MANAGER • ATLASSIAN • @VINCENTKOK
Thank you!

Connecting Connect with Spring Boot

Recommended

More Related Content

What's hot (20)

Similar to Connecting Connect with Spring Boot (20)

More from Vincent Kok (14)

Recently uploaded (20)

Connecting Connect with Spring Boot