Server listener set-up

This page explains how to set up the communication between your server app and the App migration platform.

Registering your server app for migration will allow you to:

Enable app migration in your server app
Get notified by the App migration platform when core data migration is complete, and app data migration starts. This will allow you to access/read mappings related to core product data (you can access the same mappings by making a request from your cloud site).
Upload your app-related data to Atlassian's secure cloud storage

Use the App cloud migration library

The App cloud migration library is an interface component that allows developers to create migration listeners on their server apps. Only one listener should be registered per server app key, however multiple server apps can send data to a single cloud app. The Cloud Migration Assistants (CCMA/JCMA) export the library's classes in the runtime. The library has no external dependencies, which avoids conflicts with the tech stack that your app uses.

Make sure to always use the latest version available.

1
2
<dependency>
  <groupId>com.atlassian</groupId>
  <artifactId>atlassian-app-cloud-migration-listener</artifactId>
  <version>1.2.1</version>
</dependency>

See an example of how to use the atlassian-app-cloud-migration-listener dependency.

See some examples.

A version catalogue and information about their end-of-life policy can be found on the library version page.

Implement the interface

You will need to implement a listener interface. Depending on the library you are using this can be DiscoverableListener, AppCloudMigrationListenerV1 or CloudMigrationListenerV1. The methods to be implemented are:

Method	Description
`onStartAppMigration`	Core product migration is complete. Server app can begin migration at this point.
`getCloudAppKey`	The cloud app key for where the migration is being exported to.
`getServerAppKey`	The server app key for where the migration is being exported from. When using atlassian-app-cloud-migration-listener this is not required if your app key is the same as your OSGi bundle name.
`getDataAccessScopes`	The data access scopes required to access the migration mappings.

See an example

1
2
@Override
public void onStartAppMigration(String transferId, MigrationDetailsV1 migrationDetails) {
    PaginatedMapping paginatedMapping = gateway.getPaginatedMapping(transferId, "confluence:page", 5);
    while (paginatedMapping.next()) {
        try {
            Map<String, String> mappings = paginatedMapping.getMapping();
            log.info("mappings = {}", new ObjectMapper().writeValueAsString(mappings));
        } catch (IOException e) {
            log.error("Error retrieving migration mappings", e);
        }
    }
}

@Override
public String getCloudAppKey() {
    return "my-cloud-app-key";
}

@Override
public String getServerAppKey() {
    return "my-server-app-key";
}

@Override
public Set<AccessScope> getDataAccessScopes() {
    return Stream.of(
            APP_DATA_OTHER, PRODUCT_DATA_OTHER, MIGRATION_TRACING_IDENTITY, MIGRATION_TRACING_PRODUCT
    ).collect(Collectors.toCollection(HashSet::new));
}

Test the server app implementation in your local environment

You can test your implementation and changes locally through these steps:

Add the dependency to use the App cloud migration library
Install and run the Jira or Confluence Cloud Migration Assistant (JCMA/CCMA)
Have the latest plugin of your server app available with the listener