文档AEM 6.5用户指南

验证DDX文档 validating-ddx-documents

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 主题：

创建对象：

  • 开发人员

本文档中的示例和示例仅适用于JEE环境上的AEM Forms。

您可以以编程方式验证汇编程序服务使用的DDX文档。 即，使用Assembler服务API，您可以确定DDX文档是否有效。 例如，如果您从以前的AEM Forms版本升级，并且要确保DDX文档有效，则可以使用汇编程序服务API验证它。

NOTE
有关Assembler服务的详细信息，请参阅AEM Forms的服务参考。
NOTE
有关DDX文档的更多信息，请参阅汇编程序服务和DDX引用。

步骤摘要 summary-of-steps

要验证DDX文档，请执行以下任务：

  1. 包括项目文件。
  2. 创建Assembler客户端。
  3. 引用现有DDX文档。
  4. 设置运行时选项以验证DDX文档。
  5. 执行验证。
  6. 将验证结果保存在日志文件中。

包含项目文件

在开发项目中包含必要的文件。 如果使用Java创建客户端应用程序，请包含必要的JAR文件。 如果使用Web服务，请确保包含代理文件。

必须将以下JAR文件添加到项目的类路径中：

  • adobe-livecycle-client.jar
  • adobe-usermanager-client.jar
  • adobe-assembler-client.jar
  • adobe-utilities.jar(如果在JBoss上部署了AEM Forms，则此为必填字段)
  • jbossall-client.jar(如果在JBoss上部署了AEM Forms，则此为必填字段)

如果AEM Forms部署在除JBoss之外的受支持J2EE应用程序服务器上，则必须将adobe-utilities.jar和jbossall-client.jar文件替换为JAR文件，这些文件特定于部署AEM Forms的J2EE应用程序服务器。

创建PDF汇编程序客户端

您必须先创建一个Assembler服务客户端，然后才能以编程方式执行Assembler操作。

引用现有DDX文档

要验证DDX文档，必须引用现有的DDX文档。

设置运行时选项以验证DDX文档

验证DDX文档时，必须设置特定的运行时选项，以指示Assembler服务验证DDX文档，而不是执行文档。 此外，您还可以增加Assembler服务写入日志文件的信息量。

执行验证

创建Assembler服务客户端、引用DDX文档并设置运行时选项后，可以调用invokeDDX操作来验证DDX文档。 验证DDX文档时，您可以将null作为映射参数传递(此参数通常存储汇编程序执行DDX文档中指定的操作所需的PDF文档)。

如果验证失败，则会引发异常，并且日志文件包含详细信息，说明为何可从OperationException实例获取DDX文档无效。 一旦通过了基本的XML解析和模式检查，就会执行针对DDX规范的验证。 DDX文档中的所有错误都在日志中指定。

将验证结果保存在日志文件中

Assembler服务返回可以写入XML日志文件的验证结果。 Assembler服务写入日志文件的详细信息量取决于您设置的运行时选项。

另请参阅

使用Java API验证DDX文档

使用Web服务API验证DDX文档

包括AEM Forms Java库文件

设置连接属性

以编程方式组合PDF文档

使用Java API验证DDX文档 validate-a-ddx-document-using-the-java-api

使用Assembler服务API (Java)验证DDX文档：

  1. 包括项目文件。

    在您的Java项目的类路径中包含客户端JAR文件，例如adobe-assembler-client.jar。

  2. 创建PDF汇编程序客户端。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用构造函数创建AssemblerServiceClient对象并传递ServiceClientFactory对象。

  3. 引用现有DDX文档。

    • 通过使用其构造函数并传递指定DDX文件位置的字符串值，创建表示DDX文档的java.io.FileInputStream对象。
    • 使用对象的构造函数创建com.adobe.idp.Document对象并传递java.io.FileInputStream对象。

  4. 设置运行时选项以验证DDX文档。

    • 使用构造函数创建存储运行时选项的AssemblerOptionSpec对象。
    • 通过调用AssemblerOptionSpec对象的setValidateOnly方法并传递true，设置指示Assembler服务验证DDX文档的运行时选项。
    • 通过调用AssemblerOptionSpec对象的getLogLevel方法并传递一个符合要求的字符串值，设置Assembler服务写入日志文件的信息量。 验证DDX文档时，您需要将更多信息写入日志文件，以帮助验证过程。 因此，您可以传递值FINE或FINER。

  5. 执行验证。

    调用AssemblerServiceClient对象的invokeDDX方法并传递以下值：

    • 表示DDX文档的com.adobe.idp.Document对象。
    • java.io.Map对象(通常存储PDF文档)的值null。
    • 指定运行时选项的com.adobe.livecycle.assembler.client.AssemblerOptionSpec对象。

    invokeDDX方法返回包含指定DDX文档是否有效的信息的AssemblerResult对象。

  6. 将验证结果保存在日志文件中。

    • 创建java.io.File对象并确保文件扩展名为.xml。
    • 调用AssemblerResult对象的getJobLog方法。 此方法返回包含验证信息的com.adobe.idp.Document实例。
    • 调用com.adobe.idp.Document对象的copyToFile方法以将com.adobe.idp.Document对象的内容复制到文件中。
    note note
    NOTE
    如果DDX文档无效，则抛出OperationException。 在catch语句中，您可以调用OperationException对象的getJobLog方法。

另请参阅

验证DDX文档

快速入门(SOAP模式)：使用Java API验证DDX文档(SOAP模式)

包括AEM Forms Java库文件

设置连接属性

使用Web服务API验证DDX文档 validate-a-ddx-document-using-the-web-service-api

使用Assembler服务API（Web服务）验证DDX文档：

  1. 包括项目文件。

    创建使用MTOM的Microsoft .NET项目。 确保使用以下WSDL定义： http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1。

    note note
    NOTE
    将localhost替换为Forms服务器的IP地址。

  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对象。
    • 通过为AssemblerOptionSpec对象的validateOnly数据成员分配值true，设置指示Assembler服务验证DDX文档的运行时选项。
    • 通过为AssemblerOptionSpec对象的logLevel数据成员分配字符串值，设置Assembler服务写入日志文件的信息量。 方法验证DDX文档时，您需要将更多信息写入日志文件，以帮助验证过程。 因此，您可以指定值FINE或FINER。 有关可设置的运行时选项的信息，请参阅AEM Forms API引用中的AssemblerOptionSpec类引用。

  5. 执行验证。

    调用AssemblerServiceClient对象的invokeDDX方法并传递以下值：

    • 表示DDX文档的BLOB对象。
    • 通常存储PDF文档的Map对象的值null。
    • 指定运行时选项的AssemblerOptionSpec对象。

    invokeDDX方法返回包含指定DDX文档是否有效的信息的AssemblerResult对象。

  6. 将验证结果保存在日志文件中。

    • 通过调用其构造函数并传递一个字符串值来创建一个System.IO.FileStream对象，该字符串值表示日志文件的文件位置以及用于打开文件的模式。 确保文件扩展名为.xml。
    • 通过获取AssemblerResult对象的jobLog数据成员的值，创建存储日志信息的BLOB对象。
    • 创建用于存储BLOB对象的内容的字节数组。 通过获取BLOB对象的MTOM字段的值填充字节数组。
    • 通过调用其构造函数并传递System.IO.FileStream对象来创建System.IO.BinaryWriter对象。
    • 通过调用System.IO.BinaryWriter对象的Write方法并传递字节数组，将字节数组的内容写入PDF文件。
    note note
    NOTE
    如果DDX文档无效，则抛出OperationException。 在catch语句中，您可以获取OperationException对象的jobLog成员的值。

另请参阅

验证DDX文档

使用MTOM调用AEM Forms

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2