AEM门户和Portlet aem-portals-and-portlets

本文档介绍以下内容：

AEM Portal架构 aem-portal-architecture

AEM门户架构包括门户和portlet的定义。

什么是门户？ what-is-a-portal

门户是一个Web应用程序，它提供个性化、单点登录、来自不同来源的内容集成，并托管信息系统的表示层。

您可以在AEM中运行符合JSR 286的portlet。 Portlet组件允许您在页面上嵌入Portlet。 请参阅 管理AEM内容Portlet.

什么是portlet? what-is-a-portlet

Portlet是部署在容器内的Web组件，用于生成动态内容。 Portlet接口被打包并部署为Portlet容器内的.war文件。 如果您将AEM作为门户运行，则需要Portlet的.war文件来运行Portlet。

要将AEM内容配置为显示在门户中，请参阅 在portlet中安装、配置和使用AEM.

AEM Portal Director aem-portal-director

管理AEM内容Portlet administering-the-aem-content-portlet

通过AEM内容portlet，您可以在门户中显示AEM内容。 Portlet在 /crx-quickstart/opt/portal、和的自定义方式。 例如，您可以通过部署您自己的身份验证服务来生成AEM覆盖默认行为所需的身份验证信息，从而自定义SSO/身份验证处理。 插件使用定义的API，通过该API，您可以根据API构建插件，以添加自己的功能。 该插件可以部署到正在运行的portlet中。 要正常运行，需要配置AEM创作和发布实例以及内容路径，才能在启动时显示。

某些配置可以通过portlet首选项进行更改，而其他配置则通过OSGi服务配置进行更改。 您可以使用 配置 文件或OSGi Web控制台。

Portlet首选项 portlet-preferences

可以在部署时在门户服务器中或通过编辑 WEB-INF/portlet.xml 文件。 默认情况下，portlet.xml文件如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<portlet-app xmlns="https://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd"
             xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
             xsi:schemaLocation="https://java.sun.com/xml/ns/portlet/portlet-app_1_0.xsd /opt/SUNWps/dtd/portlet.xsd"
             version="1.0">
   <portlet>
      <portlet-name>RSSWeatherPortlet</portlet-name>
      <portlet-class>org.jboss.portlet.weather.WeatherPortlet</portlet-class>
      <init-param>
         <name>default_zipcode</name>
         <value>05673</value>
      </init-param>
      <init-param>
         <name>RSS_XSL</name>
         <value>/WEB-INF/Rss.xsl</value>
      </init-param>
      <init-param>
         <name>base_url</name>
         <value>https://xml.weather.yahoo.com/forecastrss?p=</value>
      </init-param>
      <expiration-cache>180</expiration-cache>
      <supports>
         <mime-type>text/html</mime-type>
         <portlet-mode>VIEW</portlet-mode>
         <portlet-mode>EDIT</portlet-mode>
      </supports>
      <portlet-info>
         <title>Weather Portlet</title>
      </portlet-info>
      <portlet-preferences>
         <preference>
            <name>expires</name>
            <value>180</value>
         </preference>
         <preference>
            <name>RssXml</name>
            <value>https://xml.weather.yahoo.com/forecastrss?p=33145</value>
            <read-only>false</read-only>
         </preference>
      </portlet-preferences>
   </portlet>
</portlet-app>

Portlet可以使用以下首选项进行配置：

OSGi Web控制台 osgi-web-console

假定门户服务器在主机localhost上运行，端口8080，并且AEM portlet Web应用程序在Web应用程序上下文中装载 cqportlet，则web控制台的url为 http://localhost:8080/cqportlet/cqbridge/system/console. 默认的用户和密码为 管理员.

打开 配置 选项卡，选择 门户目录CQ服务器配置. 在此，您可以指定作者和发布实例的基本URL。 此过程在 配置Portlet.

提供配置 providing-configurations

为了支持自动部署和配置配置配置，AEM内容portlet具有内置配置支持，该配置支持尝试从提供给portlet应用程序的类路径中读取配置。

启动时，系统属性 com.day.cq.portet.config 读取以检测当前环境。 通常，此属性的值类似于 开发, prod, 测试 等等。 如果未设置环境，则不会读取任何配置。

如果设置了环境，则会在类路径* *中搜索配置文件​ com/day/cq/portlet/{env}.config where env 替换为环境的实际值。 此文件应列出此环境的所有配置文件。 这些文件会相对于配置文件的位置进行搜索。 例如，如果文件包含行 my.service.xml, 此文件从位于的类路径中读取 com/day/cq/portlet/my.service.config. 文件的名称由服务的持久性ID组成，后跟 .config. 在上一个示例中，持久性ID为 my.service. 配置文件的格式是Apache Sling OSGi安装程序使用的格式。

这意味着，对于每个环境，都需要添加相应的配置文件。 需要在所有这些文件中输入应用于所有环境的配置 — 如果只适用于单个环境，则只需在该文件中输入。 此机制可确保完全控制在哪个环境中读取哪个配置。

可以使用不同的系统属性来检测环境。 指定系统属性 com.day.cq.portet.configproperty 包含要使用的系统属性的名称，而不是 com.day.cq.portet.config.

缓存和缓存失效 caching-and-caching-invalidation

Portlet在其默认配置中，将从AEM WCM收到的响应缓存到用户特定的缓存中。 当发布实例的内容发生更改时，缓存需要失效。 为此，在AEM WCM中，必须在创作实例上配置复制代理。 也可以手动刷新缓存。 本节将介绍这两个过程。

Portlet可以使用其自己的缓存进行配置，以便Portlet中的内容显示而无需访问AEM。 该门户在/libs/portal/director中以内容形式提供。 要访问内容，请启动AEM实例，然后使用CRXDE Lite或Webdav从该位置下载文件。

您可以在运行时部署此包，也可以将其添加到Portlet Web应用程序中 WEB-INF/lib/resources/bundles 部署之前。

部署缓存后，Portlet会缓存发布实例中的内容。 使用AEM的调度程序刷新，Portlet缓存可以失效。 要配置Portlet以使用其自己的缓存，请执行以下操作：

通过复制代理刷新缓存 flushing-the-cache-via-replication-agent

与正常的调度程序失效一样，复制代理也可以配置为定向门户的AEM portlet缓存。 配置复制代理后，每次常规页面激活都会刷新门户缓存。

如果运行AEM Portlet的多个门户节点，则需要为每个节点创建一个代理，如此过程中所述。

要为门户配置复制代理，请执行以下操作：

手动刷新Portlet缓存 manually-flushing-the-portlet-cache

您可以通过访问为复制代理配置的相同URL来手动刷新Portlet缓存。 请参阅 刷新缓存 （对于URL的形式）。 此外，还需要使用URL参数Path=扩展URL<path> 以指示要刷新的内容。

例如：

https://10.0.20.99:10040/wps/PA_CQ5_Portlet/cqbridge/cqpcache?Path=* 刷新完整缓存。 https://10.0.20.99:10040/wps/PA_CQ5_Portlet/cqbridge/cqpcache?Path=/content/mypage/xyz 刷新 /content/mypage/xyz 从缓存中。

门户安全 portal-security

入口是驱动认证机制。 您可以与技术用户、门户用户、组等登录AEM。 Portlet无权访问门户中用户的密码，因此，如果Portlet不知道要成功登录用户的所有凭据，则必须使用SSO解决方案。 在这种情况下， AEM Portlet会将所有必需的信息转发给AEM，而又会将此信息转发给基础AEM存储库。 此行为可插拔，并可进行自定义。

发布时身份验证 authentication-on-publish

本节介绍Portlet在与基础AEM WCM实例通信时可使用的身份验证模式。

默认情况下，不会向AEM的发布实例发送用户信息；内容始终显示为匿名用户。 如果应从AEM传递用户特定信息，或者如果需要对发布进行用户身份验证，则必须启用此设置。

访问Portlet的身份验证配置 accessing-the-portlet-s-authentication-configuration

Portlet在AEM WCM实例中使用的身份验证配置选项在Web控制台中可用（OSGi配置）。

要访问Portlet的身份验证配置，请执行以下操作：

技术用户模式 technical-user-mode

在默认模式下，Portlet为AEM WCM创作实例发出的所有请求都使用相同的技术用户进行身份验证，而不考虑当前的门户用户。 默认情况下，“技术用户”模式处于启用状态。 在OSGi管理控制台的相应配置屏幕中启用/禁用此模式：

指定的技术用户必须存在于AEM WCM创作实例和发布实例(如果 发布时验证 启用。 确保为用户授予足够的访问权限，以便进行创作工作。

单点登录 sso

Portlet支持开箱即用的AEM SSO。 验证器服务可以配置为使用SSO并以格式传输当前门户用户 基本 作为名为的Cookie cqpsso 到AEM。 AEM应配置为对路径/使用SSO身份验证处理程序。 此处还需要配置Cookie名称。

的 crx-quickstart/repository/repository.xml 对于AEM存储库，需要相应地配置：

<LoginModule class="com.day.crx.security.authentication.CRXLoginModule">
  ...
  <param name="trust_credentials_attribute" value="TrustedInfo"/>
  <param name="anonymous_principal" value="anonymous"/>
</LoginModule>

SSO身份验证模式 sso-authentication-mode

Portlet可以使用单点登录(SSO)方案来验证AEM WCM。 在此模式下，当前登录到门户的用户将以SSO Cookie的形式转发到AEM WCM。 如果使用SSO模式，则对AEM Portlet具有访问权限的所有门户用户都必须知晓基础AEM WCM实例，通常以AEM WCM连接到LDAP的形式，或通过事先手动创建用户的方式。 此外，在portlet中启用SSO之前，基础AEM WCM创作实例(以及发布实例，如果 发布时验证 启用)需要配置为接受基于单点登录(SSO)的请求。

要配置Portlet以使用SSO身份验证模式，请完成以下步骤（在以下各节中有详细描述）：

使AEM WCM的存储库接受可信凭据 enabling-aem-wcm-s-repository-to-accept-trusted-credentials

在为AEM WCM启用SSO之前，需要将基础存储库配置为接受AEM WCM提供的可信凭据。 要实现此目的，请配置AEM repository.xml。

在AEM WCM中启用SSO身份验证 enabling-sso-authentication-in-the-aem-wcm

要在AEM WCM中启用SSO，请访问AEM WCM的Apache Felix Web管理控制台(OSGi)中的相关配置条目：

对于AEM WCM收到的每个请求，首先尝试基于SSO的身份验证。 失败时，将执行回退到通常的基本身份验证方案。 因此，与AEM WCM（不使用单点登录）的正常连接仍然可能。

在AEM Portlet中启用SSO身份验证 enabling-sso-authentication-in-a-aem-portlet

为了使基础AEM WCM实例接受SSO请求，必须切换Portlet的身份验证模式 技术 to 单点登录.

要在AEM Portlet中启用SSO身份验证，请执行以下操作：

执行此过程后，请求将使用SSO进行身份验证。 HTTP通信中的典型代码片段显示存在以下特定于SSO和Portlet的标头：

C-12-#001898 -> [GET /mynet/en/_jcr_content/par/textimage/image.img.png HTTP/1.1 ]
C-12-#001963 -> [cq5:locale: en ]
C-12-#001979 -> [cq5:used-locale: en ]
C-12-#002000 -> [cq5:locales: en,en_US ]
C-12-#002023 -> [cqp:user: wpadmin ]
C-12-#002042 -> [cqp:portal: IBM WebSphere Portal/6.1 ]
C-12-#002080 -> [cqp:windowid: 7_CGAH47L000CE302V2KFNOG0084 ]
C-12-#002124 -> [cqp:windowstate: normal ]
C-12-#002149 -> [cqp:portletmode: view ]
C-12-#002172 -> [User-Agent: Jakarta Commons-HttpClient/3.1 ]
C-12-#002216 -> [Host: 10.0.0.68:4502 ]
C-12-#002238 -> [Cookie: $Version=0; cqpsso=Basic+d3BhZG1pbg%3D%3D ]
C-12-#002289 -> [ ]

启用PIN身份验证 enabling-pin-authentication

如果您没有使用AEM内容portlet的默认内联编辑功能，而是希望门户之外的创作和管理部分直接在AEM创作实例中使用，则应该启用PIN身份验证。 您还需要更改管理按钮的配置。

要打开网站管理页面或从portlet编辑页面，AEM内容portlet使用新的pin身份验证。 默认情况下，PIN身份验证处于禁用状态，因此必须在AEM中进行以下配置更改：

特权 privileges

Portlet的某些功能受权限保护。 当前用户需要具有此权限才能访问此函数。 预定义了以下权限：

管理权限的最佳方法是使用门户角色并为这些权限分配角色。 这可以通过OSGi配置来完成。 可以为“Day Portal Director权限管理器”配置每个权限的一组角色。 如果用户具有其中一个角色，则用户具有相应的权限。

此外，还可以根据每个portlet实例库的访问来定义此角色。 Portlet的“首选项”对话框包含用于上述每种权限的输入字段。 对于每个权限，可以配置以逗号分隔的portlet角色列表。 如果配置了值，则它将覆盖“Day Portal Director Privilege Manager”服务中的全局配置，并且在角色未合并时可能需要从此全局设置中添加相同的角色！ 如果未指定任何值，则使用全局配置。

自定义AEM Portlet应用程序 customizing-the-aem-portlet-application

提供的AEM portlet应用程序会像AEM一样在Web应用程序内启动OSGi容器。 此架构让您能够利用OSGi的所有优势：

工具栏按钮 toolbar-buttons

工具栏及其按钮是可配置的，并可进行自定义。 您可以在工具栏中添加自己的按钮，或定义在哪种模式下显示的按钮。 每个按钮都是可通过OSGi配置配置的OSGi服务。

OSGi Web控制台列出了 配置 选项卡。 对于每个按钮，您可以定义此按钮在哪种模式下显示。 例如，您可以通过删除所有模式来禁用按钮。

默认情况下， AEM内容portlet使用内联编辑功能。 但是，如果您希望切换到AEM创作实例进行编辑，请启用 SiteAdmin按钮 和 “内容查找器”按钮，但禁用 编辑按钮. 在这种情况下，请确保在AEM中正确配置PIN身份验证。

可以通过Portlet的Felix Web控制台安装包来自定义Portlet的工具栏布局，该包包含预定义位置的自定义CSS/HTML。

束结构 bundle-structure

以下是包结构示例：

$ jar tvf target/toolbarlayout-0.0.1-SNAPSHOT.jar | awk '{print $8}'
META-INF/
META-INF/MANIFEST.MF
/com/day/cq/portlet/toolbar/layout/
/com/day/cq/portlet/toolbar/layout/author.gif
/com/day/cq/portlet/toolbar/layout/back.gif
/com/day/cq/portlet/toolbar/layout/button.html
/com/day/cq/portlet/toolbar/layout/edit.gif
/com/day/cq/portlet/toolbar/layout/manage.html
/com/day/cq/portlet/toolbar/layout/publish.html
/com/day/cq/portlet/toolbar/layout/refresh.gif
/com/day/cq/portlet/toolbar/layout/siteadmin.gif
/com/day/cq/portlet/toolbar/layout/toolbar.css

META-INF文件夹包含OSGi将其标识为包所需的MANIFEST.MF文件。 显示如下：

Manifest-Version: 1.0
Built-By: djaeggi
Created-By: Apache Maven Bundle Plugin
Import-Package: com.day.cq.portlet.toolbar.layout
Bnd-LastModified: 1234178347159
Export-Package: com.day.cq.portlet.toolbar.layout
Bundle-Version: 0.0.1.SNAPSHOT
Bundle-Name: Company CQ5 Portal Director Portlet Toolbar Layout
Bundle-Description: This bundle provides a custom layout for the CQ5 P
 ortal Director Portlet Toolbar.
Build-Jdk: 1.5.0_16
Bundle-ManifestVersion: 2
Bundle-SymbolicName: com.day.cq.portlet.company.toolbarlayout
Tool: Bnd-0.0.255

HTML/CSS/图像位于/com/day/cq/portlet/toolbar/layout文件夹内，这一事实是Portlet强制要求的，不能更改。 同样，MANIFEST.MF中的Import-Package和Export-Package标头也必须称为/com/day/cq/portlet/toolbar/layout。 Bundle-SymbolicName必须是唯一且完全限定的包名称。

您可以使用Maven之类的工具来构建该文件，也可以手动创建此类jar文件，并设置相关标头，如此部分所示。

Portlet工具栏视图 portlet-toolbar-views

Portlet的工具栏基本上有两种视图状态。 每个视图和关联的按钮都可以使用相应的HTML文件进行自定义。

发布视图 publish-view

发布视图只有一个按钮，可将工具栏切换到管理视图。 发布视图由 上一包. 在HTML中，您可以使用以下占位符，在呈现时，这些占位符将由portlet替换为相应的内容：

发布视图占位符 publish-view-placeholders

管理视图 manage-view

“管理”视图包含四个按钮：“编辑”、“网站”选项卡、“刷新”和“返回”。 管理视图由 上一包. 在HTML中，您可以使用以下占位符，在呈现时，这些占位符将由portlet替换为相应的内容：

管理视图占位符 manage-view-placeholders

按钮 buttons

按钮在显示的任何视图上，都使用在button.html中定义的相同通用HTML。

在HTML中，您可以使用以下占位符，在呈现时，这些占位符将由portlet替换为相应的内容：

管理和发布视图按钮 manage-and-publish-view-buttons

button.html文件的示例：

<div class="cqp_button">

 <a href="#" onclick="{onclick}">

 <img src="/wps/PA_CQ5_Portlet/cqbridge/static/{id}.gif" alt="{text}"
title="{text}"/>

 </a>
</div>

安装自定义布局 installing-a-custom-layout

要安装自定义布局，请访问Portlet的OSGI Web控制台 包 部分并上传包。

包 packages

如果您需要上传或创建安装软件包，请参阅AEM文档中的包管理器以了解详细说明。

链接处理 link-handling

所有链接都将被重写，以便在Portal上下文中工作。 默认情况下，会使用带有呈现参数的链接。 可以将门户DirectorHTML重写器配置为改用操作链接。

您还可以定义要查询的其他请求参数以查看要显示的内容路径。 例如，如果存在从外部到特定内容的链接，则此操作非常有用。

此外，可以为门户DirectorHTML重写器配置定义的排除链接重写的正则表达式列表。 例如，如果您具有与外部系统的相对链接，则应将其添加到此排除列表。

本地化 localization

AEM内容portlet具有内置的本地化功能，可确保AEM中的内容使用正确的语言。

可分两步完成此操作：

可以为门户Director区域设置处理程序配置用于检查区域设置信息的路径 — 通常，这包括 /content 和路径中区域设置信息的位置。 默认情况下，区域设置处理程序遵循在AEM中构建多语言站点的重新通用化。

如果您的站点没有用于处理路径中区域设置信息的严格规则，则可以使用您自己的实施替换区域设置处理程序。

可选OSGi服务 optional-osgi-services

可以实施可选的OSGi服务来自定义Portlet的各个部分。 每个服务都对应一个Java接口。 此接口可以通过包实施和部署到Portlet中。

替换默认服务 replacing-default-services

以下服务在内容portlet中具有默认实施（具有相应的Java界面）。 要进行自定义，需要将包含新服务实施的包部署到Portlet应用程序中。

实施此类服务时，请确保将 service.ranking 属性更改为正值。 默认实施使用排名 ​ 0,Portlet使用排名最高的服务。

Portlet事件 portlet-events

portlet API(JSR-286)指定portlet事件。 AEM内容portlet具有集成的桥，它将AEM portlet事件作为OSGi事件分发为portlet事件 — 这使处理portlet事件变得可插拔。

如果要处理特定事件，请在部署描述符中声明这些事件作为接收事件（或通过门户服务器配置它），并实施声明EventHandler接口的OSGi服务（请参阅OSGi EventAdmin规范）。

每当发生portlet事件时，都会调用您的处理程序发送特定的OSGi事件。 处理程序获取所有上下文信息，并可相应地更新Portlet的状态或发送新事件。 基本上，在句柄方法内部可以使用portlet事件阶段的所有功能。

将AEM用作门户 using-aem-as-a-portal

使用Portlet组件将Portlet窗口添加到AEM页面。 安装到应用程序服务器的共享库使Portlet组件能够检测已部署的Portlet应用程序。

要将AEM用作门户，请执行以下任务：

安装portlet组件 installing-the-portlet-component

AEM快速入门JAR文件包含Portlet组件文件。 要获取文件(cq-portlet-components.zip)，您可以执行快速入门，或解压缩内容。

将Portlet组件添加到Sidekick adding-the-portlet-component-to-sidekick

将portlet组件添加到段落系统，以便作者可以使用它。

配置和部署Portlet应用程序 configuring-and-deploying-your-portlet-applications

将portlet部署到应用程序服务器Web容器，以便它们可用于门户组件。 在部署Portlet应用程序之前，您需要配置该应用程序，以便它加载AEM Portal容器Servlet。 此配置使Portlet组件能够访问Portlet。

将portlet添加到您的AEM页面 adding-portlets-to-your-aem-page

使用Portal组件将Portlet窗口添加到网页。 使用组件属性指定要显示的portlet。

在Portlet中安装、配置和使用AEM installing-configuring-and-using-aem-in-a-portlet

要访问AEM WCM提供的内容，需要为门户服务器安装AEM Portal Director Portlet。 为此，请使用本节中提供的步骤来安装、配置Portlet并将其添加到门户页面。

默认情况下，Portlet会连接到localhost:4503处的发布实例，并连接到localhost:4502处的创作实例。 在部署Portlet期间，可以更改这些值。 门户控制器在/libs/portal/directory下的存储库中以内容形式提供。 您需要先下载应用程序战争文件，然后再使用它。

下载战争文件 downloading-the-war-file

安装portlet installing-the-portlet

要安装Portlet，请执行以下操作：

配置Portlet configuring-the-portlet

安装Portlet后，您需要对其进行配置，以便它知道基础AEM实例（创作和发布）的URL。 您还可以配置其他选项。

要配置Portlet，请执行以下操作：

内容URL content-urls

当从AEM请求内容时，Portlet使用当前显示模式（发布或创作）和当前路径来组合完整的URL。 如果使用默认值，则第一个url为 http://localhost:4503/content/geometrixx/en.portlet.html. 的值 htmlSelector 会在扩展之前自动添加到URL中。

如果Portlet切换到帮助模式，则 appendHelpViewModeAsSelector ，则 help 此外，还附加了选择器，例如， http://localhost:4503/content/geometrixx/en.portlet.html.help. 如果Portlet窗口已最大化，并且 appendMaxWindowStateAsSelector ，则也会附加选择器，例如， http://localhost:4503/content/geometrixx/en.portlet.max.help.

选择器可以在AEM中评估，而不同的模板可用于不同的选择器。

在AEM中使用内容Url映射 using-a-content-url-map-in-aem

通常，开始路径直接指向AEM中的内容。 但是，如果要在AEM中而不是portlet首选项中维护起始路径，则可以将起始路径指向AEM中的内容映射，如 /var/portlets. 在这种情况下，在AEM中运行的脚本可以使用portlet中提交的信息来确定哪个url是起始URL。 它应会发出到正确URL的重定向。

将Portlet添加到Portal页 adding-the-portlet-to-the-portal-page

要将Portlet添加到门户页面，请执行以下操作：

使用Portlet using-the-portlet

要访问您添加到Portlet的页面，请执行以下操作：