动态创建DDX文档 dynamically-creating-ddx-documents
本文档中的示例和示例仅适用于JEE环境上的AEM Forms。
您可以动态创建可用于执行Assembler操作的DDX文档。 通过动态创建DDX文档,可以使用在运行期间获取的DDX文档中的值。 要动态创建DDX文档,请使用属于正在使用的编程语言的类。 例如,如果您使用Java开发客户端应用程序,请使用属于org.w3c.dom.*
包的类。 同样,如果您使用的是Microsoft .NET,请使用属于System.Xml
命名空间的类。
在将DDX文档传递到Assembler服务之前,请将XML从org.w3c.dom.Document
实例转换为com.adobe.idp.Document
实例。 如果您使用Web服务,请将XML从用于创建XML的数据类型(例如,XmlDocument
)转换为BLOB
实例。
对于此讨论,假定已动态创建以下DDX文档。
<?xml version="1.0" encoding="UTF-8"?>
<DDX xmlns="https://ns.adobe.com/DDX/1.0/">
<PDFsFromBookmarks prefix="stmt">
<PDF source="AssemblerResultPDF.pdf"/>
</PDFsFromBookmarks>
</DDX>
此DDX文档可拆卸PDF文档。 建议您熟悉PDF文档的拆解。
步骤摘要 summary-of-steps
要使用动态创建的DDX文档拆分PDF文档,请执行以下任务:
- 包括项目文件。
- 创建PDF汇编程序客户端。
- 创建DDX文档。
- 转换DDX文档。
- 设置运行时选项。
- 拆分PDF文档。
- 保存已拆解的PDF文档。
包含项目文件
在开发项目中包含必要的文件。 如果使用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,则此为必填字段)
创建PDF汇编程序客户端
在以编程方式执行汇编程序操作之前,请先创建汇编程序服务客户端。
创建DDX文档
使用您正在使用的编程语言创建DDX文档。 要创建拆卸PDF文档的DDX文档,请确保它包含PDFsFromBookmarks
元素。 如果您使用Java API,请将用于创建DDX文档的数据类型转换为com.adobe.idp.Document
实例。 如果您正在使用Web服务,请将数据类型转换为BLOB
实例。
转换DDX文档
使用org.w3c.dom
类创建的DDX文档必须转换为com.adobe.idp.Document
对象。 要在使用Java API时执行此任务,请使用Java XML转换类。 如果您使用Web服务,请将DDX文档转换为BLOB
对象。
引用PDF文档进行拆分
要拆分PDF文档,请引用表示要拆分PDF文档的PDF文件。 当传递到Assembler服务时,将为文档中的每个1级书签返回一个单独的PDF文档。
设置运行时选项
您可以设置运行时选项,以控制Assembler服务执行作业时的行为。 例如,您可以设置一个选项,在遇到错误时指示Assembler服务继续处理作业。 要设置运行时选项,请使用AssemblerOptionSpec
对象。
拆分PDF文档
通过调用invokeDDX
操作拆分PDF文档。 传递动态创建的DDX文档。 Assembler服务返回集合对象中已拆解的PDF文档。
保存已拆解的PDF文档
所有已拆解的PDF文档都会在集合对象中返回。 循环访问收藏集对象并将每个PDF文档另存为PDF文件。
另请参阅
使用Java API动态创建DDX文档 dynamically-create-a-ddx-document-using-the-java-api
使用Assembler服务API (Java)动态创建DDX文档并拆分PDF文档:
-
包括项目文件。
在您的Java项目的类路径中包含客户端JAR文件,例如adobe-assembler-client.jar。
-
创建PDF汇编程序客户端。
- 创建包含连接属性的
ServiceClientFactory
对象。 - 使用构造函数创建
AssemblerServiceClient
对象并传递ServiceClientFactory
对象。
- 创建包含连接属性的
-
创建DDX文档。
-
通过调用
DocumentBuilderFactory
类newInstance
方法创建JavaDocumentBuilderFactory
对象。 -
通过调用
DocumentBuilderFactory
对象的newDocumentBuilder
方法创建JavaDocumentBuilder
对象。 -
调用
DocumentBuilder
对象的newDocument
方法以实例化org.w3c.dom.Document
对象。 -
通过调用
org.w3c.dom.Document
对象的createElement
方法创建DDX文档的根元素。 此方法创建表示根元素的Element
对象。 将表示元素名称的字符串值传递给createElement
方法。 将返回值强制转换为Element
。 接下来,通过调用子元素的setAttribute
方法来为其设置值。 最后,通过调用标头元素的appendChild
方法将元素附加到标头元素,并将子元素对象作为参数传递。 以下代码行显示此应用程序逻辑:Element root = (Element)document.createElement("DDX"); root.setAttribute("xmlns","https://ns.adobe.com/DDX/1.0/"); document.appendChild(root);
-
通过调用
Document
对象的createElement
方法创建PDFsFromBookmarks
元素。 将表示元素名称的字符串值传递给createElement
方法。 将返回值强制转换为Element
。 通过调用PDFsFromBookmarks
元素的setAttribute
方法为其设置值。 通过调用DDX元素的appendChild
方法,将PDFsFromBookmarks
元素附加到DDX
元素。 将PDFsFromBookmarks
元素对象作为参数传递。 以下代码行显示此应用程序逻辑:Element PDFsFromBookmarks = (Element)document.createElement("PDFsFromBookmarks"); PDFsFromBookmarks.setAttribute("prefix","stmt"); root.appendChild(PDFsFromBookmarks);
-
通过调用
Document
对象的createElement
方法创建PDF
元素。 传递表示元素名称的字符串值。 将返回值强制转换为Element
。 通过调用PDF
元素的setAttribute
方法为其设置值。 通过调用PDFsFromBookmarks
元素的appendChild
方法,将PDF
元素附加到PDFsFromBookmarks
元素。 将PDF
元素对象作为参数传递。 以下代码行显示了此应用程序逻辑:Element PDF = (Element)document.createElement("PDF"); PDF.setAttribute("source","AssemblerResultPDF.pdf"); PDFsFromBookmarks.appendChild(PDF);
-
-
转换DDX文档。
- 通过调用
javax.xml.transform.Transformer
对象的静态newInstance
方法创建javax.xml.transform.Transformer
对象。 - 通过调用
TransformerFactory
对象的newTransformer
方法创建Transformer
对象。 - 使用构造函数创建
ByteArrayOutputStream
对象。 - 使用构造函数创建
javax.xml.transform.dom.DOMSource
对象。 传递表示DDX文档的org.w3c.dom.Document
对象。 - 使用对象的构造函数创建
javax.xml.transform.dom.DOMSource
对象并传递ByteArrayOutputStream
对象。 - 通过调用
javax.xml.transform.Transformer
对象的transform
方法填充JavaByteArrayOutputStream
对象。 传递javax.xml.transform.dom.DOMSource
和javax.xml.transform.stream.StreamResult
对象。 - 创建字节数组并将
ByteArrayOutputStream
对象的大小分配给字节数组。 - 通过调用
ByteArrayOutputStream
对象的toByteArray
方法填充字节数组。 - 使用对象的构造函数并传递字节数组来创建一个
com.adobe.idp.Document
对象。
- 通过调用
-
参照要拆解的PDF文档。
-
使用
HashMap
构造函数创建用于存储输入PDF文档的java.util.Map
对象。 -
使用对象的构造函数创建
java.io.FileInputStream
对象,并传递要拆解的PDF文档的位置。 -
创建
com.adobe.idp.Document
对象。 传递包含PDF文档的java.io.FileInputStream
对象以进行拆分。 -
通过调用其
put
方法并传递以下参数,向java.util.Map
对象添加一个条目:- 表示键名的字符串值。 此值必须与DDX文档中指定的PDF源元素的值匹配。 (在动态创建的DDX文档中,值为
AssemblerResultPDF.pdf
。) - 包含要拆解的PDF文档的
com.adobe.idp.Document
对象。
- 表示键名的字符串值。 此值必须与DDX文档中指定的PDF源元素的值匹配。 (在动态创建的DDX文档中,值为
-
-
设置运行时选项。
- 使用构造函数创建存储运行时选项的
AssemblerOptionSpec
对象。 - 通过调用属于
AssemblerOptionSpec
对象的方法,设置运行时选项以满足您的业务要求。 例如,要指示Assembler服务在发生错误时继续处理作业,请调用AssemblerOptionSpec
对象的setFailOnError
方法并传递false
。
- 使用构造函数创建存储运行时选项的
-
拆分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
对象,该对象包含已拆解的PDF文档以及发生的任何异常。 - 表示动态创建的DDX文档的
-
保存已拆解的PDF文档。
要获取已拆解的PDF文档,请执行以下步骤:
- 调用
AssemblerResult
对象的getDocuments
方法。 此方法返回java.util.Map
对象。 - 反复查找
java.util.Map
对象,直到找到结果com.adobe.idp.Document
对象。 - 调用
com.adobe.idp.Document
对象的copyToFile
方法来提取PDF文档。
- 调用
另请参阅
使用Web服务API动态创建DDX文档 dynamically-create-a-ddx-document-using-the-web-service-api
使用Assembler服务API(Web服务)动态创建DDX文档并拆分PDF文档:
-
包括项目文件。
创建使用MTOM的Microsoft .NET项目。 确保在设置服务引用时使用以下WSDL定义:
http://localhost:8080/soap/services/AssemblerService?WSDL&lc_version=9.0.1
。note note NOTE 将 localhost
替换为承载AEM Forms的服务器的IP地址。 -
创建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
。
- 将AEM表单用户名分配给字段
-
-
创建DDX文档。
-
使用构造函数创建
System.Xml.XmlElement
对象。 -
通过调用
XmlElement
对象的CreateElement
方法创建DDX文档的根元素。 此方法创建表示根元素的Element
对象。 将表示元素名称的字符串值传递给CreateElement
方法。 通过调用其SetAttribute
方法来设置DDX元素的值。 最后,通过调用XmlElement
对象的AppendChild
方法,将元素附加到DDX文档。 将DDX对象作为参数传递。 以下代码行显示此应用程序逻辑:System.Xml.XmlElement root = ddx.CreateElement("DDX"); root.SetAttribute("xmlns", "https://ns.adobe.com/DDX/1.0/"); ddx.AppendChild(root);
-
通过调用
XmlElement
对象的CreateElement
方法创建DDX文档的PDFsFromBookmarks
元素。 将表示元素名称的字符串值传递给CreateElement
方法。 接下来,通过调用元素的SetAttribute
方法来为其设置值。 通过调用DDX
元素的AppendChild
方法,将PDFsFromBookmarks
元素附加到根元素。 将PDFsFromBookmarks
元素对象作为参数传递。 以下代码行显示此应用程序逻辑:XmlElement PDFsFromBookmarks = ddx.CreateElement("PDFsFromBookmarks"); PDFsFromBookmarks.SetAttribute("prefix", "stmt"); root.AppendChild(PDFsFromBookmarks);
-
通过调用
XmlElement
对象的CreateElement
方法创建DDX文档的PDF
元素。 将表示元素名称的字符串值传递给CreateElement
方法。 接下来,通过调用子元素的SetAttribute
方法来为其设置值。 通过调用PDFsFromBookmarks
元素的AppendChild
方法,将PDF
元素附加到PDFsFromBookmarks
元素。 将PDF
元素对象作为参数传递。 以下代码行显示了此应用程序逻辑:XmlElement PDF = ddx.CreateElement("PDF"); PDF.SetAttribute("source", "AssemblerResultPDF.pdf"); PDFsFromBookmarks.AppendChild(PDF);
-
-
转换DDX文档。
-
使用构造函数创建
System.IO.MemoryStream
对象。 -
使用表示DDX文档的
XmlElement
对象使用DDX文档填充MemoryStream
对象。 调用XmlElement
对象的Save
方法并传递MemoryStream
对象。 -
创建字节数组,并使用
MemoryStream
对象中的数据填充该数组。 以下代码显示此应用程序逻辑:int bufLen = Convert.ToInt32(stream.Length); byte[] byteArray = new byte[bufLen]; stream.Position = 0; int count = stream.Read(byteArray, 0, bufLen);
-
创建
BLOB
对象。 将字节数组分配给BLOB
对象的MTOM
字段。
-
-
参照要拆解的PDF文档。
- 使用构造函数创建
BLOB
对象。BLOB
对象用于存储输入PDF文档。 此BLOB
对象作为参数传递给invokeOneDocument
。 - 通过调用其构造函数创建
System.IO.FileStream
对象。 传递一个字符串值,该值表示输入PDF文档的文件位置以及打开文件的模式。 - 创建用于存储
System.IO.FileStream
对象的内容的字节数组。 您可以通过获取System.IO.FileStream
对象的Length
属性来确定字节数组的大小。 - 通过调用
System.IO.FileStream
对象的Read
方法并传递要读取的字节数组、起始位置和流长度,使用流数据填充字节数组。 - 通过将
BLOB
对象的MTOM
属性分配给字节数组的内容来填充该对象。
- 使用构造函数创建
-
设置运行时选项。
- 使用构造函数创建存储运行时选项的
AssemblerOptionSpec
对象。 - 通过为属于
AssemblerOptionSpec
对象的数据成员分配值,设置运行时选项以满足您的业务要求。 例如,要指示Assembler服务在发生错误时继续处理作业,请将false
分配给AssemblerOptionSpec
对象的failOnError
数据成员。
- 使用构造函数创建存储运行时选项的
-
拆分PDF文档。
调用
AssemblerServiceClient
对象的invokeDDX
方法并传递以下值:- 表示动态创建的DDX文档的
BLOB
对象 - 包含输入PDF文档的
mapItem
数组 - 指定运行时选项的
AssemblerOptionSpec
对象
invokeDDX
方法返回包含作业结果和发生的任何异常的AssemblerResult
对象。 - 表示动态创建的DDX文档的
-
保存已拆解的PDF文档。
要获取新创建的PDF文档,请执行以下步骤:
- 访问
AssemblerResult
对象的documents
字段,该字段是包含已拆卸PDF文档的Map
对象。 - 对
Map
对象进行迭代以获取每个结果文档。 然后,将该数组成员的value
强制转换为BLOB
。 - 通过访问其
BLOB
对象的MTOM
属性,提取表示PDF文档的二进制数据。 这会返回一个字节数组,您可以将该字节写出到PDF文件中。
- 访问
另请参阅