Skip to main content

Creating OSGi Modules and Sharing Packages

  Overview This guide walks through creating two OSGi modules in Liferay 7.4 and sharing a Java package between them using the standard API + Implementation pattern. This is the most common and correct approach for exposing reusable services in a Liferay-based architecture. In OSGi, a bundle (module) does not expose its internal packages by default — everything is private unless explicitly exported. To share code between modules, the standard practice is to split functionality into: · An API module — contains interfaces/DTOs and exports the package · A Service (Implementation) module — implements the interface, imports the package, and registers the implementation as an OSGi component/service The consuming module then simply imports the API package and looks up the service using @Reference injection. Step 1: Create the API Module Using Liferay Workspace + Blade CLI, generate a new API module: blade create -t api -p com.sgc.greeting greeting-api This generates a Gradle module unde...
Post a Comment

Build a Custom REST API with REST Builder

 

Step-by-Step: Build a Custom REST API with REST Builder

  1. Create a multi-module Gradle project: impl, api, client modules

  2. Add REST Builder plugin to impl/build.gradle:

buildscript {
dependencies {
classpath group: 'com.liferay', name: 'com.liferay.gradle.plugins.rest.builder'
}
}
apply plugin: 'com.liferay.portal.tools.rest.builder'

  1. Create rest-config.yaml and rest-openapi.yaml in impl module root

  2. Run: ./gradlew buildREST - generates all interface, base, DTO classes

  3. Implement business logic in generated *ResourceImpl.java:

@Component(service = ProductResource.class)
public class ProductResourceImpl extends BaseProductResourceImpl {
@Reference
private ProductLocalService _productLocalService;


@Override
public Page<Product> getProductsPage(
String filter, Pagination pagination, Sort[] sorts) throws Exception {
// OData filter parsing
Filter oDataFilter = _filterParserProvider.provide(ProductEntityModel.class)
.parse(filter);
// Fetch from service
List<ProductModel> models = _productLocalService.getProducts(
pagination.getStartPosition(), pagination.getEndPosition(), ...
);
return Page.of(models.stream()
.map(ProductDTOConverter::toDTO).collect(toList()),
pagination, _productLocalService.getProductsCount());
}
}

  1. Deploy: ./gradlew deploy - API available at /o/product/v1.0/products

💡 REST Builder generates a complete Java client SDK automatically. This can be used by other Liferay modules or external Java services to consume your API with type-safe method calls.

Labels:

Comments

Post a Comment

Popular posts from this blog

service builder with crud operation in liferay

   Crud and Search opration in Liferay:      ->  Liferay use service builder techniq for Crud opration.    ->  Service builder purform by  Service.xml file.    ->  Service.xml file create table in database and also create class and diffrent method.   1)      Create service.xml file.             ->Create service.xml file in WEB-INF and write below code.             ->CODE:        < service-builder package-path = "com.test" >         < namespace > qr </ namespace >           < entity name = "Searchclass" local-service = "true"                     ...
26 comments
Read more

How to create new site programmaticly in liferay with validation

Create site in liferay <%@page import="javax.portlet.PortletPreferences"%> <%@page import="com.liferay.portal.kernel.util.ParamUtil"%> <%@page import="com.liferay.portal.kernel.util.HtmlUtil"%> <%@page import="com.liferay.portal.kernel.util.StringPool"%> <%@page import="com.liferay.portal.kernel.util.UnicodeProperties"%> <%@page import="com.liferay.portal.service.LayoutSetPrototypeServiceUtil"%> <%@page import="com.liferay.portal.model.LayoutSetPrototype"%> <%@page import="com.liferay.portal.service.GroupLocalServiceUtil"%> <%@page import="java.util.List"%> <%@page import="com.liferay.portal.kernel.bean.BeanParamUtil"%> <%@page import="com.liferay.portal.theme.ThemeDisplay"%> <%@page import="com.liferay.portal.model.Group"%> <%@page import="com.liferay.portal.kernel.util.WebK...
3 comments
Read more

The Ultimate Guide to Liferay DXP Performance Tuning: Speed Up Your Portal

The Ultimate Guide to Liferay DXP Performance Tuning: Speed Up Your Portal In the enterprise web space, milliseconds equal millions. Whether you are running a B2B commerce storefront, a customer support portal, or an employee intranet on Liferay DXP, slow load times will devastate your user experience and destroy your SEO rankings. Out of the box, Liferay is configured to run on almost any machine. This means its default settings are highly conservative to ensure compatibility, not maximum performance. If you are launching a production environment without tuning your server, you are leaving massive amounts of speed and scalability on the table. In this comprehensive, deep-dive guide, we are going to explore the critical layers of Liferay performance tuning. We will cover backend Java Virtual Machine (JVM) configuration, Database Connection Pooling, Elasticsearch optimization, and Frontend caching strategies. By the end of this guide, you will have a blazing-fast, enterprise-grade...
Post a Comment
Read more