创建上下文处理器类

配置上下文处理器插件后,此插件将由 Web 内容查看器 Portlet 在呈示之前启动,并且允许修改当前上下文(例如,要显示的项)。

关于此任务

要创建上下文处理器插件,您必须创建上下文处理器类,然后通过将该类部署到服务器并从 Web 内容查看器 Portlet 中选择该类来注册该类。

过程

  1. 创建一个实现了接口 com.ibm.workplace.wcm.api.ContextProcessor 的 Java 类。 此类必须实现以下方法:
    /**
        * Processes the supplied <i>ContextProcessorParams</i> and updates parameters within
        * as necessary
        * 
        * @param p_currentSession The current Http Session
        * @param p_contextProcessorParams The editable <i>ContextProcessorParams</i> object 
        */
       public void process(HttpSession p_currentSession, ContextProcessorParams p_contextProcessorParams);

    请参阅 Javadoc 文档以获取更多信息。Web Content Manager 的 Javadoc 文件位于 PortalServer_root/doc/Javadoc/spi_docs/com/ibm/workplace/wcm 目录中。

  2. 实现 process 方法。此方法包含在启动该插件时要运行的代码,并且在呈示当前上下文之前使用 ContextProcessorParams 对象修改当前上下文。
  3. 无论您使用 WAR 或 EAR 文件还是使用松散 JAR 文件来完成部署,都需要 plugin.xml 文件。如果已使用 WAR 或 EAR 中的应用程序进行了部署,请将 plugin.xml 文件包含在该应用程序的“WEB-INF”文件夹中。使用 JAR 文件时,请将 plugin.xml 包含在该 JAR 文件的根目录中。
    <?xml version="1.0" encoding="UTF-8"?>
    <plugin id="SampleContextProcessorPluginId" 
    name="SampleContextProcessor" provider-name="IBM" version="1.0.0">
        <extension point="com.ibm.workplace.wcm.api.ContextProcessor" 
        id="SampleContextProcessorPlugin" >
            <processor class="com.acme.SampleContextProcessor"/>
        </extension>
    </plugin>
  4. 编辑要与上下文处理器相关联的 Web 内容查看器 Portlet 的设置:
    1. 转到 Web 内容查看器 Portlet 的“配置”或“编辑共享设置”视图。
    2. 转到高级选项 > 插件
    3. 选择上下文处理器插件。

下一步做什么

  • 每个插件都由单个 <extension></extension> 标记表示。
  • point 属性的值必须为“com.ibm.workplace.wcm.api.ContextProcessor”。
  • 提供您选择的标识值。
  • 指定插件的提供者类。
命名约定:
如果创建的新插件应用程序与现有插件具有相同的名称和标识,那么新插件可能会覆盖现有插件。创建插件应用程序时,请确保以下各项在系统中是唯一的:
  • 插件标识、插件名称以及 plugin.xml 文件的扩展名标识。
  • 应用程序中的所有类的标准类名及路径。
  • 应用程序中的所有文件的文件路径。