Development and tooling

Using a Microservice Client Extension

Using a Microservice Client Extension A microservice client extension is a standalone server process that relies on OAuth 2 for communication with Liferay. The microservice is a resource server and...

Published Date: May 9, 2024 6:54 PM

Workflow Action YAML Configuration Reference

Workflow Action YAML Configuration Reference You can define a workflow action client extension with a client-extension.yaml file. Usage Details This client-extension.yaml file defines a workflow...

Published Date: May 9, 2024 6:54 PM

Contributing to Liferay Development

Contributing to Liferay Development The first thing to do in learning to fix bugs or contributing a feature is to become familiar with how to build the system. The Liferay Portal build system now...

Published Date: Nov 22, 2024 10:50 PM

Extending Liferay

Extending Liferay Liferay DXP/Portal is highly customizable. Its modular architecture contains components you can extend and override dynamically using APIs.

Published Date: Jul 18, 2024 8:39 PM

Architecture

Architecture The Liferay DXP/Portal architecture has three parts: Core: Bootstraps DXP and its frameworks. The Core provides a runtime environment for managing services, UI components, and...

Published Date: May 9, 2024 6:55 PM

Liferay Internals

Liferay Internals Liferay is a complex open-source platform built on several key technologies and architectural principles. Liferay is written mostly in Java and built on the OSGi framework, which...

Published Date: Jul 18, 2024 8:39 PM

Generating Translations Automatically

Generating Translations Automatically Liferay DXP supports 50 languages out-of-the-box. Each locale has its own language properties file containing keys for its language. When you create an...

Published Date: Jul 18, 2024 8:39 PM

Adding a Language

Adding a Language Liferay ships with over 50 languages out-of-the-box. Translation is complete for many of these languages, and some are still in the translation process. Each language has its own...

Published Date: Jul 18, 2024 8:39 PM

Customizing Localization

Customizing Localization Liferay ships with 55 translations, making it ideal for deployments all over the world. Sometimes, however, you must modify a translation or provide a new one. Here you can...

Published Date: Jul 18, 2024 4:48 PM

APIs as OSGi Services

APIs as OSGi Services After you've learned what a module is and how to deploy one, you can use modules to define APIs and implement them. Liferay APIs are OSGi services, defined by Java interfaces...

Published Date: Nov 22, 2024 10:50 PM

Resolving Third Party Library Package Dependencies

Resolving Third Party Library Package Dependencies An application can rely on multiple OSGi modules. Resolving their Java package dependencies can be challenging. In a perfect world, every package...

Published Date: Nov 22, 2024 10:50 PM

Fundamentals

Fundamentals Liferay development projects consist primarily of simple .jar files. These contain a few extra configuration files that make them OSGi modules, but they're easily understandable by...

Published Date: Jan 18, 2025 2:48 AM

Configuring Dependencies

Configuring Dependencies Liferay provides a container where modules can publish and consume functionality through their Java packages. Modules can leverage packages from other modules or...

Published Date: Nov 22, 2024 10:50 PM

Finding Artifacts

Finding Artifacts To use external artifacts in your project, you must configure their dependencies in your build.gradle Gradle script. Before specifying an artifact as a dependency, you must first...

Published Date: Nov 22, 2024 10:50 PM

Specifying Dependencies

Specifying Dependencies You must satisfy all dependencies to compile and deploy a module successfully. After you find the dependency artifacts, add them as dependencies in your Gradle build file....

Published Date: Nov 22, 2024 10:50 PM

Importing Packages

Importing Packages You often find yourself in a position of needing functionality provided by another module. To access this functionality, you must import packages from other modules into your...

Published Date: Nov 22, 2024 10:50 PM

Exporting Packages

Exporting Packages In OSGi, packages are private by default. You must explicitly exporting a package so other modules can import and use them. Here's how to export packages: Open your bnd.bnd...

Published Date: Nov 22, 2024 10:50 PM

7.2 Breaking Changes

7.2 Breaking Changes This document presents a chronological list of changes that break existing functionality, APIs, or contracts with third party Liferay developers or users. We try our best to...

Published Date: May 9, 2024 6:55 PM

Semantic Versioning

Semantic Versioning Semantic Versioning is a three tiered versioning system for incrementing version numbers based on the degree of API change made in a releasable software component. It's a...

Published Date: Nov 22, 2024 10:50 PM

Module Projects

Module Projects Liferay applications and customizations are OSGi modules: .jar files containing Java code and some extra configuration for publishing and consuming APIs. A module project comprises...

Published Date: Nov 22, 2024 10:50 PM