驗證DDX文檔

本檔案中的範例和範例僅適用於JEE環境上的AEM Forms。

可以用寫程式方式驗證組合器服務使用的DDX文檔。 也就是說，使用組合器服務API，可以確定DDX文檔是否有效。 例如，如果您從以前的AEM Forms版本升級，並且希望確保DDX文檔有效，則可以使用組合器服務API來驗證它。

注意

有關組合器服務的詳細資訊，請參閱AEM Forms的服務參考。

注意

有關DDX文檔的詳細資訊，請參閱組合器服務和DDX引用。

步驟的摘要

要驗證DDX文檔，請執行以下任務：

  1. 包含專案檔案。
  2. 建立組合器客戶端。
  3. 參考現有的DDX文檔。
  4. 設定運行時選項以驗證DDX文檔。
  5. 執行驗證。
  6. 將驗證結果保存在日誌檔案中。

包含項目檔案

在您的開發專案中加入必要的檔案。 如果您是使用Java建立客戶端應用程式，請包括必要的JAR檔案。 如果您使用Web服務，請確定您包含Proxy檔案。

必須將以下JAR檔案添加到項目的類路徑中：

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-assembler-client.jar
  • adobe-utilities.jar(若AEM Forms部署在JBoss上則為必要)
  • jbossall-client.jar(若AEM Forms部署在JBoss上則為必要)

如果AEM Forms部署在JBoss以外的受支援J2EE應用程式伺服器上，您必須將adobe-utilities.jar和jbossall-client.jar檔案取代為AEM Forms所部署之J2EE應用程式伺服器專屬的JAR檔案。

建立PDF組合器客戶端

在以寫程式方式執行組合器操作之前，必須建立組合器服務客戶端。

參考現有的DDX文檔

要驗證DDX文檔，必須參考現有DDX文檔。

設定運行時選項以驗證DDX文檔

驗證DDX文檔時，必須設定特定的運行時選項，這些選項指示組合器服務驗證DDX文檔，而不執行它。 此外，您還可以增加組合器服務寫入日誌檔案的資訊量。

執行驗證

建立組合器服務客戶端、引用DDX文檔並設定運行時選項後，可以調用invokeDDX操作來驗證DDX文檔。 驗證DDX文檔時，可以傳遞null作為映射參數（此參數通常儲存匯編器執行DDX文檔中指定的操作所需的PDF文檔）。

如果驗證失敗，則會引發異常，並且日誌檔案包含詳細資訊，說明為何DDX文檔無效，可從OperationException實例獲取。 一旦通過基本XML解析和架構檢查，就會執行對DDX規範的驗證。 DDX文檔中的所有錯誤都在日誌中指定。

將驗證結果保存在日誌檔案中

組合器服務返回可寫入XML日誌檔案的驗證結果。 組合器服務寫入日誌檔案的詳細程度取決於您設定的運行時選項。

另請參閱

使用Java API驗證DDX檔案

使用網站服務API驗證DDX檔案

包含AEM Forms Java程式庫檔案

設定連接屬性

以程式設計方式組合PDF檔案

使用Java API驗證DDX文檔

使用組合器服務API(Java)驗證DDX文檔：

  1. 包含專案檔案。

    在Java項目的類路徑中包含客戶端JAR檔案，如adobe-assembler-client.jar。

  2. 建立PDF組合器客戶端。

    • 建立包含連接屬性的ServiceClientFactory對象。
    • 使用其建構子並傳遞ServiceClientFactory物件，以建立AssemblerServiceClient物件。

  3. 參考現有的DDX文檔。

    • 使用DDX文檔的建構子並傳遞指定DDX檔案位置的字串值，建立代表DDX文檔的java.io.FileInputStream對象。
    • 使用其建構子並傳遞java.io.FileInputStream物件，以建立com.adobe.idp.Document物件。

  4. 設定運行時選項以驗證DDX文檔。

    • 使用其建構子建立AssemblerOptionSpec物件，以儲存執行時選項。
    • 設定運行時間選項，該選項指示組合器服務通過調用AssemblerOptionSpec對象的setValidateOnly方法並傳遞true來驗證DDX文檔。
    • 通過調用AssemblerOptionSpec對象的getLogLevel方法並傳遞字串值來設定組合器服務寫入日誌檔案的資訊量，該資訊量滿足您的要求。 驗證DDX文檔時，需要將更多資訊寫入日誌檔案，以幫助驗證過程。 因此，您可以傳遞值FINE或FINER。

  5. 執行驗證。

    調用AssemblerServiceClient對象的invokeDDX方法並傳遞以下值：

    • 代表DDX文檔的com.adobe.idp.Document對象。
    • 通常儲存PDF文檔的java.io.Map對象的值null。
    • 指定運行時選項的com.adobe.livecycle.assembler.client.AssemblerOptionSpec對象。

    invokeDDX方法返回一個AssemblerResult對象，該對象包含指定DDX文檔是否有效的資訊。

  6. 將驗證結果保存在日誌檔案中。

    • 建立java.io.File物件，並確定副檔名為.xml。
    • 調用AssemblerResult對象的getJobLog方法。 此方法會傳回包含驗證資訊的com.adobe.idp.Document例項。
    • 調用com.adobe.idp.Document對象的copyToFile方法，將com.adobe.idp.Document對象的內容複製到檔案。
    注意

    如果DDX文檔無效，則擲回OperationException。 在catch陳述式中，可以調用OperationException對象的getJobLog方法。

另請參閱

驗證DDX文檔

快速入門（SOAP模式）:使用Java API （SOAP模式）驗證DDX檔案

包含AEM Forms Java程式庫檔案

設定連接屬性

使用Web服務API驗證DDX文檔

使用組合器服務API（Web服務）驗證DDX文檔：

  1. 包含專案檔案。

    建立使用MTOM的Microsoft .NET項目。 確保使用以下WSDL定義：http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1。

    注意

    用表單伺服器的IP地址替換localhost。

  2. 建立PDF組合器客戶端。

    • 使用其預設建構子建立AssemblerServiceClient物件。

    • 使用System.ServiceModel.EndpointAddress建構子建立AssemblerServiceClient.Endpoint.Address物件。 將指定WSDL的字串值傳遞到AEM Forms服務（例如http://localhost:8080/soap/services/AssemblerService?blob=mtom）。 您不需要使用lc_version屬性。 建立服務參考時，會使用此屬性。

    • 獲取AssemblerServiceClient.Endpoint.Binding欄位的值，建立System.ServiceModel.BasicHttpBinding對象。 將傳回值轉換為BasicHttpBinding。

    • 將System.ServiceModel.BasicHttpBinding物件的MessageEncoding欄位設為WSMessageEncoding.Mtom。 此值可確保使用MTOM。

    • 通過執行以下任務來啟用基本HTTP身份驗證：

      • 將AEM表單使用者名稱指派給欄位AssemblerServiceClient.ClientCredentials.UserName.UserName。
      • 將相應的密碼值分配給欄位AssemblerServiceClient.ClientCredentials.UserName.Password。
      • 將常數值HttpClientCredentialType.Basic指派給欄位BasicHttpBindingSecurity.Transport.ClientCredentialType。
      • 將常數值BasicHttpSecurityMode.TransportCredentialOnly指派給欄位BasicHttpBindingSecurity.Security.Mode。

  3. 參考現有的DDX文檔。

    • 使用其建構子建立BLOB物件。 BLOB對象用於儲存DDX文檔。
    • 通過調用其建構子並傳遞一個字串值來建立System.IO.FileStream對象，該字串值表示DDX文檔的檔案位置以及在中開啟檔案的模式。
    • 建立儲存System.IO.FileStream對象內容的位元組陣列。 通過獲取System.IO.FileStream對象的Length屬性，可以確定位元組陣列的大小。
    • 調用System.IO.FileStream對象的Read方法並傳遞要讀取的位元組陣列、啟動位置和流長度，以流資料填充位元組陣列。
    • 為MTOM物件指派包含位元組陣列內容的屬性，以填入BLOB物件。

  4. 設定運行時選項以驗證DDX文檔。

    • 使用其建構子建立AssemblerOptionSpec物件，以儲存執行時選項。
    • 設定運行時間選項，該選項指示組合器服務通過將值true分配給AssemblerOptionSpec對象的validateOnly資料成員來驗證DDX文檔。
    • 通過將字串值分配給AssemblerOptionSpec對象的logLevel資料成員，設定組合器服務寫入日誌檔案的資訊量。 方法驗證DDX文檔時，您希望將更多資訊寫入日誌檔案，以幫助驗證過程。 因此，您可以指定值FINE或FINER。 如需可設定的執行階段選項相關資訊，請參閱AEM Forms API參考中的AssemblerOptionSpec類別參考。

  5. 執行驗證。

    調用AssemblerServiceClient對象的invokeDDX方法並傳遞以下值：

    • 代表DDX文檔的BLOB對象。
    • 通常儲存PDF文檔的Map對象的值null。
    • 指定運行時選項的AssemblerOptionSpec對象。

    invokeDDX方法返回一個AssemblerResult對象，該對象包含指定DDX文檔是否有效的資訊。

  6. 將驗證結果保存在日誌檔案中。

    • 通過調用其建構子並傳遞一個字串值來建立System.IO.FileStream對象，該字串值表示日誌檔案的檔案位置以及在中開啟檔案的模式。 請確定副檔名為.xml。
    • 通過獲取AssemblerResult對象的jobLog資料成員的值，建立儲存日誌資訊的BLOB對象。
    • 建立儲存BLOB對象內容的位元組陣列。 獲取BLOB對象的MTOM欄位的值，填入位元組陣列。
    • 通過調用其建構子並傳遞System.IO.FileStream對象來建立System.IO.BinaryWriter對象。
    • 調用System.IO.BinaryWriter對象的Write方法並傳遞位元組陣列，將位元組陣列的內容寫入PDF檔案。
    注意

    如果DDX文檔無效，則擲回OperationException。 在catch語句中，可以獲取OperationException對象的jobLog成員的值。

另請參閱

驗證DDX文檔

使用MTOM叫用AEM Forms

本頁內容