Making portlet a PanelApp


Or how to include a portlet into the Control Panel

Overview 

 You may need to implement a portlet, which should be accessible only by Administrator. In this case it makes sense to include it into the Control Panel, and prevent it from being added to the page. This article will explain how to achieve this.

Implementation

 1. Implement a portlet class:

@Component(
     immediate = true,
     property = {
           "com.liferay.portlet.display-category=" + ProjectsAdminPortletKeys.DISPLAY_CATEGORY,
           "com.liferay.portlet.instanceable=true",
           "javax.portlet.init-param.template-path=/",
           "javax.portlet.init-param.view-template=/view.jsp",
           "javax.portlet.name=" + ProjectsAdminPortletKeys.PORTLET_ID,
           "javax.portlet.display-name=" + ProjectsAdminPortletKeys.DISPLAY_NAME,
           "javax.portlet.resource-bundle=content.Language",
           "javax.portlet.security-role-ref=power-user,user",
           "com.liferay.portlet.add-default-resource=true",
           "com.liferay.portlet.layout-cacheable=true",
           "com.liferay.portlet.private-request-attributes=false",
           "com.liferay.portlet.private-session-attributes=false",
           "com.liferay.portlet.render-weight=50",
           "com.liferay.portlet.use-default-template=true",
           "javax.portlet.expiration-cache=0",
           "com.liferay.portlet.css-class-wrapper=" + ProjectsAdminPortletKeys.CSS_CLASS_WRAPPER,
           "com.liferay.portlet.header-portlet-css=/css/main.css"
     },
     service = Portlet.class
)
public class ProjectsAdminPortlet extends MVCPortlet {
}

2. Implement a panel app class:

@Component(
       immediate = true,
       property = {
               "panel.app.order:Integer=0",
               "panel.category.key=" + PanelCategoryKeys.SITE_ADMINISTRATION_CONTENT
       },
       service = PanelApp.class
)
public class ProjectsAdminPanelApp extends BasePanelApp {
   @Override
   public String getPortletId() {
       return ProjectsAdminPortletKeys.PORTLET_ID;
   }
   @Override
   @Reference(
           target = "(javax.portlet.name=" + ProjectsAdminPortletKeys.PORTLET_ID + ")",
           unbind = "-"
   )
   public void setPortlet(Portlet portlet) {
       super.setPortlet(portlet);
   }
}

, where:
"panel.category.key” - defines the category in Control Panel, where the portlet should be added to;
"panel.app.order” - defines the portlet position in the portlet list.

3. Constants class:

public class ProjectsAdminPortletKeys {
  public static final String DISPLAY_NAME = "Projects";
  public static final String DISPLAY_CATEGORY = "category.hidden";
  public static final String PORTLET_ID = "com_sample_project_web_portlet_ProjectsAdminPortlet";
  public static final String CSS_CLASS_WRAPPER = "projects-admin";
}

Note: category should be hidden (“category.hidden”) to prevent the portlet from being added to a portal page.

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"                              iteratorURL =" <%= iteratorURL %> " >     < liferay-ui :search-container-results             results =" <%= ProjectLocalServiceUtil. getProjects (scopeGroupId, searchContainer.getStart(), searchContainer.getEnd()) %> " />     < liferay-ui :search-container-row className ="com.sample.sb.model.Project" modelVar ="project" keyP
Read more

Liferay DXP - max upload file size

Image
Liferay DXP - increase Maximum Upload Request Size By default, Liferay has limit to 100 MB for file upload. Sometimes you need to upload larger files, and this restriction can be changed in configuration. Go to Control Panel -> Configuration -> System Settings -> Infrastructure. Click on "Upload Servlet Request". Modify " Overall Maximum Upload Request Size"  value and set which you need: Save the configuration. Now you should be able to upload large files to your Liferay DXP instance.
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