配置 JSR 168 portlet

要配置 JSR 168 portlet,打开“Portlet 部署描述符”编辑器,从 Portlet 列表框中选择该 portlet,然后指定下列值。

表 1. Portlet 类
属性名 描述
Portlet 类 Portlet 列表框中选择的 portlet 的规范名称。选择浏览按钮以打开选择 Portlet 对话框并在部署描述符中创建新的映射。在 <portlet-class> 节点中使用。
表 2. 本地化部署描述符值
属性名 描述
语言 xml:lang 属性中用来本地化显示名称描述的语言环境信息。xml:lang 属性的缺省值是英语(en)。该属性名在 <portlet> 中的 xml:lang 属性的 <display-name><description> 中使用。
显示名称 用来标识 portlet 的管理名称。它仅显示在 GUI 工具中。在 <portlet> 中的 <display-name> 中使用。
描述 有关 portlet 的描述性文本。此文本不向最终用户显示。在 <portlet> 中的 <description> 中使用。
表 3. 特定语言的 portlet 信息
属性名 描述
资源束 要提供特定语言的 portlet 信息(如标题和关键字),请使用资源束。设置资源束的标准类名。在 <resource-bundle> 中使用。
受支持的语言环境 声明 portlet 在运行时支持的语言环境。在 <supported-locale> 中使用并用来找到每种语言环境的资源束文件。
Portlet 信息 指定有关每种受支持的语言环境的 portlet 信息。选择上面的受支持的语言环境并指定有关所选择的语言环境的 portlet 信息。指定的信息将保存在资源束文件中。
标题
应显示在此 portlet 的标题栏中的标题。每种语言环境只允许一个标题。注意,此标题可能被门户网站覆盖或被 portlet 以程序方式覆盖。对于缺省语言环境,在 <portlet-info> 中的 <title> 中使用;而对于其它语言环境,在特定语言的资源束文件中的 javax.portlet.title 中使用。
简短标题
简短标题,可用于有限显示能力的设备。每种语言环境只允许一个简短标题。对于缺省语言环境,在 <portlet-info> 中的 <short-title> 中使用;而对于其它语言环境,在特定语言的资源束文件中的 javax.portlet.short-title 中使用。
关键字
描述 portlet 的功能的关键字。允许用户根据关键字搜索 portlet 的门户网站可能使用这些关键字。每种语言环境允许多个关键字,但是必须用逗号(,)隔开。对于缺省语言环境,在 <portlet-info> 中的 <keywords> 中使用;而对于其它语言环境,在特定语言的资源束文件中的 javax.portlet.keywords 中使用。
表 4. 定义 portlet 方式支持
属性名 描述
受支持的方式 Portlet 处理它所支持的每种标记类型的 portlet 方式。所有 portlet 都必须支持“查看”portlet 方式。对于尚未声明为受给定标记支持的 portlet 方式,一定不能以该方式调用 portlet。portlet 容器将忽略对以下定制 portlet 方式的所有引用,该方式不受门户网站实现支持,或没有到门户网站支持的 portlet 方式的映射。
MIME 类型
portlet 支持的 MIME 类型。在 <supports> 中的 <mime-type> 中使用。
标记
portlet 支持的标记类型。在 <init-param> 中使用来定义属性:wps.markup。这是一种使 portlet 能够访问标记类型的 IBM® 扩展标记属性,这与 MIME 类型比起来,将会返回标记的更精确定义。例如,HTML 和 cHTML 都具有 MIME 类型 text/html,但是具有标记 html 和 chtml 会使 portlet 能够针对 HTML 和 cHTML 产生不同输出。有关此 IBM 扩展的更多信息,参阅 Developing portlets using JSR 168 and WebSphere® Portal V5.02
Portlet 方式
Portlet 可对 MIME 类型指定的标记类型进行处理的 portlet 方式。标准 portlet 方式(查看、编辑或帮助)。在 <supports> 中的 <portlet-mode> 中使用。
表 5. 初始化参数
属性名 描述
初始化 指定 portlet 的初始化参数。单击添加除去按钮来以名称/值对的形式添加或除去初始化参数。选择一个参数并单击编辑按钮来更新该参数及其值。在 <init-param> 中使用。
表 6. 可计划的安全性
属性名 描述
安全角色引用 指定安全角色引用。单击添加按钮、除去按钮或编辑按钮以添加、除去或更新安全角色引用。在 <security-role-ref> 元素中定义下列子元素。
角色名
一个字符串,它指定引用应用程序安全角色的角色的名称。Portlet 应该使用此角色名来确定是否将已认证的用户包括在应用程序安全角色中。在 <role-name> 中使用。
角色链接
一个字符串,它指定可能将用户映射到其中的应用程序安全角色的名称。必须在 Web 部署描述符中定义此安全角色。如果要指定一个已经在 Web 部署描述符中定义的安全角色,则可以从列表中选择它。在 <role-link> 使用。
语言
书写描述所用的语言。在 <description> 中用作 xml:lang
描述
关于此安全角色的描述性文本。在 <description> 中使用。
例如,要将安全角色引用 FOO 映射至角色名为 manager 的安全角色,在角色名字段中指定 FOO 并在角色链接字段中指定 manager。在此示例中,如果由某一属于 manager 安全角色的用户调用的 portlet 让 API 调用了 isUserInRole("FOO"),则结果将为 true

高速缓存

高速缓存内容帮助缩短用户的门户网站响应时间。它还有助于减少服务器上的负载。“Portlet 规范”定义基于到期的高速缓存机制。此高速缓存机制是每个用户客户机一个 portlet。一定不能在显示同一 portlet 的不同用户客户机之间共享高速缓存的内容。

在远程代理服务器用于高速缓存的环境中,符合 JSR 168 的 portlet 可能会指示高速缓存设置,服务器使用这些设置来确定在远程代理服务器上对页面进行高速缓存的方式。

表 7. 高速缓存
属性名 描述
到期高速缓存 定义基于到期的高速缓存机制。以下选择用来设置到期属性 <expiration-cache> 的值。
总是到期
对 portlet 禁用高速缓存。这将把到期属性设置为 0
从不到期
高速缓存未到期。这将把到期属性设置为 -1
在指定的秒数之后到期
到期高速缓存的持续时间(以秒计)。
远程高速缓存 还必须使用部署描述符扩展(ibm-portlet-portal-ext.xmi)提供其它设置。该 portlet 在扩展文件中使用 <remote-cache-scope> 元素来指示远程高速缓存是共享还是不共享
远程高速缓存动态
如果 portlet 窗口在运行时不修改高速缓存设置,则应该取消选择此复选框。此设置将优化性能,告诉 portlet 容器它不必等待 portlet 窗口发布远程高速缓存信息。此设置的缺省行为(选择该复选框)表示 portlet 窗口确实将发布远程高速缓存信息。
远程高速缓存作用域
共享指示远程高速缓存是共享的。

Portlet 首选项

通常将 Portlet 配置为向不同用户提供定制的视图或行为。此配置表示为一组持续的名称/值对,被称为 portlet 首选项。Portlet 首选项用于存储 portlet 的基本配置数据。portlet 首选项的目的不是用来替换一般用途的数据库。

属性名 描述
持久首选项库 指定 portlet 首选项。指定首选项中的元素。包括在 <preference> 属性中。
名称
首选项的名称。在 <preference> 中的 <name> 中使用。
首选项的初始缺省值。在 <preference> 中的 <value> 中使用。
只读
选择只读复选框以在部署时修改此首选项。如果未选择它,则当 portlet 以任何标准 portlet 方式(查看、编辑或帮助)处理操作请求时,此首选项是可修改的。此选择将把 <preference> 中的 <read-only> 元素设置为 true。
选择首选项验证器类
验证器类
指定一个类,它实现 PreferencesValidator 接口以验证 PortletPreferences 对象中的首选项值集。编辑验证器类字段或单击浏览按钮以选择首选项验证器。在 <portlet-preferences> 属性中的 <preference-validator> 属性中使用。
相关概念
Portlet API
创建 portlet 和 portlet 项目
使用 portlet 部署描述符
相关任务
创建、添加、除去或编辑 portlet
定义 portlet 安全约束
定义定制的 portlet 方式
定义定制的窗口状态
定义用户属性
定义扩展
相关参考
参考

(C) Copyright IBM Corporation 2002, 2005. All Rights Reserved.