Creating Portlet Providers

Follow these steps to create your own Portlet Provider:

1. Create an OSGi module.

2. Create a PortletProvider class in your module. Use the recommended class naming convention:

   [Entity] + [Action] + PortletProvider

   For example, here’s a Portlet Provider class for viewing a LanguageEntry:

   LanguageEntryViewPortletProvider

3. Extend BasePortletProvider if you want to use its getPortletURL method implementations.

4. Implement one or more PortletProvider subinterfaces that match your action(s):

   • AddPortletProvider
   • BrowsePortletProvider
   • EditPortletProvider
   • ManagePortletProvider
   • PreviewPortletProvider
   • ViewPortletProvider

5. Make the class an OSGi Component by adding an annotation like this one:

   @Component(
       immediate = true,
       property = {
           "model.class.name=CLASS_NAME",
           "service.ranking:Integer=10"
       },
       service = {INTERFACE_1.class, ...}
   )
   

   The immediate = true element specifies that the component should be activated immediately upon installation.

   Assign to the model.class.name property the fully qualified class name of the entity the portlet operates on. Here’s an example model.class.name property for the WikiPage entity:

   "model.class.name=com.liferay.wiki.model.WikiPage"
   

   Assign the service element to the PortletProvider subinterface(s) you’re implementing (e.g., ViewPortletProvider.class, BrowsePortletProvider.class, etc.). This example sets service to EditPortletProvider.class:

   service = EditPortletProvider.class
   

6. If you’re overriding an existing Portlet Provider, rank your Portlet Provider higher by specifying a service.ranking:Integer property with a higher integer value:

   property = {
       ...,
       "service.ranking:Integer=10"
   }
   

7. Implement the provider methods you want. Be sure to implement the PortletProvider method getPortletName. If you didn’t extend BasePortletProvider, implement PortletProvider’s getPortletURL methods too.

8. Deploy your module.

Now your Portlet Provider is available to return the ID and URL of the portlet that provides the desired behaviors. For more information on this, see Retrieving Portlets.

Related Topics

Portlet Providers

Retrieving Portlets