在JEE自定义DSC中使用AEM Forms压缩和解压缩文件

先决知识

在JEE流程管理、基本Java编程和创建自定义组件方面的AEM Forms经验。

其他必需的产品

Java编辑器,如EclipseNetbeans IDE

用户级别

中间

AEM Forms on JEE使开发人员能够创建自定义DSC(文档服务容器),以创建富集的开箱即用功能。 创建此类组件可插入到JEE运行时环境上的AEM Forms,并且可达到预期目的。 本文介绍如何创建自定义ZIP服务,该服务可用于将文件列表压缩为.zip文件,并将.zip解压缩到文档列表。

创建自定义DSC组件

使用两个服务操作创建自定义DSC组件以压缩和解压缩文档列表。 此组件使用java.util.zip包进行压缩和解压缩。 按照以下步骤创建自定义组件:

  1. 将adobe-livecycle-client.jar文件添加到库中
  2. 添加所需的图标
  3. 创建公共类
  4. 创建两个名为UnzipDocument & ZipDocuments的公共方法
  5. 编写压缩和解压缩的逻辑

代码可在此处找到:

/*
 * Custom DSC : ZIP Utility
 * Purpose: This is a LiveCycle ES2 custom component used to Compress & Decompress List of Documents
 * Author: Nithiyanandam Dharmadass
 * Organization: Ministry of Finance, Kingdom of Bahrain
 * Last modified Date: 18/Apr/2011
 */
package nith.lces2.dsc;

import java.util.zip.ZipEntry;
import java.util.zip.ZipInputStream;
import com.adobe.idp.Document;
import java.io.ByteArrayOutputStream;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.zip.ZipOutputStream;

public class ZIPService {

    static final int BUFFER = 2048; // 2MB buffer size

    public java.util.List UnzipDocument(com.adobe.idp.Document zipDocument) throws Exception {
        ZipInputStream zis = new ZipInputStream(zipDocument.getInputStream());

        ZipEntry zipFile;

        List resultList = new ArrayList();

        while ((zipFile = zis.getNextEntry()) != null) {

            ByteArrayOutputStream byteArrayOutStream = new ByteArrayOutputStream();

            int count;  // an int variable to hold the number of bytes read from input stream
            byte data[] = new byte[BUFFER];
            while ((count = zis.read(data, 0, BUFFER)) != -1) {
                byteArrayOutStream.write(data, 0, count);   // write to byte array
            }

            com.adobe.idp.Document unzippedDoc = new Document(byteArrayOutStream.toByteArray());  // create an idp document
            unzippedDoc.setAttribute("file", zipFile.getName());
            unzippedDoc.setAttribute("wsfilename", zipFile.getName());  // update the wsfilename attribute
            resultList.add(unzippedDoc);
        }
        return resultList;  // List of uncompressed documents
    }

    public com.adobe.idp.Document ZipDocuments(java.util.List listOfDocuments,java.lang.String zipFileName) throws Exception {

        if (listOfDocuments == null || listOfDocuments.size() == 0) {
            return null;
        }

        ByteArrayOutputStream byteArrayOutStream = new ByteArrayOutputStream();
        ZipOutputStream zos = new ZipOutputStream(byteArrayOutStream);  // ZIP Output Stream

        for (int i = 0; i < listOfDocuments.size(); i++) {
            Document doc = (Document) listOfDocuments.get(i);
            InputStream docInputStream = doc.getInputStream();
            ZipEntry zipEntry = new ZipEntry(doc.getAttribute("file").toString());
            zos.putNextEntry(zipEntry);
            int count;
            byte data[] = new byte[BUFFER];
            while ((count = docInputStream.read(data, 0, BUFFER)) != -1) {
                zos.write(data, 0, count);  // Read document content and add to zip entry
            }
            zos.closeEntry();
        }
        zos.flush();
        zos.close();

        Document zippedDoc = new Document(byteArrayOutStream.toByteArray());
        if(zipFileName==null || zipFileName.equals(""))
        {
            zipFileName = "CompressedList.zip";
        }
        zippedDoc.setAttribute("file", zipFileName);
        return zippedDoc;
    }
}

创建Component.XML文件

必须在定义服务操作及其参数的包的根文件夹中创建component.xml文件。

component.xml文件如下所示:

<?xml version="1.0" encoding="UTF-8"?>
<component xmlns="http://adobe.com/idp/dsc/component/document">
<!-- Unique id identifying this component -->
   <component-id>ZipService</component-id>

<!-- Version -->
   <version>1.0</version>

<!-- Start of the Service definition -->
   <services>
<!-- Unique name for service descriptor.
           The value is used as the default name for
           deployed services -->
      <service name="ZipService">
<!-- service implementation class definition -->
        <implementation-class>nith.lces2.dsc.ZIPService</implementation-class>

<!-- description -->
        <description>Compress or Decompress list of documents</description>

<!--  You can provide your own icons for a distinct look   -->
          <small-icon>icons/Zip_icon16.png</small-icon>
          <large-icon>icons/Zip_icon32.png</large-icon>


<!-- automatically deploys the service and starts it after installation -->
         <auto-deploy service-id="ZipService" />

         <operations>
<!-- method name in the interface setSmtpHost-->
            <operation name="UnzipDocument">
<!-- input parameters to the "send" method -->
              <input-parameter name="zipDocument" title="Input ZIP Document" type="com.adobe.idp.Document">
                    <hint>A ZIP File to be decompressed</hint>
                </input-parameter>
                <output-parameter name="resultList" title="Decompressed list of documents" type="java.util.List">
                    <hint>Decompressed ZIP list</hint>
                </output-parameter>
            </operation>
            <operation name="ZipDocuments">
<!-- input parameters to the "send" method -->
              <input-parameter name="listOfDocuments" title="List of Documents" type="java.util.List">
                    <hint>A list of documents to be Compressed</hint>
                </input-parameter>
                <input-parameter name="zipFileName" title="Result File Name" type="java.lang.String">
                    <hint>The name of compressed file (optional)</hint>
                </input-parameter>

                <output-parameter name="zippedDoc" title="Compressed Zip file" type="com.adobe.idp.Document">
                    <hint>Compressed ZIP File</hint>
                </output-parameter>
            </operation>
             </operations>
      </service>
   </services>
</component>

打包和部署组件

  1. 编译Java项目并创建.JAR文件。
  2. 通过Workbench将组件(.JAR文件)部署到JEE运行时的AEM Forms。
  3. 从Workbench启动服务(请参阅下图)。

流程设计

在工作流中使用ZIP服务

自定义服务的UnzipDocument操作现在可以接受文档变量作为输入,并返回文档变量列表作为输出。

解压缩文档

同样,自定义组件的ZipDocuments操作也可以接受文档列表作为输入,将其压缩为zip文件,并返回压缩的文档。

邮政编码文档

以下工作流编排展示了如何解压缩给定的ZIP文件,将其压缩回另一个ZIP文件,并返回输出(请参阅下图)。

解压缩Zip工作流

一些业务用例

您可以将此ZIP服务用于以下用例:

  • 在给定文件夹中查找所有文件,并将文件作为压缩文档返回。

  • 提供包含大量PDF文档的ZIP文件,在解压缩后,这些文档可供Reader扩展。 这需要JEEReader扩展模块上的AEM Forms。

  • 提供包含异构类型文档的ZIP文件,此类文档可通过“生成PDF”服务解压缩并转换为PDF文档。

  • 策略可保护文档列表并以ZIP文件形式返回。

  • 允许用户将流程实例的所有附件下载为单个ZIP文件。

在此页面上