Processar ativos usando manipuladores de mídia e fluxos de trabalho

O Adobe Experience Manager Assets fornece um conjunto de fluxos de trabalho padrão e manipuladores de mídia para processar ativos. Um fluxo de trabalho define uma tarefa típica de processamento e gerenciamento de ativos e, em seguida, delega as tarefas específicas aos manipuladores de mídia, por exemplo, geração de miniaturas ou extração de metadados.

Um workflow pode ser definido e executado automaticamente quando um ativo de um tipo ou formato específico é carregado no servidor. As etapas de processamento são definidas como uma série de manipuladores de mídia do Experience Manager Assets. O Adobe Experience Manager fornece alguns manipuladores internos, e mais podem ser desenvolvidos ou definidos delegando o processo a uma ferramenta de linha de comando.

Os manipuladores de mídia são serviços no Experience Manager Assets que executam ações específicas em ativos. Por exemplo, quando um arquivo de áudio MP3 é carregado no Experience Manager, um fluxo de trabalho aciona um manipulador MP3 que extrai os metadados e gera uma miniatura. Os manipuladores de mídia são usados com fluxos de trabalho. Os tipos MIME mais comuns são suportados no Experience Manager. Você pode executar tarefas específicas em ativos executando qualquer um dos seguintes procedimentos

• Extensão ou criação de fluxos de trabalho.
• Extensão ou criação de manipuladores de mídia.
• Desativar ou ativar manipuladores de mídia.

Manipuladores de mídia padrão

Os seguintes manipuladores de mídia estão disponíveis no Experience Manager Assets e lidam com os tipos MIME mais comuns:

Todos os manipuladores executam as seguintes tarefas:

• extrair todos os metadados disponíveis do ativo.
• criar uma imagem em miniatura fora do ativo.

É possível visualizar os manipuladores de mídia ativos:

1. No navegador, navegue até http://localhost:4502/system/console/components.
2. Clique no link com.day.cq.dam.core.impl.store.AssetStoreImpl.
3. Uma lista com todos os manipuladores de mídia ativos é exibida. Por exemplo:

Usar manipuladores de mídia em fluxos de trabalho para executar tarefas em Ativos

Os manipuladores de mídia são serviços usados com fluxos de trabalho.

O Experience Manager tem alguns workflows padrão para processar ativos. Para visualizá-los, abra o console Fluxo de trabalho e clique na guia Modelos : os títulos de fluxo de trabalho que começam com o Experience Manager Assets são os específicos dos ativos.

Os workflows existentes podem ser estendidos e novos podem ser criados para processar ativos de acordo com requisitos específicos.

O exemplo a seguir mostra como aprimorar o workflow de Sincronização do AEM Assets para que os subativos sejam gerados para todos os ativos, exceto documentos PDF.

Desabilitar/habilitar um manipulador de mídia

Os manipuladores de mídia podem ser desativados ou ativados por meio do Console de gerenciamento da Web Apache Felix. Quando o manipulador de mídia está desativado, suas tarefas não são executadas nos ativos.

Para ativar/desativar um manipulador de mídia:

1. No navegador, navegue até https://<host>:<port>/system/console/components.
2. Clique em Desativar ao lado do nome do manipulador de mídia. Por exemplo: com.day.cq.dam.handler.standard.mp3.Mp3Handler.
3. Atualize a página: um ícone é exibido ao lado do manipulador de mídia, indicando que está desativado.
4. Para ativar o manipulador de mídia, clique em Ativar ao lado do nome do manipulador de mídia.

Criação de um manipulador de mídia

Para suportar um novo tipo de mídia ou executar tarefas específicas em um ativo, é necessário criar um manipulador de mídia. Esta seção descreve como proceder.

Classes e interfaces importantes

A melhor maneira de iniciar uma implementação é herdar de uma implementação abstrata fornecida que cuida da maioria das coisas e fornece um comportamento padrão razoável: a classe com.day.cq.dam.core.AbstractAssetHandler.

Essa classe já fornece um descritor de serviço abstrato. Portanto, se você herdar dessa classe e usar o maven-sling-plugin, certifique-se de definir o sinalizador de herança como true.

Implemente os seguintes métodos:

• extractMetadata(): extrai todos os metadados disponíveis.
• getThumbnailImage(): cria uma imagem em miniatura do ativo passado.
• getMimeTypes(): retorna os tipos MIME do ativo.

Veja um exemplo de modelo:

package my.own.stuff; /** * @scr.component inherit="true" * @scr.service */ public class MyMediaHandler extends com.day.cq.dam.core.AbstractAssetHandler { // implement the relevant parts }

A interface e as classes incluem:

• com.day.cq.dam.api.handler.AssetHandler interface: Essa interface descreve o serviço que adiciona suporte para tipos MIME específicos. A adição de um tipo MIME requer a implementação dessa interface. A interface contém métodos para importar e exportar os documentos específicos, para criar miniaturas e extrair metadados.
• com.day.cq.dam.core.AbstractAssetHandler classe: Essa classe serve como base para todas as outras implementações do manipulador de ativos e fornece funcionalidade comum usada.
• classe com.day.cq.dam.core.AbstractSubAssetHandler:
  • Essa classe serve como base para todas as outras implementações do manipulador de ativos e fornece a funcionalidade comum usada, além da funcionalidade usada frequentemente na extração de ativos secundários.
  • A melhor maneira de iniciar uma implementação é herdar de uma implementação abstrata fornecida que cuida da maioria das coisas e fornece um comportamento padrão razoável: a classe com.day.cq.dam.core.AbstractAssetHandler .
  • Essa classe já fornece um descritor de serviço abstrato. Portanto, se você herdar dessa classe e usar o maven-sling-plugin, certifique-se de definir o sinalizador de herança como true.

Devem ser aplicados os seguintes métodos:

• extractMetadata(): esse método extrai todos os metadados disponíveis.
• getThumbnailImage(): esse método cria uma imagem em miniatura do ativo passado.
• getMimeTypes(): esse método retorna os tipos MIME do ativo.

Veja um exemplo de modelo:

pacote my.own.stuff; /** * @scr.component hereit="true" * @scr.service */ classe pública MyMediaHandler estende com.day.cq.dam.core.AbstractAssetHandler

A interface e as classes incluem:

• com.day.cq.dam.api.handler.AssetHandler interface: Essa interface descreve o serviço que adiciona suporte para tipos MIME específicos. A adição de um tipo MIME requer a implementação dessa interface. A interface contém métodos para importar e exportar os documentos específicos, para criar miniaturas e extrair metadados.
• com.day.cq.dam.core.AbstractAssetHandler classe: Essa classe serve como base para todas as outras implementações do manipulador de ativos e fornece funcionalidade comum usada.
• com.day.cq.dam.core.AbstractSubAssetHandler classe: Essa classe serve como base para todas as outras implementações do manipulador de ativos e fornece a funcionalidade comum usada, além da funcionalidade usada frequentemente na extração de subativos.

Exemplo: criar um Manipulador de texto específico

Nesta seção, você criará um Manipulador de texto específico que gera miniaturas com uma marca d'água.

Proceda do seguinte modo:

Consulte Ferramentas de desenvolvimento para instalar e configurar o Eclipse com um plug-in Maven e para configurar as dependências necessárias para o projeto Maven.

Após executar o procedimento a seguir, ao fazer upload de um arquivo de texto no Experience Manager, os metadados do arquivo são extraídos e duas miniaturas com uma marca d'água são geradas.

1. No Eclipse, crie myBundle o projeto Maven:

   1. Na barra de Menu, clique em Arquivo > Novo > Outro.

   2. Na caixa de diálogo, expanda a pasta Maven, selecione Projeto Maven e clique em Próximo.

   3. Marque a caixa Create a simple project e a caixa Use default Workspace locations e clique em Next.

   4. Defina o projeto Maven com os seguintes valores:

      • Id Do Grupo: com.day.cq5.myhandler
      • Id Do Artefato: myBundle
      • Nome: Meu pacote de Experience Manager
      • Descrição: Este é o meu pacote Experience Manager

   5. Clique em Concluir.

2. Defina o Compilador Java™ para a versão 1.5:

   1. Clique com o botão direito do mouse no projeto myBundle e selecione Propriedades.

   2. Selecione Java™ Compiler e defina as seguintes propriedades como 1.5:

      • Nível de conformidade do compilador
      • Compatibilidade de arquivos .class gerada
      • Compatibilidade da fonte

   3. Clique em OK. Na janela de diálogo, clique em Sim.

3. Substitua o código no arquivo pom.xml pelo seguinte código:

   <project xmlns="https://maven.apache.org/POM/4.0.0" xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="https://maven.apache.org/POM/4.0.0 https://maven.apache.org/maven-v4_0_0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <!-- ====================================================================== -->
    <!-- P A R E N T P R O J E C T D E S C R I P T I O N -->
    <!-- ====================================================================== -->
    <parent>
     <groupId>com.day.cq.dam</groupId>
     <artifactId>dam</artifactId>
     <version>5.2.14</version>
     <relativePath>../parent</relativePath>
    </parent>
    <!-- ====================================================================== -->
    <!-- P R O J E C T D E S C R I P T I O N -->
    <!-- ====================================================================== -->
    <groupId>com.day.cq5.myhandler</groupId>
    <artifactId>myBundle</artifactId>
    <name>My CQ5 bundle</name>
    <version>0.0.1-SNAPSHOT</version>
    <description>This is my CQ5 bundle</description>
    <packaging>bundle</packaging>
    <!-- ====================================================================== -->
    <!-- B U I L D D E F I N I T I O N -->
    <!-- ====================================================================== -->
    <build>
     <plugins>
      <plugin>
       <groupId>org.apache.felix</groupId>
       <artifactId>maven-scr-plugin</artifactId>
      </plugin>
      <plugin>
       <groupId>org.apache.sling</groupId>
       <artifactId>maven-sling-plugin</artifactId>
       <configuration>
        <slingUrlSuffix>/libs/dam/install/</slingUrlSuffix>
       </configuration>
      </plugin>
      <plugin>
       <groupId>org.apache.felix</groupId>
       <artifactId>maven-bundle-plugin</artifactId>
       <extensions>true</extensions>
       <configuration>
        <instructions>
         <Bundle-Category>cq5</Bundle-Category>
         <Export-Package> com.day.cq5.myhandler </Export-Package>
        </instructions>
       </configuration>
      </plugin>
     </plugins>
    </build>
    <!-- ====================================================================== -->
    <!-- D E P E N D E N C I E S -->
    <!-- ====================================================================== -->
    <dependencies>
     <dependency>
      <groupId>com.day.cq.dam</groupId>
      <artifactId>cq-dam-api</artifactId>
      <version>5.2.10</version>
      <scope>provided</scope>
     </dependency>
     <dependency>
      <groupId>com.day.cq.dam</groupId>
      <artifactId>cq-dam-core</artifactId>
      <version>5.2.10</version>
      <scope>provided</scope>
     </dependency>
     <dependency>
      <groupId>com.day.cq</groupId>
      <artifactId>cq-commons</artifactId>
     </dependency>
     <dependency>
      <groupId>javax.jcr</groupId>
      <artifactId>jcr</artifactId>
     </dependency>
     <dependency>
      <groupId>org.apache.felix</groupId>
      <artifactId>org.osgi.compendium</artifactId>
     </dependency>
     <dependency>
      <groupId>org.slf4j</groupId>
      <artifactId>slf4j-api</artifactId>
     </dependency>
     <dependency>
      <groupId>commons-lang</groupId>
      <artifactId>commons-lang</artifactId>
     </dependency>
     <dependency>
      <groupId>commons-collections</groupId>
      <artifactId>commons-collections</artifactId>
     </dependency>
     <dependency>
      <groupId>commons-io</groupId>
      <artifactId>commons-io</artifactId>
     </dependency>
     <dependency>
      <groupId>com.day.commons</groupId>
      <artifactId>day-commons-gfx</artifactId>
     </dependency>
     <dependency>
      <groupId>com.day.commons</groupId>
      <artifactId>day-commons-text</artifactId>
     </dependency>
     <dependency>
      <groupId>com.day.cq.workflow</groupId>
      <artifactId>cq-workflow-api</artifactId>
     </dependency>
     <dependency>
      <groupId>com.day.cq.wcm</groupId>
      <artifactId>cq-wcm-foundation</artifactId>
      <version>5.2.22</version>
     </dependency>
    </dependencies>
   

4. Crie o pacote com.day.cq5.myhandler que contém as classes Java™ em myBundle/src/main/java:

   1. Em myBundle, clique com o botão direito do mouse em src/main/java, selecione New e Package.
   2. Nomeie-o com.day.cq5.myhandler e clique em Finish.

5. Crie a classe Java™ MyHandler:

   1. No Eclipse, em myBundle/src/main/java, clique com o botão direito do mouse no pacote com.day.cq5.myhandler, selecione New e Class.
   2. Na janela de diálogo, nomeie o Java™ Class MyHandler e clique em Finish. O Eclipse cria e abre o arquivo MyHandler.java.
   3. Em MyHandler.java, substitua o código existente pelo seguinte e salve as alterações:

   package com.day.cq5.myhandler;
   import java.awt.Color;
   import java.awt.Rectangle;
   import java.awt.image.BufferedImage;
   import java.io.IOException;
   import java.io.InputStream;
   import java.io.InputStreamReader;
   import javax.jcr.Node;
   import javax.jcr.RepositoryException;
   import javax.jcr.Session;
   import org.apache.commons.io.IOUtils;
   import org.slf4j.Logger;
   import org.slf4j.LoggerFactory;
   import com.day.cq.dam.api.metadata.ExtractedMetadata;
   import com.day.cq.dam.core.AbstractAssetHandler;
   import com.day.image.Font;
   import com.day.image.Layer;
   import com.day.cq.wcm.foundation.ImageHelper;
   
   /**
    * The <code>MyHandler</code> can extract text files
    * @scr.component inherit="true" immediate="true" metatype="false"
    * @scr.service
    *
    **/
   
   public class MyHandler extends AbstractAssetHandler {
    /** * Logger instance for this class. */
    private static final Logger log = LoggerFactory.getLogger(MyHandler.class);
    /** * Music icon margin */
    private static final int MARGIN = 10;
    /** * @see com.day.cq.dam.api.handler.AssetHandler#getMimeTypes() */
    public String[] getMimeTypes() {
     return new String[] {"text/plain"};
    }
   
    public ExtractedMetadata extractMetadata(Node asset) {
     ExtractedMetadata extractedMetadata = new ExtractedMetadata();
     InputStream data = getInputStream(asset);
     try {
      // read text data
      InputStreamReader reader = new InputStreamReader(data);
      char[] buffer = new char[4096];
      String text = "";
      while (reader.read(buffer) != -1) {
       text += new String(buffer);
      }
      reader.close();
      long wordCount = this.wordCount(text);
      extractedMetadata.setProperty("text", text);
      extractedMetadata.setMetaDataProperty("Word Count",wordCount);
      setMimetype(extractedMetadata, asset);
     } catch (Throwable t) {
      log.error("handling error: " + t.toString(), t);
     } finally {
      IOUtils.closeQuietly(data);
     }
     return extractedMetadata; }
    // ----------------------< helpers >----------------------------------------
    protected BufferedImage getThumbnailImage(Node node) {
     ExtractedMetadata metadata = extractMetadata(node);
     final String text = (String) metadata.getProperty("text");
     // create text layer
     final Layer layer = new Layer(500, 600, Color.WHITE);
     layer.setPaint(Color.black);
     Font font = new Font("Arial", 12);
     String displayText = this.getDisplayText(text, 600, 12);
     if(displayText!=null && displayText.length() > 0) {
      // commons-gfx Font class would throw IllegalArgumentException on empty or null text
      layer.drawText(10, 10, 500, 600, displayText, font, Font.ALIGN_LEFT, 0, 0);
     }
     // create watermark and merge with text layer
     Layer watermarkLayer;
     try {
      final Session session = node.getSession();
      watermarkLayer = ImageHelper.createLayer(session, "/content/dam/geometrixx/icons/certificate.png");
      watermarkLayer.setX(MARGIN);
      watermarkLayer.setY(MARGIN);
      layer.merge(watermarkLayer);
     } catch (RepositoryException e) {
      // TODO Auto-generated catch block
      e.printStackTrace();
     } catch (IOException e) {
      // TODO Auto-generated catch block
      e.printStackTrace(); }
     layer.crop(new Rectangle(510, 600));
     return layer.getImage(); }
    // ---------------< private >-----------------------------------------------
    /**
     * This method cuts lines if the text file is too long..
     * * @param text
     * * text to check
     * * @param height
     * * text box height (px)
     * * @param fontheight
     * * font height (px)
     * * @return the text which will fit into the box
     */
    private String getDisplayText(String text, int height, int fontheight) {
     String trimmedText = text.trim();
     int numOfLines = height / fontheight;
     String lines[] = trimmedText.split("\n");
     if (lines.length <= numOfLines) {
      return trimmedText;
     } else {
      String cuttetText = "";
      for (int i = 0; i < numOfLines; i++) {
       cuttetText += lines[i] + "\n";
      }
      return cuttetText;
     }
    }
    /**
     * * This method counts the number of words in a string
     * * @param text the String whose words would like to be counted
     * * @return the number of words in the string
     * */
    private long wordCount(String text) {
     // We need to keep track of the last character, if we have two whitespace in a row we don't want to double count.
     // The starting of the document is always a whitespace.
     boolean prevWhiteSpace = true;
     boolean currentWhiteSpace = true;
     char c; long numwords = 0;
     int j = text.length();
     int i = 0;
     while (i < j) {
      c = text.charAt(i++);
      if (c == 0) { break; }
      currentWhiteSpace = Character.isWhitespace(c);
      if (currentWhiteSpace && !prevWhiteSpace) { numwords++; }
      prevWhiteSpace = currentWhiteSpace;
     }
     // If we do not end with a whitespace then we need to add one extra word.
     if (!currentWhiteSpace) { numwords++; }
     return numwords;
    }
   }
   

6. Compile a classe Java™ e crie o pacote:

   1. Clique com o botão direito do mouse no projeto myBundle, selecione Executar como, em seguida Instalar Maven.
   2. O pacote myBundle-0.0.1-SNAPSHOT.jar (que contém a classe compilada) é criado em myBundle/target.

7. No CRX Explorer, crie um nó em /apps/myApp. Nome = install, Tipo = nt:folder.

8. Copie o pacote myBundle-0.0.1-SNAPSHOT.jar e armazene-o em /apps/myApp/install (por exemplo, com WebDAV). O novo manipulador de texto agora está ativo no Experience Manager.

9. No seu navegador, abra o Console de Gerenciamento da Web Apache Felix. Selecione a guia Componentes e desative o manipulador de texto padrão com.day.cq.dam.core.impl.handler.TextHandler.

Manipulador de mídia baseado em linha de comando

O Experience Manager permite executar qualquer ferramenta de linha de comando em um fluxo de trabalho para converter ativos (como o ImageMagick) e adicionar a nova representação ao ativo. Instale a ferramenta de linha de comando no disco que hospeda o servidor do Experience Manager e adicione e configure uma etapa do processo para o fluxo de trabalho. O processo invocado, chamado CommandLineProcess, filtra de acordo com tipos MIME específicos e cria várias miniaturas com base na nova representação.

As seguintes conversões podem ser executadas e armazenadas automaticamente em Experience Manager Assets:

• Transformação de EPS e AI usando ImageMagick e Ghostscript
• Transcodificação de vídeo FLV usando FFmpeg
• Codificação MP3 usando LAME
• Processamento de áudio usando SOX

O processo CommandLineProcess executa as seguintes operações na ordem em que são listadas:

• Filtra o arquivo de acordo com tipos MIME específicos, se especificado.
• Cria um diretório temporário no disco que hospeda o servidor Experience Manager.
• Transmite o arquivo original para o diretório temporário.
• Executa o comando definido pelos argumentos da etapa. O comando está sendo executado no diretório temporário com as permissões do usuário que executa o Experience Manager.
• Transmite o resultado de volta para a pasta de renderização do servidor Experience Manager.
• Exclui o diretório temporário.
• Cria miniaturas com base nessas representações, se especificado. O número e as dimensões das miniaturas são definidos pelos argumentos da etapa.

Um exemplo usando o ImageMagick

O exemplo a seguir mostra como configurar a etapa do processo da linha de comando. Toda vez que um ativo com o tipo MIME gif ou tiff é adicionado a /content/dam no servidor do Experience Manager, uma imagem invertida do original é criada junto com mais três miniaturas (140x100, 48x48 e 10x250).

Para fazer essa etapa do processo, use ImageMagick. Instale o ImageMagick no disco que hospeda o servidor Experience Manager:

1. Instale o ImageMagick. Consulte a documentação do ImageMagick para obter mais informações.

2. Configure a ferramenta para poder executar convert na linha de comando.

3. Para ver se a ferramenta está instalada corretamente, execute o seguinte comando convert -h na linha de comando.

   Ele exibe uma tela de Ajuda com todas as opções possíveis da ferramenta de conversão.

   OBSERVAÇÃO

   Em algumas versões do Windows® (por exemplo, Windows® SE), o comando converter falha ao ser executado porque está em conflito com o utilitário de conversão nativo que faz parte da instalação do Windows®. Nesse caso, mencione o caminho completo do utilitário ImageMagick usado para converter arquivos de imagem em miniaturas. Por exemplo, "C:\Program Files\ImageMagick-6.8.9-Q16\convert.exe" -define jpeg:size=319x319 ${filename} -thumbnail 319x319 cq5dam.thumbnail.319.319.png.

4. Para ver se a ferramenta é executada corretamente, adicione uma imagem JPG ao diretório de trabalho e execute o comando convert <image-name>.jpg -flip <image-name>-flipped.jpg na linha de comando.

   Uma imagem invertida é adicionada ao diretório.

Em seguida, adicione a etapa do processo da linha de comando ao fluxo de trabalho Atualizar ativo do DAM:

1. Vá para o console Workflow.

2. Na guia Modelos, edite o modelo Ativo de atualização DAM.

3. Altere as configurações da etapa representação ativada pela Web da seguinte maneira:

   mime:image/gif,mime:image/tiff,tn:140:100,tn:48:48,tn:10:250,cmd:convert ${directory}/${filename} -flip ${directory}/${basename}.flipped.jpg

4. Salve o workflow.

Para testar o fluxo de trabalho modificado, adicione um ativo a /content/dam.

1. No sistema de arquivos, obtenha uma imagem TIFF de sua escolha. Renomeie-o para myImage.tiff e copie-o para /content/dam, por exemplo, usando o WebDAV.
2. Vá para o console CQ5 DAM, por exemplo http://localhost:4502/libs/wcm/core/content/damadmin.html.
3. Abra o ativo myImage.tiff e verifique se a imagem invertida e as três miniaturas foram criadas.

Configurar a etapa do processo CommandLineProcess

Esta seção descreve como definir os Argumentos de processo do CommandLineProcess. Separe os valores de Process Arguments usando uma vírgula e não inicie um valor com um espaço em branco.

Por exemplo, se ImageMagick estiver instalado no disco que hospeda o servidor do Experience Manager e se você criar uma etapa do processo usando CommandLineProcess como Implementação e os seguintes valores como Argumentos de Processo:

mime:image/gif,mime:image/tiff,tn:140:100,tn:48:48,tn:10:250,cmd:convert ${directory}/${filename} -flip ${directory}/${basename}.flipped.jpg

Em seguida, quando o workflow é executado, a etapa se aplica somente a ativos que têm image/gif ou mime:image/tiff como tipos MIME. Ele cria uma imagem invertida do original, a converte em .jpg e cria três miniaturas que têm as dimensões: 140x100, 48x48 e 10x250.

Use os seguintes Argumentos de processo para criar as três miniaturas padrão usando o ImageMagick:

mime:image/tiff,mime:image/png,mime:image/bmp,mime:image/gif,mime:image/jpeg,cmd:convert ${filename} -define jpeg:size=319x319 -thumbnail "319x319>" -background transparent -gravity center -extent 319x319 -write png:cq5dam.thumbnail.319.319.png -thumbnail "140x100>" -background transparent -gravity center -extent 140x100 -write cq5dam.thumbnail.140.100.png -thumbnail "48x48>" -background transparent -gravity center -extent 48x48 cq5dam.thumbnail.48.48.png

Use os seguintes Argumentos de processo para criar a representação ativada pela Web usando o ImageMagick:

mime:image/tiff,mime:image/png,mime:image/bmp,mime:image/gif,mime:image/jpeg,cmd:convert ${filename} -define jpeg:size=1280x1280 -thumbnail "1280x1280>" cq5dam.web.1280.1280.jpeg