文档AEM 6.5用户指南

以编程方式组合PDF文档 programmatically-assembling-pdf-documents

Last update: Mon Jul 15 2024 00:00:00 GMT+0000 (Coordinated Universal Time)
  • 适用对象：
  • Experience Manager 6.5
  • 主题：

创建对象：

  • 开发人员

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

您可以使用Assembler服务API将多个PDF文档组合到单个PDF文档中。 下图显示三个PDF文档合并到单个PDF文档中。

pa_pa_document_assembly

要将两个或多个PDF文档组合为单个PDF文档，您需要一个DDX文档。 DDX文档描述了Assembler服务生成的PDF文档。 即，DDX文档会指示Assembler服务要执行的操作。

为了进行此讨论，假定使用以下DDX文档。

 <?xml version="1.0" encoding="UTF-8"?>
 <DDX xmlns="https://ns.adobe.com/DDX/1.0/">
     <PDF result="out.pdf">
         <PDF source="map.pdf" />
         <PDF source="directions.pdf" />
     </PDF>
 </DDX>

此DDX文档将两个名为​ map.pdf ​和​ directions.pdf ​的PDF文档合并为一个PDF文档。

NOTE
要查看可拆分PDF文档的DDX文档，请参阅以编程方式拆分PDF文档。
NOTE
有关Assembler服务的详细信息，请参阅AEM Forms的服务参考。
NOTE
有关DDX文档的更多信息，请参阅汇编程序服务和DDX引用。

使用Web服务调用Assembler服务时的注意事项 considerations-when-invoking-assembler-service-using-web-services

在组合大型文档期间添加页眉和页脚时，可能会遇到OutOfMemory错误，并且无法组合文件。 为了减少出现此问题的可能性，请向您的DDX文档添加DDXProcessorSetting元素，如以下示例所示。

<DDXProcessorSetting name="checkpoint" value="2000" />

您可以添加此元素作为DDX元素的子元素或PDF result元素的子元素。 此设置的默认值为0（零），这将关闭检查点，并且DDX的行为就像不存在DDXProcessorSetting元素一样。 如果您遇到OutOfMemory错误，您可能需要将值设置为整数，通常介于500和5000之间。 较小的检查点值会导致更频繁的检查点操作。

步骤摘要 summary-of-steps

要从多个PDF文档组合单个PDF文档，请执行以下任务：

  1. 包括项目文件。
  2. 创建PDF汇编程序客户端。
  3. 引用现有DDX文档。
  4. 引用输入PDF文档。
  5. 设置运行时选项。
  6. 组合输入PDF文档。
  7. 提取结果。

包含项目文件

在开发项目中包含必要的文件。 如果使用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文件替换为特定于部署AEM Forms的J2EE应用程序服务器的JAR文件。

创建PDF汇编程序客户端

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

引用现有DDX文档

要组合PDF文档，必须引用DDX文档。 例如，考虑本节介绍的DDX文档。 此DDX文档指示Assembler服务将两个PDF文档合并为一个PDF文档。

参考输入PDF文档

引用要传递到Assembler服务的输入PDF文档。 例如，如果要传递两个名为“映射”和“方向”的输入PDF文档，则必须传递相应的PDF文件。

map.pdf文件和directions.pdf文件都必须放置在集合对象中。 密钥的名称必须与DDX文档中PDF源属性的值匹配。 如果DDX文档中的键和源属性匹配，则PDF文件的名称无关紧要。

NOTE
调用invokeDDX操作时返回包含集合对象的AssemblerResult对象。 将两个或多个输入PDF文档传递到Assembler服务时，将使用此操作。 但是，如果只将一个输入PDF传递到Assembler服务并且只期望有一个返回文档，则调用invokeOneDocument操作。 调用此操作时，将返回单个文档。 有关使用此操作的信息，请参阅汇编加密的PDF文档。

设置运行时选项

您可以设置运行时选项，以控制Assembler服务执行作业时的行为。 例如，您可以设置一个选项，在遇到错误时指示Assembler服务继续处理作业。 有关可设置的运行时选项的信息，请参阅AEM Forms API引用中的AssemblerOptionSpec类引用。

汇编输入PDF文档

在创建服务客户端、引用DDX文件、创建存储输入PDF文档的集合对象并设置运行时选项之后，可以调用DDX操作。 使用本节中指定的DDX文档时，map.pdf和direction.pdf文件将合并到一个PDF文档中。

提取结果

Assembler服务返回一个java.util.Map对象，该对象可以从AssemblerResult对象中获取，并且包含操作结果。 返回的java.util.Map对象包含结果文档和任何异常。

下表汇总了在返回的java.util.Map对象中可以包含的一些键值和对象类型。

键值
对象类型
描述
documentName
com.adobe.idp.Document
包含在DDX生成元素中指定的生成文档
documentName
Exception
包含文档的任何例外
OutputMapConstants.LOG_NAME
com.adobe.idp.Documen
包含作业日志

另请参阅

包括AEM Forms Java库文件

设置连接属性

以编程方式拆分PDF文档

使用Java API组合PDF文档 assemble-pdf-documents-using-the-java-api

使用Assembler服务API (Java)组合PDF文档：

  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. 引用输入PDF文档。

    • 使用HashMap构造函数创建用于存储输入PDF文档的java.util.Map对象。

    • 对于每个输入PDF文档，使用其构造函数并传递输入PDF文档的位置来创建一个java.io.FileInputStream对象。

    • 对于每个输入PDF文档，创建一个com.adobe.idp.Document对象并传递包含PDF文档的java.io.FileInputStream对象。

    • 对于每个输入文档，通过调用其put方法并传递以下参数，向java.util.Map对象添加一个条目：

      • 表示键名的字符串值。 此值必须与DDX文档中指定的PDF源元素的值匹配。
      • 包含源PDF文档的com.adobe.idp.Document对象（或指定多个文档的java.util.List对象）。

  5. 设置运行时选项。

    • 使用构造函数创建存储运行时选项的AssemblerOptionSpec对象。
    • 通过调用属于AssemblerOptionSpec对象的方法，设置运行时选项以满足您的业务要求。 例如，要指示Assembler服务在发生错误时继续处理作业，请调用AssemblerOptionSpec对象的setFailOnError方法并传递false。

  6. 组合输入PDF文档。

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

    • 表示要使用的DDX文档的com.adobe.idp.Document对象
    • 包含要汇编的输入PDF文件的java.util.Map对象
    • 指定运行时选项（包括默认字体和作业日志级别）的com.adobe.livecycle.assembler.client.AssemblerOptionSpec对象

    invokeDDX方法返回包含作业结果和发生的任何异常的com.adobe.livecycle.assembler.client.AssemblerResult对象。

  7. 提取结果。

    要获取新创建的PDF文档，请执行下列操作：

    • 调用AssemblerResult对象的getDocuments方法。 这将返回java.util.Map对象。
    • 反复查找java.util.Map对象，直到找到结果com.adobe.idp.Document对象。 (可以使用DDX文档中指定的PDF结果元素来获取文档。)
    • 调用com.adobe.idp.Document对象的copyToFile方法来提取PDF文档。
    note note
    NOTE
    如果将LOG_LEVEL设置为生成日志，则可以使用AssemblerResult对象的getJobLog方法提取日志。

另请参阅

快速入门(SOAP模式)：使用Java API组合PDF文档

包括AEM Forms Java库文件

设置连接属性

使用Web服务API组合PDF文档 assemble-pdf-documents-using-the-web-service-api

使用Assembler服务API（Web服务）组合PDF文档：

  1. 包括项目文件。

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

    note note
    NOTE
    将localhost替换为承载AEM 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. 引用输入PDF文档。

    • 对于每个输入PDF文档，使用其构造函数创建一个BLOB对象。 BLOB对象用于存储输入PDF文档。
    • 通过调用其构造函数并传递一个字符串值来创建一个System.IO.FileStream对象，该字符串值表示输入PDF文档的文件位置以及打开文件的模式。
    • 创建用于存储System.IO.FileStream对象的内容的字节数组。 您可以通过获取System.IO.FileStream对象的Length属性来确定字节数组的大小。
    • 通过调用System.IO.FileStream对象的Read方法，使用流数据填充字节数组。 传递字节数组、起始位置和要读取的流长度。
    • 使用字节数组的内容分配其MTOM字段以填充BLOB对象。
    • 创建MyMapOf_xsd_string_To_xsd_anyType对象。 此收藏集对象用于存储输入PDF文档。
    • 对于每个输入PDF文档，创建一个MyMapOf_xsd_string_To_xsd_anyType_Item对象。 例如，如果使用两个输入PDF文档，则创建两个MyMapOf_xsd_string_To_xsd_anyType_Item对象。
    • 将表示键名的字符串值分配给MyMapOf_xsd_string_To_xsd_anyType_Item对象的key字段。 此值必须与DDX文档中指定的PDF源元素的值匹配。 (为每个输入PDF文档执行此任务。)
    • 将存储PDF文档的BLOB对象分配给MyMapOf_xsd_string_To_xsd_anyType_Item对象的value字段。 (为每个输入PDF文档执行此任务。)
    • 将MyMapOf_xsd_string_To_xsd_anyType_Item对象添加到MyMapOf_xsd_string_To_xsd_anyType对象。 调用MyMapOf_xsd_string_To_xsd_anyType对象的Add方法并传递MyMapOf_xsd_string_To_xsd_anyType对象。 (为每个输入PDF文档执行此任务。)

  5. 设置运行时选项。

    • 使用构造函数创建存储运行时选项的AssemblerOptionSpec对象。
    • 通过为属于AssemblerOptionSpec对象的数据成员分配值，设置运行时选项以满足您的业务要求。 例如，要指示Assembler服务在发生错误时继续处理作业，请将false分配给AssemblerOptionSpec对象的failOnError数据成员。

  6. 组合输入PDF文档。

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

    • 表示DDX文档的BLOB对象。
    • 包含输入PDF文档的mapItem数组。 其键必须与PDF源文件的名称匹配，其值必须是与这些文件对应的BLOB对象。
    • 指定运行时选项的AssemblerOptionSpec对象。

    invoke方法返回一个包含作业结果和可能已发生的任何异常的AssemblerResult对象。

  7. 提取结果。

    要获取新创建的PDF文档，请执行下列操作：

    • 访问AssemblerResult对象的documents字段，该字段是包含结果PDF文档的Map对象。
    • 循环访问Map对象，直到找到与结果文档名称匹配的键。 然后将该数组成员的value强制转换为BLOB。
    • 通过访问其BLOB对象的MTOM属性，提取表示PDF文档的二进制数据。 这会返回一个字节数组，您可以将该字节写出到PDF文件中。
    note note
    NOTE
    如果将LOG_LEVEL设置为生成日志，则可以通过获取AssemblerResult对象的jobLog数据成员的值来提取日志。

另请参阅

使用MTOM调用AEM Forms

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