本文档中的示例和示例仅适用于JEE环境上的AEM Forms。
您可以使用Assembler Service API将多个PDF文档组合到一个PDF文档中。 下图显示了三个PDF文档正被合并到一个PDF文档。
要将两个或多个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。
在组装大型文档时添加页眉和页脚时,可能会遇到OutOfMemory
错误,文件将不会组合。 要降低出现此问题的可能性,请向DDX文档添加DDXProcessorSetting
元素,如以下示例所示。
<DDXProcessorSetting name="checkpoint" value="2000" />
可以将此元素添加为DDX
元素的子元素或PDF result
元素的子元素。 此设置的默认值为0(零),它关闭了检查点,DDX的行为就像DDXProcessorSetting
元素不存在一样。 如果遇到OutOfMemory
错误,您可能需要将该值设置为一个整数,通常介于500到5000之间。 小的检查点值导致更频繁的检查点。
要从多个PDF文档组合单个PDF文档,请执行以下任务:
包括项目文件
在开发项目中包含必要的文件。 如果要使用Java创建客户端应用程序,请包含必要的JAR文件。 如果您使用Web服务,请确保包含代理文件。
必须将以下JAR文件添加到项目的类路径中:
如果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
对象中的一些键值和对象类型。
键值 |
对象类型 |
描述 |
---|---|---|
|
|
包含在DDX生成元素中指定的生成文档 |
|
|
包含文档的任何例外 |
|
|
包含作业日志 |
另请参阅
使用Assembler Service API(Java)汇编PDF文档:
包括项目文件。
在Java项目的类路径中包含客户端JAR文件,如adobe-assembler-client.jar。
创建PDF Assembler客户端。
ServiceClientFactory
对象。AssemblerServiceClient
对象的构造函数并传递ServiceClientFactory
对象,创建对象。引用现有DDX文档。
java.io.FileInputStream
对象。com.adobe.idp.Document
对象的构造函数并传递java.io.FileInputStream
对象,创建对象。参考输入PDF文档。
使用HashMap
构造函数创建用于存储输入PDF文档的java.util.Map
对象。
对于每个输入PDF文档,使用其构造函数并传递输入PDF文档的位置来创建java.io.FileInputStream
对象。
对于每个输入PDF文档,创建一个com.adobe.idp.Document
对象,并传递包含PDF文档的java.io.FileInputStream
对象。
对于每个输入文档,通过调用put
方法并传递以下参数,向java.util.Map
对象添加一个条目:
com.adobe.idp.Document
对象(或指定多个文档的java.util.List
对象)。设置运行时选项。
AssemblerOptionSpec
的构造函数创建存储运行时选项的对象。AssemblerOptionSpec
对象的方法,设置运行时选项以满足您的业务要求。 例如,要指示Assembler服务在发生错误时继续处理作业,请调用AssemblerOptionSpec
对象的setFailOnError
方法并传递false
。组合输入的PDF文档。
调用AssemblerServiceClient
对象的invokeDDX
方法并传递以下必需值:
com.adobe.idp.Document
对象,它表示要使用的DDX文档java.util.Map
对象com.adobe.livecycle.assembler.client.AssemblerOptionSpec
对象,它指定运行时选项,包括默认字体和作业日志级别invokeDDX
方法返回一个com.adobe.livecycle.assembler.client.AssemblerResult
对象,其中包含作业的结果和发生的任何异常。
提取结果。
要获取新创建的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文档
使用Assembler Service API(Web服务)汇编PDF文档:
包括项目文件。
创建使用MTOM的Microsoft .NET项目。 确保使用以下WSDL定义:http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1
。
将localhost
替换为承载AEM Forms的服务器的IP地址。
创建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
。引用现有DDX文档。
BLOB
对象的构造函数创建对象。 BLOB
对象用于存储DDX文档。System.IO.FileStream
对象的构造函数并传递一个字符串值来创建对象,该字符串值表示DDX文档的文件位置以及打开文件的模式。System.IO.FileStream
对象的内容。 可以通过获取System.IO.FileStream
对象的Length
属性来确定字节数组的大小。System.IO.FileStream
对象的Read
方法并传递要读取的字节数组、开始位置和流长度,用流数据填充字节数组。MTOM
属性赋予字节数组的内容,填充BLOB
对象。参考输入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文档。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任务执行此文档。)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任务执行此文档。)设置运行时选项。
AssemblerOptionSpec
的构造函数创建存储运行时选项的对象。AssemblerOptionSpec
对象的数据成员分配一个值,设置运行时选项以满足您的业务需求。 例如,要指示Assembler服务在发生错误时继续处理作业,请将false
分配给AssemblerOptionSpec
对象的failOnError
数据成员。组合输入的PDF文档。
调用AssemblerServiceClient
对象的invoke
方法并传递以下值:
BLOB
对象。mapItem
数组。 其键必须与PDF源文件的名称匹配,其值必须是与这些文件对应的BLOB
对象。AssemblerOptionSpec
对象。invoke
方法返回一个AssemblerResult
对象,其中包含作业的结果以及可能发生的任何异常。
提取结果。
要获取新创建的PDF文档,请执行以下操作:
AssemblerResult
对象的documents
字段,该字段是包含结果PDF文档的Map
对象。Map
对象,直到找到与生成文档的名称匹配的键。 然后将该数组成员的value
转换为BLOB
。BLOB
对象的MTOM
属性提取表示PDF数据的二进制数据。 这将返回可写入PDF文件的字节数组。如果LOG_LEVEL
设置为生成日志,则可以通过获取AssemblerResult
对象jobLog
数据成员的值提取日志。
另请参阅