AEM Portals和Portlet aem-portals-and-portlets

本文档将介绍以下内容：

AEM Portal架构 aem-portal-architecture

AEM portal体系结构包括portal和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上可用，并且可以通过多种方式进行自定义。 例如，您可以通过部署自己的身份验证服务来自定义SSO/身份验证处理，从而为AEM生成覆盖默认行为所需的身份验证信息。 这些插件使用定义的API，允许您通过根据API构建插件来添加自己的功能。 可以将插件部署到正在运行的Portlet中。 为了正常运行，它需要在启动时显示AEM创作和发布实例的配置以及内容路径。

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

Portlet首选项 portlet-preferences

在部署portlet web应用程序之前，可以在门户服务器中进行部署时配置Porlet首选项，也可以编辑​ 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为https://localhost:8080/cqportlet/cqbridge/system/console。 默认用户和密码为​ admin。

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

提供配置 providing-configurations

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

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

如果设置了环境，则会在at* com/day/cq/portlet/{env}.config ​的类路径中搜索配置文件，其中​ 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从该位置下载文件。

您可以在运行时部署此捆绑包，或者在部署之前将其添加到位于WEB-INF/lib/resources/bundles的Portlet Web应用程序。

部署缓存后，portlet将缓存发布实例中的内容。 可以通过AEM中的Dispatcher刷新使Portlet缓存失效。 要将Portlet配置为使用自己的缓存，请执行以下操作：

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

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

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

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

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

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

例如：

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存储库。 此行为是可插拔的，并且可以自定义。

Publish上的身份验证 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创作实例发出的所有请求都使用同一技术用户进行验证，而不管当前是Portal用户。 默认情况下，“技术用户”模式处于启用状态。 您可以在OSGi管理控制台的相应配置屏幕中启用/禁用此模式：

如果启用了Publish 上的 ​身份验证，指定的技术用户必须存在于AEM WCM创作实例和发布实例上。 请确保授予用户足够的访问权限以进行创作工作。

SSO sso

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

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

<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 WCM实例必须知道所有有权访问AEM Portlet的门户用户，最常见的方式是将AEM WCM连接到LDAP，或事先手动创建用户。 此外，在Portlet中启用SSO之前，需要将基础AEM WCM创作实例(和发布实例，如果在Publish 上启用了 ​身份验证)配置为接受基于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的身份验证。 失败时，执行对常规基本身份验证方案的回退。 因此，与没有SSO的AEM WCM的正常连接仍然可用。

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

为了使基础AEM WCM实例接受SSO请求，必须将Portlet的身份验证模式从​ 技术 ​切换到​ SSO。

要在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创作实例中直接在门户之外的门户之外使用portlet的创作和管理部分，则应启用PIN身份验证。 您还需要更改管理按钮的配置。

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

特权 privileges

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

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

此外，还可以基于每个Portlet实例基础定义此角色。 Portlet的首选项对话框包含上述每个权限的输入字段。 对于每个权限，可以配置以逗号分隔的portlet角色列表。 如果配置了值，这将覆盖“Day Portal Director Privilege Manager”服务的全局配置，并且可能需要从此全局设置添加相同的角色，因为这些角色不会合并！ 如果未指定值，则使用全局配置。

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

提供的AEM portlet应用程序在Web应用程序中启动OSGi容器，与AEM一样。 此架构允许您使用OSGi的所有优势：

工具栏按钮 toolbar-buttons

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

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

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

通过通过portlet的Felix Web控制台(在预定义位置包含自定义CSS/HTML)安装捆绑包，可以自定义portlet的工具栏布局。

捆绑包结构 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视图 publish-view

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

Publish视图占位符 publish-view-placeholders

管理视图 manage-view

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

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

按钮 buttons

无论按钮出现在哪个视图中，它们都使用相同的常用HTML（在button.html中定义）。

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

“管理”和“Publish查看”按钮 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

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

您还可以定义要查询以显示内容路径的其他请求参数。 这很有用，例如，当存在从外部到特定内容的链接时。

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

本地化 localization

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

此过程分两步完成：

可以为Portal 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的Portlet事件作为OSGi事件分发 — 这使得处理Portlet事件变得可插拔。

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

每当portlet事件发生时，都会发送一个特定的OSGi事件，以调用您的处理程序。 该处理程序获取所有上下文信息，并可相应地更新Portlet的状态或发送新事件。 基本上，在handle方法内可以使用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容器，以便它们可用于Portal组件。 在部署portlet应用程序之前，需要配置应用程序，以便加载AEM portal容器servlet。 此配置使Portlet组件能够访问portlet。

向AEM页面添加Portlet adding-portlets-to-your-aem-page

使用门户组件向网页添加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下作为内容使用。 下载应用程序war文件，然后再使用它。

正在下载war文件 downloading-the-war-file

安装portlet installing-the-portlet

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

配置Portlet configuring-the-portlet

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

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

内容URL content-urls

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

如果portlet切换到帮助模式并且选择了appendHelpViewModeAsSelector，则还将附加help选择器，例如https://localhost:4503/content/geometrixx/en.portlet.html.help。 如果最大化了Portlet窗口并选择appendMaxWindowStateAsSelector，则也会附加选择器，例如https://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添加到门户页 adding-the-portlet-to-the-portal-page

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

使用Portlet using-the-portlet

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