Java Portlet 工具:将 Java Web 应用程序转换为自适型 Portlet
第 1, 2, 3, 4, 5 页
Java Portlet 工具提供了一个在 JSP scriptlets 和 JSP 扩展语言中使用的特殊 JavaBean。有关 JSP 扩展语言详细信息,请查看 Sun 的 JSP 文档。PortletBean 是一个将 EDK 和客户端 Portlet API 的功能包装在一起的 JavaBean。它为以下对象提供了属性的 set 和 get 方法:
该 Bean 以 "portlet" 为参数被自动附加到每个发送到 PTPortletFilter 的 ServletRequest 中。比起在 JSP scriptlet 中构造 IPortletContext 和 IPortletRequest 对象来,开发者可以通过 PortletBean 引用 EDK 方法的值。而这仅仅需要包装一下 JavaBean 语法中现存的功能,PortletBean 可以在 Java Web 应用程序中发挥巨大的作用。例如,一个 JSF Web 应用程序开发者想要创建一个“个人设置 portlet”, 用以设置用户的首选项和阻止一个 PCC 事件以通知其他 protlet 这个选项已经被设置。在 JSP 页面中,这些标记可能与以下类似:
<f:view><h:form> <b>Personal Profile Information:</b><br> <h:panelGrid columns="2"> <h:outputText value="Name:"/> <h:inputText value="#{portlet.userSettings.name}"/> <h:outputText value="Age:"/> <h:inputText value="#{portlet.userSettings.age}"/> <h:outputText value="Height:"/> <h:inputText value="#{portlet.userSettings.height}"/> <h:outputText value="Weight:"/> <h:inputText value="#{portlet.userSettings.weight}"/> <h:outputText value="Nationality:"/> <h:inputText value="#{portlet.userSettings.nationality}"/> </h:panelGrid> <h:commandButton action="success" value="Submit" onclick="#{portlet.raiseEventJS['submitinfo']}"/></h:form></f:view>
这个简单的 JSP 允许用户首选项的值在表单提交时以 <input type="text">
标记的值的形式显示和设置。这是一种值绑定形式的引用,并允许 JSF 应用程序根据来自 servlet 的请求自动设置 Bean 属性的值,开发者无需编写任何请求处理代码。如果没有 PortletBean, JSF 应用程序就不得不创建 IPortletContext、IPortletRequest 和 IPortletResponse 对象,为每个用户选项设置检索设置值,再使用 JSP scriptlet 将其插入标记中,最后在服务器端处理类中对请求进行处理,处理类需要从请求中获取每个设置值,并手动将其设置到 IPortletResponse 中。这些请求处理代码将会硬化,如果需要添加更多首选项设置,将难以对其进行修改。
请注意 <h:commandButton>
标记。该标记有一个 onclick
属性值,可以引起 JavaScript PCC 事件,在门户页上的其他 portlet 中注册的 PCC 事件处理程序会捕捉该事件。在本例中, PortletBean 属性值解析为:
onclick="document.PCC.RaiseEvent ('urn:/plumtree.com/adaptiveportlets', 'submitinfo');"
有关使用 PortletBean EDK 属性或使用 PortletBean 生成客户端 JavaScript 的更多信息,请查看:附件 B:PortletBean API。
JSP 规范允许开发者定义自己的标记库,当 JSP 进行评估时,可以生成显示在 Web 应用程序中的自定义的 UI 组件。Java Portlet 工具的库提供了一组自定义的标记,允许开发者开发客户端自适型 Portlet 技术。通过在 JSP 页面中直接添加 taglib 的方法,可以向 JSP 页面添加自定义的标记库,例如:
<html><head> <title>Car Store</title></head><%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %><%@ taglib uri="http://plumtree.com/javaportlettools" prefix="portlet" %><body> ...</body></html>
URI http://plumtree.com/javaportlettools 用于识别唯一的 Java Portlet 工具标记库。在这个库中,您可以找到以下标记。(注意:单击左列中的链接,可能导致刷新浏览器并转到登录页。)
<portlet:group> | 用于在共享的名称空间中对多个 Protlet 进行分组的标记。这个名称空间将允许 Portlet 去引发和响应来自 Portlet 组中其他 Portlet 的 PCC 事件;还允许 Portlet 获取和设置会话的首选项供 Portlet 组的其他成员访问。. |
<portlet:raiseEvent> | 用于引发可以被其他 Portlet 捕获的 PCC 事件的标记。 |
<portlet:onEvent> | 用于定义 PPC 事件处理程序的标记。它将侦听指定的 PCC 事件,并激活一个事件处理函数或者标记中包含的自定义的 JavaScript。 |
<portlet:clickOnEvent> | PCC 事件处理程序标记,在捕获一个事件时激活标记内的某个元素。 |
<portlet:refreshOnEvent> | 一个 PCC 事件处理程序标记,在 Portlet 捕获一个事件时由它来执行当场刷新。刷新的 URL 即标记的 "url" 属性。这个事件处理程序标记可以刷新 Portlet 的内容,也可以将原处的刷新响应对象发送给一个事件处理函数。 |
<portlet:formRefreshOnEvent> | 一个 PCC 事件处理程序标记,捕获一个事件时在原处刷新后提交表单。这个事件处理程序标记可以刷新 Portlet 的内容,也可以将原处的刷新响应对象发送给一个事件处理函数。 |
<portlet:adaptivePortlet> | 一个用于将自适型 Portlet JavaScript 添加到 JSP 页面的特殊标记。它将复制脚本 include 的内容,PTPortletFilter (而不是 HTML 过滤器)的 PortletBean 附加的内容,该标记被用于不由 PTPortletFilter 处理的 JSP,或者不应该由过滤器处理的 Web 应用程序。 |
<portlet:unfiltered> | 由此标记围绕的任何响应内容将被 ResponseFilter 忽略。 |
<portlet:getSessionPref> | 为检索来自 PCC 的会话的首选项值生成 JavaScript。 |
<portlet:setSessionPref> | 为检索 PCC 事件上的会话的首选项值生成 JavaScript。 |
有些标记可以复制 PortletBean 提供的功能。例如,一位开发者在 JSF 应用程序中可以通过以下三种方法引发 PCC 事件:
<h:outputLink onclick="#{portlet.raiseEventJS['myevent']}"><h:outputLink onclick="<%= ((PortletBean) request.getAttribute("name")).raiseEventJS("myevent") %>"><a onclick="<portlet:raiseEvent eventname="myevent"/>">
复制此功能的原因在于:JSP 表达式语言仅支持 JSP 2.0 的自定义标记属性,而且 Scriptlet 非常不便于读写。许多 Web 应用程序框架都有意使开发人员避免在 JSP 中依赖 Scriptlet。Java Portlet 工具提供的自定义标记,使开发者在无法获取表达式语言或不能使用表达式语言时避开 Scriptlet。其他标记,如 <portlet:onEvent>
标记,不适合用作 PortletBean 属性,因为它们会生成大量而复杂的 JavaScript 和 HTML,还因为它们不能被用作其他标记的属性值。开发者可以参考“附录 C:常见问题”,以了解如何恰当地使用自定义标记和 PortletBean。
Java Portlet 工具包可以使开发者轻松地将 Web 应用程序转换为 Portlet。只需在 Web 应用程序的 web.xml
配置文件中添加一个过滤器,Java Portlet 工具包就可以重写 Web 应用程序的 HTML,使其高效地工作于门户环境中。这个过滤器可以根据 Web 应用程序的需要轻松地进行配置。另外,Java Portlet 工具包还提供了一组 JavaBean 和 JSP 标记,简化了 Java Web 应用程序的开发和对门户资源的访问。