• 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

What is a portlet preparation? Why do I need it?

Each implementation of the portlet container has its own way of working internally within the portlet application. For example, the Apache Pluto portlet container embedded within Jahia works by inserting a servlet that will be used to dispatch portlets upon deployment or at packaging time. The portlet container then calls the servlet, which in turn will relay the request to the requested portlet.

Portlet preparation is a modification of the WEB-INF/web.xml file adding the proper configuration for each portlet to be mapped through the PortletServlet servlet used internally by Apache Pluto. It is therefore a required step for proper deployment inside Jahia.

You can check if a portlet application has already prepared by opening its WEB-INF/web.xml file. If you see lines similar to the code below, this means the portlet has already been prepared, and you may deploy it without preparing it first.

<servlet>
<servlet-name>TestPortlet1</servlet-name>
<servlet-class>org.apache.pluto.container.driver.PortletServlet</servlet-class>
<init-param>
<param-name>portlet-name</param-name>
<param-value>TestPortlet1</param-value>
</init-param>
<load-on-startup>1</load-on-startup>
</servlet>