How to overcome BOMs pointing to wrong JARs?

Issue

• When compiling our custom code, we encounter issues where our OSGi modules fail to start due to unresolved references to the Liferay packages.
• For instance, the following error is thrown:

  org.osgi.framework.BundleException: Could not resolve module: my.custom.portlet [1111]_ 
  Unresolved requirement: Import-Package: com.liferay.portal.kernel.exception; version="[13.5.0,14.0.0)"

• The root cause appears to be that the BOMs for our version point to the wrong JARs.

Environment

• Liferay Developer Tools

Resolution

• To prevent such issues, consider utilizing the fat-jar (or mega-jar) as outlined in the Managing the Target Platform article.
  
  • See this blog post for more information: Introducing the Mega-Jar!
• Using com.liferay.portal.kernel as an example, what you would do to fix the issue is to replace all instances of this:

  group: "com.liferay.portal", name: "com.liferay.portal.kernel"

  And instead use the release.dxp.api megajar dependency:

  group: "com.liferay.portal", name: "release.dxp.api"

  If you already importing release.dxp.api, then remove the com.liferay.portal.kernel dependency,
• The portal-kernel compiled (portal-kernel.jar) and its source code is available through the BOMs, release.dxp.api-202x.qx.x.jar and release.dxp.api-202x.qx.x-sources.jar, respectively. These BOMs and all other BOMs are downloaded when a Liferay Workspace is built targeting the version 202x.qx.x.
  • See com/liferay/portal/release.dxp.api/ and com/liferay/portal/release.dxp.bom/

Additional Information

• Managing the Target Platform
• Blog posts (unofficial)
  
  • Introducing the Mega-Jar!
  • Gradle 7, Liferay and Version Catalogs