• Portlet Guide
  • Quick tutorial: deploying the portlet test suite
  • Deployment
    • What is a portlet preparation? Why do I need it?
    • Deploying through the administration user interface
    • Deploying directly through the file system
  • Using in a Jahia page
    • Portlet instances
    • Portlet roles and Jahia permissions
  • Hello world portlet
    • Requirements
    • Project structure
    • Maven project descriptor
    • Portlet Java code
    • Portlet descriptor
    • Web application descriptor
    • The Tomcat deployment descriptor
    • Building and deploying
    • Redeployment
    • Troubleshooting deployment
    • Learning more
  • Support for Bridges
  • How to share portlet objects?
    • Public Render Parameters
    • Portlet Events
    • Jahia Shared Map
      • How to share a simple object?
      • How to read a simple object?
      • How to share a bean?
  • Performance
  • Using portlets on other application servers
  • Additional resources

Quick tutorial: deploying the portlet test suite

Before diving deeper into portlet integration, let’s start with a quick example of portlet deployment and usage. In this tutorial we will deploy the Apache Pluto test suite portlet, which is used for compatibility testing with the specification.

Steps :

1. Download the Apache Pluto portlet testsuite from: http://search.maven.org/remotecontent?filepath=org/apache/portals/pluto/pluto-testsuite/2.0.2/pluto-testsuite-2.0.2.war

2. Launch Jahia

3. Go into the administration screen, select “Server settings” and then “Manage Portlet”.

4. Click on the “Deploy new portlets” button.

5. Click on the “Browse...” button and navigate to the pluto-testsuite-2.0.2.war file and select it.
   

6. Then click on “Deploy new portlets”. You should now see the portlet application listed as “pluto-testsuite-2.0.2” in the “Manage portlets” screen. By selecting the application, you can view the list of portlets embedded in the application:
   

7. Go back to the “Server settings” screen and create a web project if you haven’t already done so. An easy way of doing this is to import the “ACME Website Demo 6.5” and click on “Proceed”:
   

8. Leave the defaults if they are and click “Import”. This step will take time in order to create the site.
   

9. Once it has completed, it will display the list with an “ACME” site now present. Now go back to the main administration screen, click on “Site settings” and make sure the “ACME site” is selected in the site drop-down list:
   

10. Then click on “Go to Edit Mode”

11. Open the Portlet Manager from the “Managers” drop down menu in the top Edit Mode tab:
    

12. The manager will be empty as we haven’t created any portlet instances yet. Right-click on “portlets” under “Current Site Portlets”:
    

13. Select “New portlet”. This will open up the Portlet Wizard:
    

14. Select “Test Portlet #1” and click Next on each of the following screens, and to complete this process, press “Finish”. You have now created a portlet instance for the portlet called “Test Portlet #1”. The Portlet Manager will refresh, and you will see this new portlet instance displayed in the right panel:
    

15. You may now close the Portlet Manager and go back to the main “Edit Mode” screen. In the left side panel, click on the Portlet tab, open up the “ACME” site node and select the “portlets” node. In the lower half of the left side panel you should see the newly created “Test Portlet #1” as illustrated below:
    

16. You can now simply drag and drop the portlet instance into any page you wish, confirm the portlet reference in the content editing screen and click “Save”:
    

17. The page will then refresh and should look something like this, depending on where you have positioned the portlet:
    

18. You can then switch to the Preview Mode to test your portlet (interacting with the portlet in Edit Mode is not supported nor recommended).

This concludes our quick tutorial on how to deploy, instantiate and position a portlet in a page.