• 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

Jahia Shared Map

The Jahia Shared Map is a map that is accessible by any portlets or Jahia templates.

Within Jahia, it’s stored as the user session attribute named "jahiaSharedMap" and can be retrieved with the following code:

Map sharedMap = (Map)session.getAttribute("jahiaSharedMap");

Within a portlet, it is stored as a portlet request attribute named "jahiaSharedMap". It can be retrieved with the following code:

Map map = (Map) portletRequest.getAttribute("jahiaSharedMap");

The Jahia Shared Map can be updated only during the processAction(…) or from a template.

Map map = (Map) actionRequest.getAttribute("jahiaSharedMap");
public void processAction(ActionRequest actionRequest, ActionResponse actionResponse) throws PortletException, IOException {
Map map = (Map) actionRequest.getAttribute("jahiaSharedMap");
if (map == null) {
map = new HashMap<Object, Object>();
}
map.put("date", new Date());
actionRequest.setAttribute("jahiaSharedMap", map);
}

If the portlet tries to modify the map during the render phase of the portlet, an exception is thrown.

public void render(RenderRequest renderRequest, RenderResponse renderResponse) throws PortletException, IOException {
Map map = (Map) renderRequest.getAttribute("jahiaSharedMap");
if (map == null) {
map = new HashMap<Object, Object>();
}
map.put("date", new Date());
// an exception will be thrown
renderResponse.setAttribute("jahiaSharedMap", map);
}

Here is an example of execution:

Portlets A, B and C could be in different applications (contexts).