以编程方式组合PDF文档

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

您可以使用Assembler Service API将多个PDF文档组合到一个PDF文档中。 下图显示了三个PDF文档正被合并到一个PDF文档。

pa_pa_文档_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文档。

注意

要查看分解PDF文档的DDX文档,请参阅以编程方式分解PDF文档

注意

有关Assembler服务的详细信息,请参阅AEM Forms的服务参考

注意

有关DDX文档的详细信息,请参阅Assembler Service和DDX Reference

使用Web服务调用Assembler服务时的注意事项

在组装大型文档时添加页眉和页脚时,可能会遇到OutOfMemory错误,文件将不会组合。 要降低出现此问题的可能性,请向DDX文档添加DDXProcessorSetting元素,如以下示例所示。

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

可以将此元素添加为DDX元素的子元素或PDF result元素的子元素。 此设置的默认值为0(零),它关闭了检查点,DDX的行为就像DDXProcessorSetting元素不存在一样。 如果遇到OutOfMemory错误,您可能需要将该值设置为一个整数,通常介于500到5000之间。 小的检查点值导致更频繁的检查点。

步骤的摘要

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

  1. 包括项目文件。
  2. 创建PDF Assembler客户端。
  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操作之前,必须创建Assembler客户端。

引用现有DDX文档

必须引用DDX文档才能组合PDF文档。 例如,请考虑本节中引入的DDX文档。 此DDX文档指示Assembler服务将两个PDF文档合并为一个PDF文档。

参考输入PDF文档

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

map.pdf文件和directions.pdf文件都必须放在集合对象中。 键的名称必须与DDX文档中PDF源属性的值相匹配。 如果DDX文档中的键和源属性匹配,则PDF文件的名称不重要。

注意

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

设置运行时选项

您可以设置运行时选项,以在Assembler服务执行作业时控制其行为。 例如,您可以设置一个选项,指示Assembler服务在遇到错误时继续处理作业。 有关可以设置的运行时选项的信息,请参阅AEM Forms API Reference中的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文档

使用Assembler Service API(Java)汇编PDF文档:

  1. 包括项目文件。

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

  2. 创建PDF Assembler客户端。

    • 创建包含连接属性的ServiceClientFactory对象。
    • 使用AssemblerServiceClient对象的构造函数并传递ServiceClientFactory对象,创建对象。
  3. 引用现有DDX文档。

    • 使用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方法并传递以下必需值:

    • 一个com.adobe.idp.Document对象,它表示要使用的DDX文档
    • 包含要组合的输入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文档。
    注意

    如果将LOG_LEVEL设置为生成日志,则可以使用AssemblerResult对象的getJobLog方法提取日志。

另请参阅

快速开始(SOAP模式):使用Java API汇编PDF文档

包括AEM Forms Java库文件

设置连接属性

使用Web服务API组合PDF文档

使用Assembler Service API(Web服务)汇编PDF文档:

  1. 包括项目文件。

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

    注意

    localhost替换为承载AEM Forms的服务器的IP地址。

  2. 创建PDF Assembler客户端。

    • 使用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身份验证:

      • 为字段AssemblerServiceClient.ClientCredentials.UserName.UserName指定AEM表单用户名。
      • 为字段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方法,用流数据填充字节数组。 传递要读取的字节数组、起始位置和流长度。
    • BLOB对象的MTOM字段指定为字节数组的内容,从而填充该对象。
    • 创建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
    • 通过访问PDF文档的BLOB对象的MTOM属性提取表示PDF数据的二进制数据。 这将返回可写入PDF文件的字节数组。
    注意

    如果LOG_LEVEL设置为生成日志,则可以通过获取AssemblerResult对象jobLog数据成员的值提取日志。

另请参阅

使用MTOM调用AEM Forms

在此页面上