Preparing for Confluence 5.5
This documentation is intended for Confluence developers who want to ensure that their existing plugins and add-ons are compatible with Confluence 5.5, and to learn about the new features for developing add-ons in Confluence 5.5.
This page will be updated as further EAP development releases are available.
What's changing in Confluence 5.5?
Confluence is now using AUI 5.3.4. See the AUI release notes for information on what's new in AUI 5.3.
New REST API
We are in the process of developing a new REST API for Confluence. Our existing APIs will be deprecated over time, as equivalent resources become available in the REST API. We recommend plugin developers use the REST API where possible.
See Confluence API for more details.
Updates to the atlassian-cache API
The Confluence caching infrastructure has been updated to use the Atlassian Cache version 2 API. This API is backwards compatible with the previous version (0.1) of the Atlassian Cache used by Confluence.
Plugin developers can create a cache specifically configured to their plugin requirements. See How do I cache data in a plugin?
Changes to source distribution
Confluence's source distribution includes the source of the internal Atlassian projects that Confluence depends on (such as
atlassian-core). From this release onwards, these internal Atlassian dependencies are now Maven-based archives, rather than exports of the source repository for each dependency. There will be a Maven-based archive for each dependency, named <dependencyname-version>-sources.jar. Please note the following:
- The only buildable part of the source package is Confluence itself, not its dependencies.
- A more complete source distribution has been provided as existing exclusions will be removed.
- If you have customised an internal Atlassian dependency, you may not be able to apply that customisation to the dependency anymore. If you have done this, try Atlassian Answers for an alternative solution.
- If you have customised a third-party library that has a dependency from Confluence source, you can still change the dependency in Confluence source. However, if the library has a dependency on an internal Atlassian dependency, you won't be able to change the library. If you have done this, try Atlassian Answers for an alternative solution.
Note about ongoing clustering work
We are working to improve our clustering solution and expect to make it available later this year. Confluence 5.5 will not include a clustered artifact, and customers wishing to set up a cluster in production will need to continue to use Confluence 5.4. A developer milestone (Confluence 5.5-m22) of our work so far is available to developers who want start working to ensure their add-on is cluster compatible. See How do I ensure my plugin works properly in a cluster?.
See Confluence 5.5-m22 EAP Release Notes for more details of changes to clustered Confluence including:
- Changes to the home directory - In a clustered environment Confluence will have a local home and a shared home. Plugins will need to decide the most appropriate place to store any data they place on the file system.
- Introduction of Hazelcast - data will be evenly partitioned across all the nodes in a cluster, instead of being fully replicated on each node.
Milestone releases for developers
Please watch the Development Releases page for pre-release versions of Confluence 5.5 that you can use for testing purposes.
If you have any questions about preparing for Confluence 5.5, please register for an account on Atlassian Answers, our community Q&A resource, and ask a question. We'll be keeping an eye on things to help out as soon as possible.