用於建立和啟用套件的Java型API id175UB30E05Z

Last update: Thu Sep 12 2024 00:00:00 GMT+0000 (Coordinated Universal Time)

主題：
Java型API套件

建立對象：

經驗豐富
開發人員

NOTE

您可以使用Experience Manager Guides中提供的Java式API來建立自訂外掛程式，並擴充現成可用的工作流程。本文將會在2024年11月封存。
檢視

，以取得有關使用Java型API的最新和詳細檔案。

以下Java型API可讓您建立和啟用CRX套件。此API可以套件形式提供。您必須在程式碼中包含此套件組合才能使用此API。

套件組合詳細資料：

群組識別碼： com.adobe.fmdita
成品ID： api
版本： 3.3
封裝： com.adobe.fmdita.api.crxactivate

類別詳細資料：

code language-java
`public class CRXActivator`

CRXActivator 類別包含用來建立CRX套件並在發佈執行個體上復寫它的方法。

建立及啟用封裝

activate方法會在製作執行個體上建立CRX套件，並視需要在發佈執行個體上復寫它。我們假設已在編寫執行個體上設定AEM復寫引數。此方法會根據JSON字串中提供作為輸入引數的規則清單，建立CRX套件。

NOTE

在建立或啟動程式期間遇到的錯誤會寫入outputstream。

具有兩個引數的範例

語法：

public static void activate
(
  String json,
  OutputStream outputstream,
  Session session
)
throws GuidesApiException

第三個選用引數的範例

public static void activate
(
  String json,
  OutputStream outputstream,
  String activationTarget,
  Session session
)
throws GuidesApiException

引數：

名稱

類型

說明

json

字串

決定要建置CRX套件的JSON字串。使用以下格式建立JSON字串：
- activate：屬於布林型別(true/false)。判斷是否將在製作執行個體中建立的CRX套件復寫至發佈執行個體。
- rules：屬於JSON陣列型別。一系列JSON規則，系統會依序處理以建置CRX套件。
- rootPath：屬於字串型別。執行節點/屬性查詢的基底路徑。如果不存在節點/屬性查詢，根路徑以及根路徑下存在的所有節點都會包含在CRX套件中。
- nodeQueries：屬於型別Regex陣列。規則運算式的陣列，用來包含根路徑下的特定檔案。
- propertyQueries：屬於JSON陣列型別。 JSON物件陣列，其中每個JSON物件包含要在根路徑上執行的XPath查詢，以及執行查詢後每個JCR節點中存在的屬性名稱。每個JCR節點中屬性的值應為路徑或路徑陣列。此屬性中存在的路徑已新增至CRX套件。

outputstream

java.io.OutputStream

這可用來寫入不同階段的結果，例如查詢執行、檔案包含、CRX套件建立或啟動。在建立或啟動程式期間遇到的任何錯誤都會寫入outputstream。這對於偵錯很有用。

session

字串

具有啟用許可權的有效JCR工作階段。

activationTarget

字串

(Optional) preview或publish (適用於Cloud Service)以及publish （適用於On-premise軟體
） — 若是Cloud Service，如果引數包含無效值，則封裝啟用會失敗。
— 針對On-Premise軟體，如果引數包含無效值，則會記錄錯誤，並使用預設值publish完成發佈。

例外狀況：

擲回java.io.IOException和java.io.IllegalArgumentException

如果您未定義選用引數activationTarget，它會使用Cloud Service和內部部署軟體的預設發佈代理程式來啟動。

範例：
以下範例顯示如何建立JSON查詢：

{
  "activate": true,
  "rules": [
    {
      "rootPath": "/content/dam/nested",
      "nodeQueries": [
        ".*\\.jpg",
        ".*\\.png",
        ".*\\.gif"
      ]
    },
    {
      "rootPath": "/content/output/sites/hierarchy_ditamap"
    },
    {
      "rootPath": "/content/output/sites/hierarchy_ditamap",
      "propertyQueries": [
        {
          "query": "//*[@fileReference]",
          "property": "fileReference"
        }
      ]
    }
  ]
}

範例JSON查詢包含下列規則：

套件中只包含/content/dam/nested路徑下的.png、.jpg和.gif影像。
/content/output/sites/hierarchy_ditamap下的所有節點都會包含在套件中。
在/content/output/sites/hierarchy_ditamap下節點的fileReference屬性中存在的路徑包含在套件中。

recommendation-more-help

11125c99-e1a1-4369-b5d7-fb3098b9b178