Friday Sep 03, 2010

OpenPortal Portlet Container 2.1.2 and NetBeans Portal Pack 3.0.4 released

We are pleased to announce the release of OpenPortal Portlet Container 2.1.2 and NetBeans Portal Pack 3.0.4.

For the details regarding NetBeans Portal Pack 3.0.4 you can check Satya's blog.

The OpenPortal Portlet Container 2.1.2 has few enhancements and bug fixes. Following is brief list of changes that went into this release. Check the User Guide for more details

  • support for the install and portlet deployment on Oracle WebLogic, GlassFish V3, JBoss Application Server and Jetty
  • ability to embed a portlet in a JSP using tag libraries
  • now there is an option to store portlet driver data and portlet preferences to the database.
It is recommended that you uninstall previous versions before installing this release.

Following developer tools are available to develop, deploy and test portlets on the OpenPortal Portlet Container 2.1.2

If you have questions on how to use the OpenPortal Portlet Container and other comments/suggestions/requests, we urge you to join the users@portlet-container.dev.java.net alias.

Please report any issues that you encounter while trying OpenPortal Portlet Container to issues@portlet-container.dev.java.net.

Monday Nov 30, 2009

Resetting the JSF Portlet State

Consider a JSF Portlet having a navigation(what is a JSF app without navigation!!), for example a Search JSF Portlet. It has two pages, "Search Criteria Page" and "Search Results Page".  After you enter the criteria on "Search Criteria Page" and click submit, you will get a "Search Results Page". Add this JSF Portlet on a page in Web Space or Liferay. Now visit some other page and comeback to the page on which you added the JSF Portlet, you will see that it is showing "Search Results Page", i.e the state is retained. This is as per spec and is the correct behaviour. What if you want to see "Search Criteria Page" everytime you visit the page. This can be achieved as follows.

1. In your JSF Portlet, add the following init parameter in the portlet.xml

        <init-param>
            <name>com.sun.faces.portlet.CLEARING_STATE_ENABLED</name>
            <value>true</value>
        </init-param>

2. In Web Space / Liferay, Click on "Manage Pages"

Manage Pages Drop Down

3. Select the page that has JSF Portlet(in this example, i have it on "jsftest" page). In the "Query String" textfield, enter the value com.sun.faces.portlet.CLEAR_STATE=true. Save the page.

Manage Pages

Now whenever you visit the page you will see the "Search Criteria Page". But if you are doing any action on any other portlet on that page, "Search JSF Portlet" will retain the state. It will not reset to "Search Criteria Page". Resetting happens only when you visit the page. This means, suppose, there is another JSR286 portlet or a JSF Portlet on that page and "Search JSF Portlet" shows "Search Results Page". If you are doing any action on the other portlet and after the page is rendered, "Search JSF Portlet" will continue to show "Search Results Page".

Wednesday Nov 04, 2009

JSR 286: A Comprehensive article

I have been blogging about the features of JSR 286(Java Portlet Specification 2.0) from the time the expert group(of which i was one of the members representing Sun Microsystems), started publishing the draft specification. Everytime one asks me how a feature in JSR 286 works, i have to point him to one of my blogs. A comprehensive article on all features of JSR 286 was missing.

I have written a comprehensive article that includes all features of JSR 286 with examples. This also includes less talked about ones like wild card in eventing, alias support, Portlet URL listeners, etc..If you see that any feature is missing or if there any corrections to be done, let me know, i will incorporate them. Thanks.

The comprehensive article on JSR 286 is at https://portlet-container.dev.java.net/docs/jsr286.html

Tuesday Aug 25, 2009

Coordination between portlets across pages

There has been lot of queries asking me how to send/receive events with portlets that are not on same page. So I thought let me blog about this.

In order to provide coordination between portlets the Java Portlet Specification, JSR 286 introduces Eventing and Public Render Parameters

Eventing:

   By default portlets can send and receive events with other portlets that are on the same page. This can be changed to enable portlets to send and receive events from other portlets that are on different pages. This can be done by adding the following property in portal-ext.properties in Web Space server and Liferay Portal 5.2.x.

portlet.event.distribution=ALL_PORTLETS


Public Render Parameters:

   By default portlets can share render states with other portlets that are on the same page. This can be changed to enable portlets to share render states with other portlets that are on different pages. This can be done by adding the following property in portal-ext.properties in Web Space server and Liferay Portal 5.2.x.

portlet.public.render.parameter.distribution=ALL_PORTLETS


Preventing infinite loops in Eventing:

    The following property is used to specify the maximum number of events that can be generated from portlets to prevent infinite loops. If a portlet sends an event to other portlets, it is considered as one event generation. If the other portlets send events, that is considered as two event generations and so on. The default value is 3.

portlet.event.max.generation=3

Monday Mar 23, 2009

Changing log level in Portlet Container

The Portlet Container 2.x that is part of  Sun GlassFish Web Space Server , Liferay and OpenPortal Portlet Container uses JDK logging (JSR 47) for logging messages , exceptions etc. By default the log level in GlassFish is INFO. If you need to disable the portlet container logs or change the log level, how to do it?. Following are the steps..

  1. Login to GlassFish adminconsole(default: localhost:4848)
  2. Click on "Application Server" on the left side.Then click on Logging->Log levels as shown below




  3. Then scroll down and click on "Add Property" and enter the "debug.com.portal.portletcontainer" in Name field and any valid JDK Log level(eg: INFO or WARNING or SEVERE etc..) in Value field as shown below.




  4. Click on "Save". This should take effect immediately, no restart is required.

        
    

Friday Feb 20, 2009

XMLPortletRequest in Portlet Container 2.1

XMLPortletRequest is a wrapper over XMLHttpRequest and shares the same syntax and semantics with XMLHttpRequest.

If a portlet wants to update its UI asynchronously through resource URL, it would simply use XMLPortletRequest instead of the XMLHttpRequest.


Here is an example on how to use XMLPortletRequest.

<script type="text/javascript" 
        src="<%=renderRequest.getContextPath()%>/js/XMLPortletRequest.js">
</script>
<script>
    var portletRequest = new XMLPortletRequest("<portlet:namespace/>");
    portletRequest.onreadystatechange = function() {.....}
    portletRequest.open("POST", "<portlet:resourceURL escapeXml='false' />");
    portletReq.send("foo=" + bar);
</script>

Check the XPRInvoiceAjaxPortlet sample(sources and binary) that showcases the usage of XMLPortletRequest. Using XMLPortletRequest drastically reduces the amount of code. Compare the view jsp page of InvoiceAjaxPortlet that does not use XMLPortletRequest with view jsp page of XPRInvoiceAjaxPortlet that uses XMLPortletRequest.

This feature has been added in Portlet Container 2.1. This is available in OpenPortal Portlet Container 2.1, Sun GlassFish Web Space Server 10.0 and Liferay version 5.2 and higher.

OpenPortal Portlet Container 2.1 released

The OpenPortal Portlet Container 2.1 has been released.

The Portlet Container 2.1 is also part of following releases


Why the version is called 2.1 and not 2.0 update 2 ?

Because, this release has lot of changes and is a major release. Following is brief list of changes  that went into this release

  • Major enhancements to support WSRP 2.0 FCS, GlassFish Web Space Server and Liferay version 5.2.
  • New features like XMLPortletRequest.
  • Jar name changes to support the deployment of OpenPortal Portlet Container and GlassFish Web Space Server on the same domain of GlassFish.
  • The third party jars used by the driver have been updated(like commons-fileupload, JSTL and Standard jars)

It is recommended that you uninstall previous versions before installing this release.

Following developer tools are available to develop, deploy and test portlets on the OpenPortal Portlet Container 2.1.

If you have questions on how to use the OpenPortal Portlet Container and other comments/suggestions/requests, we urge you to join the users@portlet-container.dev.java.net alias.

Please report any issues that you encounter while trying OpenPortal Portlet Container to issues@portlet-container.dev.java.net.

Friday Feb 13, 2009

Portlet Container in Sun GlassFish Web Space Server

Sun GlassFish Web Space Server 10.0 has been released. This release uses Portlet Container 2.1

The Portlet Container 2.1 is a fully compliant implementation of the Portlet 2.0 (JSR286) specification. And it also implements many of the optional features like

You get all these features in Sun GlassFish Web Space Server 10.0 which is based on Liferay Portal 5.2.  Apart from that we have added XMLPortletRequest. More about XMLPortletRequest in my next blog.

Monday Dec 01, 2008

Setting Markup Head Elements in Portlets

JSR 286 (Portlet 2.0 specification) allows the portlet to set HTML elements like <link>, <script>, <meta> in the <head> section of the portal page. This can be achieved via the addProperty method on the RenderResponse with MimeResponse.MARKUP_HEAD_ELEMENT as property name and org.w3c.dom.Element as value.

Following is the code snippet..
import javax.portlet.GenericPortlet;  
import javax.portlet.RenderRequest;  
import javax.portlet.RenderResponse;  
import javax.portlet.MimeResponse;  
import org.w3c.dom.Element;  
public class TestPortlet extends GenericPortlet {  
    @Override
    protected void doHeaders(RenderRequest request, RenderResponse response) {
        Element metaDescription = response.createElement("meta");
        metaDescription.setAttribute("name", "description");
        metaDescription.setAttribute(
              "content", "everything you want to know about stamps");
        response.addProperty(
              MimeResponse.MARKUP_HEAD_ELEMENT, metaDescription);
        Element metaKeywords = response.createElement("meta");
        metaKeywords.setAttribute("name", "keywords");
        metaKeywords.setAttribute("content", "stamps, history");
        response.addProperty(MimeResponse.MARKUP_HEAD_ELEMENT, metaKeywords);
    }
....
}

This feature has been implemented in OpenPortal Portlet Container 2.0 Update 1.

There has been lot of confusion regarding the role of container runtime option (javax.portlet.renderHeaders) while setting the headers. I get the following question a lot:

Is the container runtime option (javax.portlet.renderHeaders) needed if the portlet wants to set headers?

The answer: It depends on whether the portal is a streaming portal or a buffering portal.
First the definition: In case of streaming portal, the output of the portlet is not buffered, while it is buffered in case of buffering portal.
The buffering portal can ignore the container runtime option whereas it is mandatory in case of streaming portal.

In case of OpenPortal Portlet Container, Project WebSynergy which are buffering portals, the container runtime option(javax.portlet.renderHeaders) is not required to be present in the portlet.xml of the portlet that wants to set the headers.

Friday Nov 07, 2008

GlassFish v3 Prelude and Portlet Container 2.0_01

The OpenPortal Portlet Container 2.0 Update 1 runs on GlassFish v3 Prelude

Set ANT_HOME and use CLI to install as follows (there is an issue with GUI install)

java -jar portlet-container-configurator.jar glassfishv3-prelude\\glassfish glassfishv3-prelude\\glassfish\\domains\\domain1

Note: the glassfish home is glassfishv3-prelude\\glassfish

Please report any issues that you encounter to users@portlet-container.dev.java.net.


Friday Oct 31, 2008

OpenPortal Portlet Container 2.0_01 released

The OpenPortal Portlet Container 2.0 Update 1(2.0_01) has been released.

The OpenPortal Portlet Container 2.0_01 is also part of Java Application Platform SDK Update 6.

This release has some important fixes and enhancements to support WSRP Beta and Liferay integration. The changelog contains issues resolved. It is recommended that you uninstall previous versions before installing this release.

Following developer tools are available to develop, deploy and test portlets on the Portlet Container 2.0_01.

If you have questions on how to use the OpenPortal Portlet Container and other comments/suggestions/requests, we urge you to join the users@portlet-container.dev.java.net alias.

Please report any issues that you encounter while trying OpenPortal Portlet Container to issues@portlet-container.dev.java.net.

Tuesday Jul 22, 2008

Article in TheServerSide.com uses OpenPortal Portlet Container

Recently one of colleagues came across an article the TheServerSide.com that explains the "Action Scoped Request attributes" container runtime option. The article uses OpenPortal Portlet Container to explain the feature.

My colleague in his blog talks about this and also why he likes OpenPortal Portlet Container.

Tuesday Jun 24, 2008

Open Portal Portlet Container 2.0 released

OpenPortal Portlet Container 2.0 has been released.

The release is a fully compliant implementation of the Portlet 2.0 (JSR286) specification, which was released last week. It is recommended that you uninstall previous versions before installing this release.

The SDN article describes the new features along with samples.

Netbeans Portlet Pack 2.0 is available that helps developers to develop, deploy and test portlets on the Portlet Container 2.0.

If you have questions on how to use the OpenPortal Portlet Container and other comments/suggestions/requests, we urge you to join the users@portlet-container.dev.java.net alias.

Please report any issues that you encounter while trying OpenPortal Portlet Container to issues@portlet-container.dev.java.net.

Thursday Mar 20, 2008

JSR286: defineObjects Tag (variables available in the JSP)

I have got lot of queries about the variables to be used in JSP page when included from within a Portlet. Also few problems were reported that the new variables introduced in JSR 286 are not working as expected. Let me explain both.

JSR 168 (Portlet 1.0)

In JSR 168 only three variables are defined:
  • RenderRequest renderRequest
  • RenderResponse renderResponse
  • PortletConfig portletConfig
In order to use them you must refer to the taglib uri and use defineObject Tag in the JSP page as follows

<%@ taglib uri=”http://java.sun.com/portlet” prefix=”portlet”%>

<portlet:defineObjects/>


JSR 268 (Portlet 2.0)


In JSR 286 following variables are defined:
  • RenderRequest renderRequest and RenderResponse renderResponse (if the JSP is included from render method)
  • ResourceRequest resourceRequest and ResourceResponse resourceResponse (if the JSP is included from serveResource method)
  • ActionRequest actionRequest and ActionResponse actionResponse (if the JSP is included from processAction method)
  • EventRequest eventRequest and EventResponse eventResponse (if the JSP is included from processEvent method)
  • PortletConfig portletConfig
  • PortletSession portletSession (returns an existing session or null if no session exists)
  • Map<String, Object> portletSessionScope (provides access to the portletSession attributes)
  • PortletPreferences portletPreferences (provides access to the portlet preferences)
  • Map<String, String[]> portletPreferencesValues (provides access to the portlet preferences as a Map)

In order to use the variables you must refer to a different taglib uri and use defineObject Tag in the JSP page as follows


<%@ taglib uri=”http://java.sun.com/portlet_2_0” prefix=”portlet”%>

<portlet:defineObjects/>

 

Monday Feb 11, 2008

JSR286 : Public Render Parameter feature (updated)

When the Java Portlet Specification(JSR 286) early draft was released last year, i had written a blog on Public Render Parameter feature. Recently the proposed final draft was released, it has some changes in public render parameter feature. In this blog i will explain the feature with an example.

In JSR 168, the render parameters set in processAction is only available in the render of the same portlet.

With the Public Render Parameters feature, the render parameters set in the processAction of one portlet will be available in render of other portlets also. Using public render parameters instead of events avoids the additional process event call.

In order to allow coordination of render parameters with other portlets, within the same portlet application or across portlet applications, the portlet can declare public render parameters in its deployment descriptor using the public-render-parameter element in the portlet application section. Public render parameters can be viewed and changed by other portlets or components.

In the portlet section each portlet can specify the public render parameters it would like to share via the supported-public-render-parameter element. The supported-public-render-parameter element must reference the identifier of a public render parameter defined in the portlet application section in a public-render-parameter element.

In the code, the portlets should use the defined public render parameter identifier to access the public render parameter(new addition in the proposed final draft).

To create portlets that use the public render parameters, follow these steps(snippets from WeatherMap sample application):

1. Declare the render parameters to be shared in the portlet.xml file by setting the public render parameters at the portlet application level.

      <portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"             
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"             
                   xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
                                       http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
                   id="myPortletApp" version="2.0">
        <portlet>
         . . .
        </portlet>
                      
        <public-render-parameter>
          <identifier>zip-id</identifier>
          <qname xmlns:x="http://sun.com/params">x:zip</qname>
        </public-render-parameter>

      </portlet-app>

       
2. Specify the render parameter that the portlet would like to share in the portlet section.

      <portlet-app xmlns="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"             
                   xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"             
                   xsi:schemaLocation="http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd
                                       http://java.sun.com/xml/ns/portlet/portlet-app_2_0.xsd"
                   id="myPortletApp" version="2.0">
      <portlet>
         <description>WeatherPortlet</description>
         <portlet-name>WeatherPortlet</portlet-name>
         <display-name>WeatherPortlet</display-name>
         <portlet-class>com.sun.portal.portlet.WeatherPortlet</portlet-class>
         ......               
         <supported-public-render-parameter>zip-id</supported-public-
         render-parameter>
      </portlet>

      <portlet>
         <description>MapPortlet</description>
         <portlet-name>MapPortlet</portlet-name>
         <display-name>MapPortlet</display-name>
         <portlet-class>com.sun.portal.portlet.MapPortlet</portlet-class>
          . . .
         <supported-public-render-parameter>zip-id</supported-public-
         render-parameter>
      </portlet>
          .  . .
      </portlet-app>

       
3. Set the render parameter in the processAction() method:

      public class WeatherPortlet extends GenericPortlet {
           . . .
         public void processAction(ActionRequest req, ActionResponse res)
         throws IOException, PortletException {
          . . .
                 res.setRenderParameter("zip-id", zip);
           }
           . . .
      }

You can download the binary WeatherMap.war file to deploy and run the sample application in OpenPortal Portlet Container 2.0 Beta2 (or latest). You can also get the source for the sample. If you are behind a firewall you need need to set the proxy in the webcontainer configuration.

The figure shows the Weather and Map portlets. The Weather portlet sets the zip-id which is declared as a Public Render Parameter. This parameter is supported by both Weather and Map portlets. Any change in the value of zip by Weather portlet is reflected during the render phase of both weather and map portlets.

Weather Map Sample 

About

Deepak Gothe

Search

Categories
Archives
« April 2014
SunMonTueWedThuFriSat
  
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
   
       
Today