AEM入口網站與入口網站 aem-portals-and-portlets

本檔案說明下列各項：

AEM入口網站架構 aem-portal-architecture

AEM入口網站架構包含入口網站和portlet的定義。

什麼是入口網站？ what-is-a-portal

入口網站是一種網頁應用程式，可提供個人化、單一登入、不同來源的內容整合，並代管資訊系統的展示層。

您可以在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建立外掛程式，以新增您自己的功能。 外掛程式可部署至執行中的Portlet。 若要正常運作，它需要AEM製作和發佈執行個體的設定，以及要在啟動時顯示的內容路徑。

部分設定可透過Portlet偏好設定進行變更，有些則可透過OSGi服務設定進行變更。 您透過以下方式變更這些設定 設定 檔案或OSGi Web主控台。

Portlet喜好設定 portlet-preferences

Porlet偏好設定可在部署時在入口網站伺服器設定，或是透過編輯 WEB-INF/portlet.xml 部署portlet web應用程式之前的檔案。 依預設，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，網頁主控台的url為 https://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 位置 環境 會取代為環境的實際值。 此檔案應列出此環境的所有組態檔。 系統會根據組態檔的位置來搜尋這些檔案。 例如，如果檔案包含 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的Dispatcher Flush可以使Portlet快取失效。 若要設定Portlet使用自己的快取：

透過復寫代理程式排清快取 flushing-the-cache-via-replication-agent

就像一般的Dispatcher失效一樣，可設定復寫代理程式來鎖定入口網站的AEM Portlet快取。 在您設定復寫代理程式後，每次定期啟用頁面都會排清入口網站快取。

如果您運算元個執行AEM Portlet的入口網站節點，則需要為每個節點建立一個代理程式，如本程式所述。

設定入口網站的復寫代理程式：

手動排清Portlet快取 manually-flushing-the-portlet-cache

您可以存取為復寫代理程式設定的相同URL，以手動清除Portlet快取。 另請參閱 排清快取 （以URL形式表示）。 此外，URL需要以URL引數Path=擴充<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 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 WCM執行個體必須知道所有可存取AEM Portlet的入口網站使用者，最常用的形式是連線至LDAP的AEM WCM，或事先手動建立使用者。 此外，在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為基礎的驗證。 失敗時，會執行一般基本驗證方案的遞補。 因此，沒有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的預設內嵌編輯功能，但希望Portlet的製作和管理部分直接在入口網站之外的AEM製作執行個體中，您應該啟用PIN驗證。 您也需要變更管理按鈕的設定。

若要開啟網站管理頁面或從Portlet編輯頁面，AEM內容Portlet會使用新的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編寫執行個體進行編輯，請啟用 網站管理員按鈕 和 ContentFinder按鈕，但停用 編輯按鈕. 在此情況下，請務必在AEM中正確設定PIN驗證。

可透過Portlet的Felix網頁主控台安裝套件組合(包含預先定義位置處的自訂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-view

發佈檢視只有一個按鈕，可將工具列切換至管理檢視。 發佈檢視由publish.html檔案表示，位於 上一個組合. 在HTML中，您可以使用下列預留位置，在轉譯時這些預留位置會由Portlet以個別內容取代：

發佈檢視預留位置 publish-view-placeholders

管理檢視 manage-view

「管理」檢視有四個按鈕：「編輯」、「網站」標籤、「重新整理」和「上一步」。 管理檢視由manage.html檔案表示，位於 上一個組合. 在HTML中，您可以使用下列預留位置，在轉譯時這些預留位置會由Portlet以個別內容取代：

管理檢視預留位置 manage-view-placeholders

按鈕 buttons

按鈕無論在哪個檢視中顯示，都會使用相同的通用HTML（在button.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

所有連結都會被重寫以在入口網站內容中運作。 預設會使用附帶轉譯器引數的連結。 入口網站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的Portlet事件當做OSGi事件發佈，如此一來，處理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 Quickstart 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。

新增Portlet至您的AEM頁面 adding-portlets-to-your-aem-page

使用Portal元件將Portlet視窗新增至網頁。 使用元件屬性指定要顯示的Portlet。

在Portlet中安裝、設定和使用AEM installing-configuring-and-using-aem-in-a-portlet

若要存取AEM WCM提供的內容，入口網站伺服器必須安裝AEM入口網站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新增至Portal頁面 adding-the-portlet-to-the-portal-page

若要將Portlet新增至入口網站頁面：

使用Portlet using-the-portlet

若要存取您新增至Portlet的頁面：