Resolving Breaking Changes

Liferay goes to great lengths to maintain backwards compatibility. Sometimes, breaking changes are necessary to improve Liferay DXP. There may be cases where breaking changes affect your code upgrade process and must be resolved. A breaking change can include

  • Functionality that is removed or replaced
  • API incompatibilities: Changes to public Java or JavaScript APIs
  • Changes to context variables available to templates
  • Changes in CSS classes available to Liferay themes and portlets
  • Configuration changes: Changes in configuration files, like,, etc.
  • Execution requirements: Java version, J2EE Version, browser versions, etc.
  • Deprecations or end of support: For example, warning that a certain feature or API will be dropped in an upcoming version.
  • Recommendations: For example, recommending using a newly introduced API that replaces an old API, in spite of the old API being kept in Liferay Portal for backwards compatibility.

Liferay provides a list of breaking changes for every major release to ensure you can easily adapt your code during the upgrade process.

The easiest way to resolve breaking changes is by using the Liferay Upgrade Planner. It automatically finds all documented breaking changes and can automatically resolve some of them on its own.

If you’re resolving breaking changes manually, make sure to investigate each breaking change document if you’re upgrading code across multiple versions. For example, if you’re upgrading from Liferay Portal 6.2 to Liferay DXP 7.0, you must resolve all the breaking changes listed in the three documents listed above.

Now that you’ve resolved your breaking changes, you’ll learn how to upgrade service builder services next.

« Resolving a Plugin's DependenciesUpgrading Hook Plugins »
Was this article helpful?
0 out of 0 found this helpful