Java Portlet Tools：将 Java Web 应用转换为适应性 Portlet

标签中，使 portlet 能够执行随处刷新请求。 更改所有表单提交按钮以执行随处刷新表单 post。 更改指向 Web 应用资源的所有超级链接，以执行随处刷新 get 请求。
PTPortletFilter 通过将以下 XML 添加到 Web 应用的 web.xml 配置文件来声明：
Adaptive Portlet Filter com.plumtree.remote.filter.PTPortletFilter filter.config.file C:\portlettools\apps\carstore\conf\custom-filter.xml filter.log.file C:\portlettools\apps\carstore\logs\jpt.log filter.log.level debug jsxml.version 177643 portal.imageserver.alternate https://plumtree/imageserver Adaptive Portlet Filter *.jsp
所有筛选器初始化参数都是可选的，如果您不想执行任何筛选器日志记录或自定义操作，则只需添加 filter 类和 URL 映射即可。对于较复杂的门户配置，您可能需要添加备用的imageserver 或日志记录初始化参数。PTPortletFilter 识别的初始化参数如下：
参数 描述 默认值
filter.config.file 指向定义嵌套操作树的 XML 文件，PTPortletFilter 根据 Web 应用的响应 HTML 执行这些嵌套操作。Java Portlet Tools 筛选器提供一个已针对 JSF 应用测试过的sample filter.xml。此样本文件对大多数 Java Web 应用框架都可用；但它是可以配置的，如有必要，还允许开发人员添加新的 HTML 重写操作。有关如何自定义此 XML 文件的详细说明，请参阅附录 A：PTPortletFilter 配置 XML。此参数应仅在执行自定义筛选器操作时指定。 portlet-tools.jar 中包含的默认 filter.xml 文件。
filter.log.file 此参数指定筛选器重写日志记录信息的文件的绝对路径。 stdout
filter.log.level 筛选器执行的日志记录的级别。可能的值包括：debug、info、warning、severe、error 和 off。 warning
jsxml.version Plumtree JSXML JavaScript 组件的版本，该版本使随处刷新在 Plumtree Portal 中成为可能。此值是指 Web 应用将优先使用的 JSXML JavaScript 库的版本。JSXML 是 G6 Scripting Framework 底层的 AJAX 框架。 JSXML 的最新版本
portal.imageserver.alternate 允许开发人员在加入 JSXML JavaScript 组件时使用指定 URL 连接到imageserver。如果门户的imageserver有安全限制，阻止 Web 应用直接访问它，则必须使用此参数。 –
content.type 设置 HTTP 响应的内容类型 text/html;charset=UTF-8
character.encoding 设置 HTTP 响应中使用的字符集。 UTF-8
有关 PTPortletFilter 如何重写响应 HTML 的示例，请看表单中的一个简单提交按钮：
...
如果不作修改，此按钮将导致整个门户页提交，并只对单击了按钮的 portlet 返回内容，从而使该 portlet 接收门户页的全部内容。但是，PTPortletFilter 会重写标签，以使用随处刷新：

...

指向 Web 应用资源（且目的是刷新当前页）的超级链接将被重写，从而使它们能够执行随处刷新请求。例如，在以下链接中：
Link in this window Link in another window Link to another site
只有第一个链接会导致门户出现问题。像上面的表单示例一样，单击此链接会使该 portlet 接收整个门户页的内容。只有此链接会被重写，以执行随处刷新请求。
Link in this window Link in another window Link to another site
最后，Web 应用中按计划提交表单的所有 JavaScript 都会被重写，以执行随处刷新。所有引用表单的 JavaScript 都会被重写，以根据含有追加的 portlet ID 的唯一 ID 引用表单。
当 Web 应用被视为单机 Web 应用而非 portlet 中的远程 Web 服务时，PTPortletFilter 会被禁用。如果通过门户的网关运行 Web 应用中的某个页面并在 portlet 中显示，则 PTPortletFilter 将按原样显示该 Web 应用的 HTML 内容。
PortletBean
Java Portlet Tools 提供一种专门的 JavaBean， 供 JSP scriptlets 和 JSP 表达式语言使用。有关 JSP 表达式语言如何工作的详细信息，请参阅Sun 的 JSP 文档。PortletBean 是 EDK 和客户端 portlet API 功能的 JavaBean 包装器。它为以下各项提供属性的 getter 和 setter 方法：
Portlet、Community和页面 ID，imageserver URL，stylesheet URL 等 Portlet 首选项设置（例如 Admin、Community 和 User） 为触发 PCC 事件或设置会话首选项等操作生成适应性 portlets JavaScript
此 bean 使用属性名“portlet”自动连接到通过 PTPortletFilter 的每个 ServletRequest。开发人员可通过 PortletBean 引用 EDK 方法值，而不必在 JSP 的 scriptlet 中构建 IPortletContext 和 IPortletRequest 对象。这看似只是 JavaBean 语法中已有的包装功能，但在 Java Web 应用中，PortletBean 可以用来实现强大的功能。例如，假设 JSF Web 应用开发人员想要创建一个个人资料 portlet，该 portlet 可以设置用户首选项并触发 PCC 事件，通知其它已设置首选项的portlet。JSP 页中的标记将为如下所示：
Personal Profile Information:

这一简单的 JSP 将使用户首选项值显示为 标签的值并在提交表单后即设置成功。这被称为值绑定（value binding），它使 JSF 应用自动从 servlet 请求中设置 bean 属性值，而无需开发人员编写任何请求处理代码。如果没有 PortletBean，则 JSF 应用必须创建 IPortletContext、IPortletRequest 和 IPortletResponse 对象，检索每个设置的设置值并使用 JSP scriptlet 将其插入到输入标签中，最后在服务器端的 handler 类中处理请求，而该类必须从请求获取每个设置值并将其手动设置到 IPortletResponse。此请求处理代码毫无疑问将是硬骗码，如果需要更多首选项设置时，将很难修改。
另请注意 标签。此标签有一个 onclick 属性值，该值触发可被门户页面中其它 portlet 中的注册 PCC 事件处理程序捕捉的 JavaScript PCC 事件。在本例中，PortletBean 属性解析为：
onclick="document.PCC.RaiseEvent (‘urn:/plumtree.com/adaptiveportlets‘, ‘submitinfo‘);"
有关使用 PortletBean EDK 属性或使用 PortletBean 来生成客户端 JavaScript 的详细信息，请参见：附录 B：PortletBean API。
Java Portlet Tools 标签
JSP 规范允许开发人员定制自定义标签库，当 JSP 评估时，这些标签库可以生成自定义 UI 组件显示在 Web 应用中。Java Portlet Tools 库提供一组自定义标签，使开发人员能利用客户端适应性 portlet 技术。通过在 JSP 页添加 taglib 指令，即可将自定义标签库添加到 JSP 页面中，例如：
<%@ taglib uri="http://java.sun.com/jsp/jstl/core" prefix="c" %> <%@ taglib uri="http://plumtree.com/javaportlettools" prefix="portlet" %> ...
http://plumtree.com/javaportlettools URI 用于唯一地标识 Plumtree Java Portlet Tools 标签库。在此库中，您可找到以下标签。（注意：单击下面左边栏中的链接后，可能需要刷新浏览器才能访问登录页面。）
用于在共享名称空间中将多个 portlet 分组的标签。此名称空间允许 portlet 触发 PCC 事件或响应来自 portlet 组中其它 portlet 的 PCC 事件，同时允许 portlet 获取和设置 portlet 组可访问的会话首选项。
触发 PCC 事件的标签，该事件可被其它 portlet 捕捉。
定义 PCC 事件处理程序的标签。该标签会侦听特定 PCC 事件并调用包含在标签中的处理程序函数或自定义 JavaScript。
PCC 事件处理程序标签，在捕获事件时会单击其标签之间的任何元素。
在捕获事件时会对 portlet 内容进行随处刷新的 PCC 事件处理程序标签。刷新 URL 设置为标签的“url”属性。此事件处理程序标签可以刷新 portlet 内容或将随处刷新响应对象发送到处理程序函数。
在捕获事件时会使用随处刷新 post 提交表单的 PCC 事件处理程序标签。此事件处理程序标签可以刷新 portlet 内容或将随处刷新响应对象发送到处理程序函数。
用来将适应性 portlet JavaScript 包含到 JSP 页中的特殊标签。它会复制脚本的 include 和 PTPortletFilter 的 PortletBean 附件（但不是 HTML 筛选），用于 PTPortletFilter 不处理的 JSP 或不应由筛选器处理的 Web 应用。
这些标签内的所有响应内容都会被 ResponseFilter 忽略。
生成从 PPC 上检索会话首选项值的 JavaScript。
生成在 PPC 上设置会话首选项值的 JavaScript。
有些标签与 PortletBean 提供的功能重复。例如，在一个 JSF 应用中，开发人员可以通过三种不同的方式触发 PCC 事件：
"> ">
功能重复的原因是，JSP 表达式语言只能在 JSP 2.0 标签的自定义标签属性中起作用，而 scriptlets 读写太麻烦。许多 Web 应用框架特别阻止用户在其 JSP 中依赖 scriptlet。Java Portlet Tools 提供的自定义标签允许开发人员在没有或不能使用表达式语言的情况下避免使用 scriptlet。其它标签，如 标签，不适合作为 PortletBean 属性使用，因为它们会生成大量复杂的 JavaScript 和 HTML，或者因为它们不是用来在其它标签中作为属性值使用的。开发人员应参考“附录 C：常见问题”以了解何时使用自定义标签和 PortletBean。
总结
Java Portlet Toolkit 使 Web 应用能够轻松转换为 portlet。只要在 Web 应用的 web.xml 配置文件加上筛选器，Java Portlet Toolkit 就会重写 Web 应用 HTML，使之能在门户环境中有效运行。此筛选器可根据特定 Web 应用的需求方便地进行配置。此外，Java Portlet Toolkit 还提供一组 JavaBean 和 JSP 标签，使 Java Web 应用的开发和对门户资源的访问更为简单。
参考
Java Portlet Tools 二进制和源码文件J2EE 1.4 教程Java Portlet Tools 安装指南Java Portlet Tools API 文档Java Portlet Tools 标签库文档样本 PTPortletFilter 配置 XML
附录 A： PTPortletFilter 配置 XML
PTPortletFilter 事实上是一种更通用的ResponseFilter 类的子类，该类也执行 HTTP 响应文本（不一定是 HTML）筛选，并且不依赖 HttpServletRequest 的网关。PTPortletFilter 逐行修改 HTML，意味着它一次只执行一行，而不是整个 HTML 响应。但当 HTML 标签跨越多行时例外，例如：
Choose Locale
在本例中，PTPortletFilter 会将标签所跨越的所有行当作单个 HTML 行进行筛选。
PTPortletFilter 在启动时会加载一个 XML 配置文件，该文件定义 PTPortletFilter 对被筛选的 Web 应用的响应 HTML所执行的筛选操作。除以上配置文件中定义的筛选操作外，PTPortletFilter 还执行几项其它功能：
修改 HTML,使对

标签的数组引用转换为具体的 ID 引用。 将 PortletBean 附加到每个 HttpServletRequest 对象。 以有用的值（如portlet ID 和管理首选项）填充令牌名称/值对映射（Map），用于筛选操作。
筛选器的配置 XML 定义了两组可对响应 HTML执行操作的对象：FilterAppender 和 FilterOperation。
FilterAppender
FilterAppender 是将 HTML 附加到响应 HTML开头和末尾部分的 Java 类。由于此操作只对每次请求执行一次，因此与使用FilterOperation 在响应的开头和末尾插入 HTML相比，定义一个类来执行此步骤更有效率，这是由于FilterOperation 会对响应 HTML 的每一行执行操作。Appender 是通过引用生成 appender 的类在配置 XML 文件中进行声明的。
...
在实例化时，Appender 都调用同一 init() 函数，该函数取 PTPortletFilter 的 FilterConfig 作为参数。这样，appender 就可以访问在定义筛选器的 web.xml 中设置的所有初始化参数。
PTPortletFilter 在没有 appender 类的情况下也可运行，但我们定义了一个有用的 appender，它允许 Java Web 应用框架在门户环境内部能运行：AdaptivePortletAppender。此appender附加了JSXML JavaScript组件，它允许从Web应用程序中发出随处刷新请求。AdaptivePortletAppender 使用 JSRegistry 与 imageserver 联系，并生成应包含在页面中的JavaScript文件清单，以实例化客户端 JavaScript 中的 JSXML 对象。此外，AdaptivePortletAppender 还添加了几个简化的功能，使随处刷新请求更容易生成。最后，appender 将 Web 应用生成的内容包装在具有唯一 ID pt-portlet-java-[portletID] 的

标签中。每次用户启动随处刷新请求时，该唯一 ID 就用作目标 HTML 要素；而此

标签中的内容将被响应取代。
FilterOperation
PTPortletFilter 配置 XML 定义的第二种对象是FilterOperation 子类。每个 FilterOperation 子类代表一个将对文本的每一行执行的特定文本处理操作。FilterOperation 都构建在操作树中，使特定操作只有在其父操作成功时才会发生。以下是操作 XML 的例子：
title TITLE ]*> i body onload BODYONLOAD body bgcolor BODYBGCOLOR BODYBGCOLOR ]*>

<(/ )body i ...
提供了几种类型的 FilterOperation。筛选器操作通过调用 excecute 方法执行，该方法使用两个自变量：来自 HTTP 响应 HTML 的文本的下一行文本，以及包含名称/值对的映射,这些名称/值对可用来替换找到的令牌。在执行该操作的过程中，可能会向令牌“映射”里添加新的值或删除一些值，文本行也可能在传递到树中的下一操作之前被更改。令牌是通过以“@”字符包围令牌值名称来定界的，如 @TOKEN@。令牌可用于各种筛选器操作值，也可以用作存储处理响应 HTML 时收集的数据的变量；例如，可创建一个令牌来存储有关响应 HTML 是否使用了