com.atlassian.connect.spring.package-info Maven / Gradle / Ivy
/**
* Provides classes for building Atlassian Connect add-ons using
* Spring Boot and
* atlassian-connect-spring-boot.
*
* To use the Spring Boot starter for Atlassian Connect in your application, include the following dependency in
* your Maven POM:
*
<dependency>
* <groupId>com.atlassian.connect</groupId>
* <artifactId>atlassian-connect-spring-boot-starter</artifactId>
* <version>${atlassian-connect-spring-boot.version}</version>
* </dependency>
*
* Add-on Descriptor
*
* To enable the functionality provided by this Spring Boot starter, an Atlassian Connect add-on descriptor,
* atlassian-connect.json must be present at the root of the class path.
*
*
Add-on Lifecycle
*
* The Spring Data repository
* {@link com.atlassian.connect.spring.AtlassianHostRepository} stores information about Atlassian hosts in which the
* add-on is or has been installed. A component implementing this interface is required for your application to start.
*
*
Upon successful completion of add-on installation or uninstallation,
* A Spring application event
* will be fired: {@link com.atlassian.connect.spring.AddonInstalledEvent} or
* {@link com.atlassian.connect.spring.AddonUninstalledEvent}.
*
*
Authentication of Incoming Requests
*
* During processing of a request from an Atlassian host, the details of the host and of the user at the browser can be
* obtained from the {@link com.atlassian.connect.spring.AtlassianHostUser}.
*
*
By default, all Spring Web MVC
* controllers require authentication by a JSON Web Token issued by an Atlassian host with the add-on installed.
* The {@link com.atlassian.connect.spring.IgnoreJwt} annotation can be used to bypass that requirement.
*
*
Authentication of Outgoing Requests
*
* {@link com.atlassian.connect.spring.AtlassianHostRestClients} provides {@code RestTemplate}s for making authenticated
* requests to Atlassian hosts as the add-on or as a user.
*
* @see Atlassian Developers
* @since 1.0.0
*/
package com.atlassian.connect.spring;