JSP Override with OSGi Fragments

JSP Override with OSGi Fragments

Note: article is obsolete, check new version here.


Overview

This article describes how to create custom JSP Override module (AKA JSP Hook in previous Liferay versions).
Note: Although this way is not recommended way by Liferay (see: https://portal.liferay.dev/docs/7-2/customization/-/knowledge_base/c/jsp-overrides-using-osgi-fragments), it seems to be the most straightforward and powerfult approach.

JSP-Override module creation

1 - Finding the required JSP in Liferay sources.

Let's say, for example, you need to customize Asset Publisher configuration and add additional option for Content Set Provider configuration: max items count to display.
Find the appropriate JSP file in Liferay sources: for Liferay 7.2 CE GA 1 this is:
liferay-ce-portal-src-7.2.0-ga1-20190531153709761.zip!/liferay-ce-portal-src-7.2.0-ga1/modules/apps/asset/asset-publisher-web/src/main/resources/META-INF/resources/configuration/asset_list_provider.jsp

2 - Finding the required JSP in Marketplace LPKG file.

We found, that required JSP in under asset-publisher-web folder in Liferay sources.
Thus, find appropriate *.lpkg file in LR/osgi/marketplace folder.
For our case it's Liferay CE Web Experience - Liferay CE Asset - Impl.lpkg. Copy it somewhere and unpack.
Find the same JSP in the appropriate JAR file

3 - Create module for JSP Override

Create module in your Liferay workspace.
Configure the bnd.bnd file:
Bundle-Name: Asset Publisher Configuration JSP Override
Bundle-SymbolicName: com.lifedev.asset.publisher.configuration.jsp.override
Bundle-Version: 1.0.0
Fragment-Host: com.liferay.asset.publisher.web;bundle-version="3.0.21"
-sources: true
Fragment-Host should point to module found above: in this example for com.liferay.asset.publisher.web-3.0.21.jar Fragment-Host value is: com.liferay.asset.publisher.web;bundle-version="3.0.21"
Copy JSP to your module (using the same folder, META-INF/resources/configuration here).
Add required customization, for example

4 - Deploy module

Deploy module with JSP Override.
Note: after successful deployment module state will be Resolved, not Active.
Verify, if changed applied.
Congratulations! You have implemented the JSP Override 👌
But it's too early to drink beer 🍺
You still need to save the added field on customized JSP on the backend. For this you may use the Porltet Filter.

Enjoy 😏

Comments

Post a Comment

Popular posts from this blog

Liferay Search Container Example

Or how to implement a custom search container in Liferay Overview   Search Containers are used in Liferay to display the table data. This article shows a simple example of how to implement a custom search container.  Example < liferay-portlet :renderURL varImpl ="iteratorURL" /> < liferay-ui :search-container total =" <%= ProjectLocalServiceUtil. getProjectsCount (scopeGroupId) %> "                              delta ="10"                              emptyResultsMessage ="no-projects-found"                              iterato...
Read more

Installing Blade CLI from Command Line

Installing Blade CLI from Command Line Download JPM Jar file Download biz.aQute.jpm.run.jar file using link: https://raw.githubusercontent.com/jpm4j/jpm4j.installers/master/dist/biz.aQute.jpm.run.jar Initialize JPM Run command: java -jar biz.aQute.jpm.run.jar init Install Blade Run command: jpm install -f https://releases.liferay.com/tools/blade-cli/latest/blade.jar to install blade. Update blade to make sure you have the latest version, sample:  blade update Current blade version 3.3.0.201811151753 Updating from: https://repository-cdn.liferay.com/nexus/content/repositories/liferay-public-releases/com/liferay/blade/com.liferay.blade.cli//3.8.0/com.liferay.blade.cli-3.8.0.jar Update completed successfully. Congratulations! Now you have Blade CLI installed. Sample command for mvc-portlet: blade create -t mvc-portlet -p com.demo.portlet -c DemoPortlet demo-portlet Enjoy 😏
Read more

Liferay Keycloak integration

Image
Liferay Keycloak integration using OpenID Overview This tutorial explains how to configure OpenID SSO between Liferay 7.2 and Keycloak 7.0.1 Installation instructions KeyCloak Configuration 1. Install and startup Keycloak server Download latest Keycloak server:  https://www.keycloak.org/downloads.html Unzip keycloak-7.0.1.zip folder. Run  keycloak-7.0.1/bin/standalone.sh  (or  keycloak-7.0.1/bin/standalone.bat ) file. Keycloak should be started on 8080 port:  http://localhost:8080 2. Create default admin user: and sign in to Admin Console. 3. Check OpenID configuration Click on "OpenID Endpoint Configuration": JSON configuration should appear, like this: { "issuer": "http://localhost:8080/auth/realms/master", "authorization_endpoint": "http://localhost:8080/auth/realms/master/protocol/openid-connect/auth", "token_endpoint": "http://localhost:8080/auth/realms/master/protocol/openid-con...
Read more