Compactação e descompactação de arquivos usando um AEM Forms no DSC personalizado JEE

Última atualização em 2023-09-18

Conhecimento de pré-requisito

Experiência com o AEM Forms no Gerenciamento de processos JEE, programação Java™ básica e criação de componente personalizado.

Outros produtos adicionais obrigatórios

Editor Java™, como Eclipse ou Netbeans IDE

Nível do usuário

Intermediário

O AEM Forms no JEE permite que os desenvolvedores criem o ASC (Acrobat Services Container) personalizado para criar recursos prontos para uso aprimorados. A criação desses componentes pode ser conectada ao ambiente de tempo de execução do AEM Forms no JEE e serve ao propósito pretendido. Este artigo explica como criar um serviço ZIP personalizado que pode ser usado para compactar uma lista de arquivos em um arquivo .zip e descompactar um .zip em uma lista de documentos.

Criação de um componente ASC personalizado

Criar um componente ASC personalizado com duas operações de serviço para que você possa compactar e descompactar uma lista de documentos. Este componente usa o pacote java.util.zip para compactação e descompactação.

Para criar um componente ASC personalizado:

  1. Adicionar o arquivo adobe-livecycle-client.jar à biblioteca
  2. Adicionar os ícones necessários
  3. Criar uma classe pública
  4. Crie dois métodos públicos chamados UnzipDocument e ZipDocuments
  5. Escreva a lógica para compactação e descompactação

O código pode ser encontrado aqui:

/*
 * 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;
    }
}

Criando um arquivo Component.XML

Um arquivo component.xml deve ser criado na pasta raiz do pacote que definiu as operações de serviço e seus parâmetros.

O arquivo component.xml é mostrado aqui:

<?xml version="1.0" encoding="UTF-8"?>
<component xmlns="https://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>

Empacotamento e implantação do componente

  1. Compile o projeto Java™ e crie um arquivo .JAR.
  2. Implante o componente (arquivo .JAR) no AEM Forms no tempo de execução do JEE por meio do Workbench.
  3. Inicie o serviço a partir do Workbench (consulte a Figura abaixo).

Design do processo

Uso do serviço ZIP em workflows

A operação UnzipDocument do serviço personalizado agora pode aceitar uma variável de documento como entrada e retornar uma lista de variáveis de documento como saída.

Descompactar documento

Da mesma forma, a operação ZipDocuments do componente personalizado pode aceitar uma lista de documentos como entrada, compactá-los como um arquivo zip e retornar o documento compactado.

Documento zip

A orquestração de fluxo de trabalho a seguir mostra como descompactar o arquivo ZIP fornecido, compactá-lo novamente em outro arquivo ZIP e retornar a saída (consulte a Figura abaixo).

Fluxo de trabalho do Unzip Zip

Alguns casos de uso de negócios

Você pode usar esse serviço ZIP para os seguintes casos de uso:

  • Localizar todos os arquivos em uma determinada pasta e retornar os arquivos como um documento compactado.

  • Forneça um arquivo ZIP contendo vários documentos PDF que podem ser estendidos pelo leitor após descompactá-los. Isso requer o AEM Forms no módulo de extensões Reader JEE.

  • Forneça um arquivo ZIP contendo um tipo heterogêneo de documento que pode ser descompactado e convertido como documento PDF usando o serviço Generate PDF.

  • A política protege uma lista de documentos e retorna como um arquivo ZIP.

  • Permitir que os usuários baixem todos os anexos de uma instância do processo como um único arquivo ZIP.

Nesta página