Quick Setup of Metadata API (v 3.0)

Owned by Almuth Boehme [Communardo]
Last updated: Nov 16, 2017 by Sandro Herrmann (Deactivated)
1 min read

If you have already written your own plugin, follow steps 1 to 4 to set up your local repository in such a way that you'll be able to write your backend integration with Metadata.

Alternatively, if you have not written your own plugin yet, perform steps 1 and 2 and move to the step Quick Start at the bottom to start with an example.

1. Download the following files

2. Add the files to your Maven repository

There are two possibilities to install the library files. Either install them in a local Maven repository or deploy them to a hosted Maven repository.

Install in the local Maven repository

mvn install:install-file -Dfile=metadata-api-2.3.jar -DgroupId=de.communardo.confluence.plugins -DartifactId=metadata-api -Dversion=2.3 -Dpackaging=jar -Djavadoc=metadata-api-2.3-javadoc.jar

Deploy to a hosted Maven repository

mvn deploy:deploy-file -Dfile=metadata-api-2.3.jar -DgroupId=de.communardo.confluence.plugins -DartifactId=metadata-api -Dversion=2.3 -Dpackaging=jar -Djavadoc=metadata-api-2.3-javadoc.jar -DrepositoryId=<id-to-map-on-server-section-of-settings.xml> -Durl=<url-of-the-repository-to-deploy>

3. Include the Metadata API in your Add-On pom.xml

<dependency>
	<groupId>de.communardo.confluence.plugins</groupId>
    <artifactId>metadata-api</artifactId>
    <version>2.3</version>
    <scope>provided</scope>
</dependency>

4. Import metadata components to your atlassian-plugin.xml

<component-import key="metadataManager" interface="com.communardo.confluence.metadata.service.MetadataManager" />

5. Make sure the Metadata for Confluence Add-on is already installed on your Confluence system.

 

Quick start: You can also use the attached example integration add-on code to have a quick start

Example Integration App (v 3.0)

All Versions