Liferay MVC portlet - first steps

Liferay MVC portlet - first steps
When you generate an MVC Portlet in Liferay Workspace - you’ll get the following code (sample):

 Portlet class:
@Component(
  immediate = true,
  property = {
     "com.liferay.portlet.display-category=category.sample",
     "com.liferay.portlet.instanceable=true",
     "javax.portlet.init-param.template-path=/",
     "javax.portlet.init-param.view-template=/view.jsp",
     "javax.portlet.name=" + UserSearchPortletKeys.UserSearch,
     "javax.portlet.resource-bundle=content.Language",
     "javax.portlet.security-role-ref=power-user,user"
  },
  service = Portlet.class
)
public class UserSearchPortlet extends MVCPortlet {
}

 Portlet keys class:
public class UserSearchPortletKeys {
  public static final String UserSearch = "usersearch";
}
Here is a list of first steps to modify here.
1) Change generated portlet name.
Change generated name with Liferay-style portlet ID. For this sample:
UserSearchPortletKeys:
  public static final String PORTLET_ID = "com_liferdev_user_search_portlet_UserSearchPortlet";
UserSearchPortlet:
"javax.portlet.name=" + UserSearchPortletKeys.PORTLET_ID,
Use full class name with ‘_’ instead of ‘.’
2) Add display name.

Add constant and use it in portlet:
UserSearchPortletKeys:
public static final String DISPLAY_NAME = "User Search Portlet";
UserSearchPortlet:
"javax.portlet.display-name=" + UserSearchPortletKeys.DISPLAY_NAME,
This name will be displayed for portlet on Liferay page.
3) Change display category:

 Use required category name to display portlet under that category:
UserSearchPortletKeys:
public static final String DISPLAY_CATEGORY = "LifeDev";
UserSearchPortlet:
"com.liferay.portlet.display-category=" + UserSearchPortletKeys.DISPLAY_CATEGORY,
Otherwise, portlet will be displayed under default “Sample” category.
4) Add css-class-wrapper:
UserSearchPortletKeys:
public static final String CSS_CLASS_WRAPPER = "lifedev-user-search-portlet-wrapper";
UserSearchPortlet:
"com.liferay.portlet.css-class-wrapper=" + UserSearchPortletKeys.CSS_CLASS_WRAPPER
This is needed to reference portlet in theme for styling.
5) Remove generated resources/content/Language.properties file
It’s a best practice to store Language properties in a single resource bundle module.
6) Create required MVC Commands (render/action/resource) and use them in portlet.
It’s a best practice to not modify portlet’s class code, but use a separate command for each required action.
Here is sample code for this example:
Portlet:
@Component(
  immediate = true,
  property = {
     "com.liferay.portlet.display-category=" + UserSearchPortletKeys.DISPLAY_CATEGORY,
     "com.liferay.portlet.instanceable=true",
     "javax.portlet.init-param.template-path=/",
     "javax.portlet.init-param.view-template=/view.jsp",
     "javax.portlet.name=" + UserSearchPortletKeys.PORTLET_ID,
     "javax.portlet.display-name=" + UserSearchPortletKeys.DISPLAY_NAME,
     "javax.portlet.resource-bundle=content.Language",
     "javax.portlet.security-role-ref=power-user,user",
     "com.liferay.portlet.css-class-wrapper=" + UserSearchPortletKeys.CSS_CLASS_WRAPPER
  },
  service = Portlet.class
)
public class UserSearchPortlet extends MVCPortlet {
}
Portlet keys: 
public class UserSearchPortletKeys {
  public static final String PORTLET_ID = "com_liferdev_user_search_portlet_UserSearchPortlet";
  public static final String DISPLAY_NAME = "User Search Portlet";
  public static final String DISPLAY_CATEGORY = "LifeDev";
  public static final String CSS_CLASS_WRAPPER = "lifedev-user-search-portlet-wrapper";
}

Hope, this will help you for developing MVC portlets 😏

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