动态创建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文档的拆解。

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

步骤摘要 summary-of-steps

要使用动态创建的DDX文档拆分PDF文档,请执行以下任务:

  1. 包括项目文件。
  2. 创建PDF汇编程序客户端。
  3. 创建DDX文档。
  4. 转换DDX文档。
  5. 设置运行时选项。
  6. 拆分PDF文档。
  7. 保存已拆解的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文档

使用Web服务API动态创建DDX文档

包括AEM Forms Java库文件

设置连接属性

以编程方式拆分PDF文档

使用Java API动态创建DDX文档 dynamically-create-a-ddx-document-using-the-java-api

使用Assembler服务API (Java)动态创建DDX文档并拆分PDF文档:

  1. 包括项目文件。

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

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

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

    • 通过调用DocumentBuilderFactorynewInstance方法创建Java DocumentBuilderFactory对象。

    • 通过调用DocumentBuilderFactory对象的newDocumentBuilder方法创建Java DocumentBuilder对象。

    • 调用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);

  4. 转换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方法填充Java ByteArrayOutputStream对象。 传递javax.xml.transform.dom.DOMSourcejavax.xml.transform.stream.StreamResult对象。
    • 创建字节数组并将ByteArrayOutputStream对象的大小分配给字节数组。
    • 通过调用ByteArrayOutputStream对象的toByteArray方法填充字节数组。
    • 使用对象的构造函数并传递字节数组来创建一个com.adobe.idp.Document对象。
  5. 参照要拆解的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对象。
  6. 设置运行时选项。

    • 使用构造函数创建存储运行时选项的AssemblerOptionSpec对象。
    • 通过调用属于AssemblerOptionSpec对象的方法,设置运行时选项以满足您的业务要求。 例如,要指示Assembler服务在发生错误时继续处理作业,请调用AssemblerOptionSpec对象的setFailOnError方法并传递false
  7. 拆分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文档以及发生的任何异常。

  8. 保存已拆解的PDF文档。

    要获取已拆解的PDF文档,请执行以下步骤:

    • 调用AssemblerResult对象的getDocuments方法。 此方法返回java.util.Map对象。
    • 反复查找java.util.Map对象,直到找到结果com.adobe.idp.Document对象。
    • 调用com.adobe.idp.Document对象的copyToFile方法来提取PDF文档。

另请参阅

快速入门(SOAP模式):使用Java API动态创建DDX文档

包括AEM Forms Java库文件

设置连接属性

使用Web服务API动态创建DDX文档 dynamically-create-a-ddx-document-using-the-web-service-api

使用Assembler服务API(Web服务)动态创建DDX文档并拆分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文档。

    • 使用构造函数创建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);

  4. 转换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字段。

  5. 参照要拆解的PDF文档。

    • 使用构造函数创建BLOB对象。 BLOB对象用于存储输入PDF文档。 此BLOB对象作为参数传递给invokeOneDocument
    • 通过调用其构造函数创建System.IO.FileStream对象。 传递一个字符串值,该值表示输入PDF文档的文件位置以及打开文件的模式。
    • 创建用于存储System.IO.FileStream对象的内容的字节数组。 您可以通过获取System.IO.FileStream对象的Length属性来确定字节数组的大小。
    • 通过调用System.IO.FileStream对象的Read方法并传递要读取的字节数组、起始位置和流长度,使用流数据填充字节数组。
    • 通过将BLOB对象的MTOM属性分配给字节数组的内容来填充该对象。
  6. 设置运行时选项。

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

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

    • 表示动态创建的DDX文档的BLOB对象
    • 包含输入PDF文档的mapItem数组
    • 指定运行时选项的AssemblerOptionSpec对象

    invokeDDX方法返回包含作业结果和发生的任何异常的AssemblerResult对象。

  8. 保存已拆解的PDF文档。

    要获取新创建的PDF文档,请执行以下步骤:

    • 访问AssemblerResult对象的documents字段,该字段是包含已拆卸PDF文档的Map对象。
    • Map对象进行迭代以获取每个结果文档。 然后,将该数组成员的value强制转换为BLOB
    • 通过访问其BLOB对象的MTOM属性,提取表示PDF文档的二进制数据。 这会返回一个字节数组,您可以将该字节写出到PDF文件中。

另请参阅

使用MTOM调用AEM Forms

使用SwaRef调用AEM Forms

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