ワークフローでメディアハンドラーを使用したアセットに対するタスクの実行

メディアハンドラーは、ワークフローで使用されるサービスです。

Experience Manager には、アセットを処理するデフォルトのワークフローがいくつかあります。ワークフローを表示するには、ワークフローコンソールを開き、「モデル」タブをクリックします。Assets から始まるワークフロータイトルは、アセット固有のタイトルです。

特定の要件に従って、既存のワークフローを拡張し、新しいワークフローを作成してアセットを処理できます。

以下の例は、AEM Assets 同期 ​ワークフローを拡張して、PDF ドキュメント以外のすべてのアセットについてサブアセットを生成するための方法を示しています。

メディアハンドラーを無効または有効にする

メディアハンドラーは、Apache Felix web 管理コンソールを通じて無効または有効にすることができます。メディアハンドラーが無効になっている場合、そのタスクはアセットに対して実行されません。

メディアハンドラーを有効/無効にするには:

  1. ブラウザーで、https://<host>:<port>/system/console/components に移動します。
  2. メディアハンドラーの名前の横にある「Disable」をクリックします。例:com.day.cq.dam.handler.standard.mp3.Mp3Handler
  3. ページを更新します。メディアハンドラーの横に、無効であることを示すアイコンが表示されます。
  4. メディアハンドラーを有効にするには、メディアハンドラーの名前の横にある「Enable」をクリックします。

メディアハンドラーを作成する

新しいメディアタイプをサポートしたり、アセットに対して特定のタスクを実行したりするには、メディアハンドラーを作成する必要があります。この節では、続行方法について説明します。

重要なクラスおよびインターフェイス

実装を開始するための最適な方法は、最も多くの点について対応し、適切なデフォルト動作を提供している付属の抽象実装から継承することです。それが com.day.cq.dam.core.AbstractAssetHandler クラスです。

このクラスには、抽象的なサービス記述子が用意されています。そのため、このクラスから継承し、maven-sling-plugin を使用する場合、inherit フラグを true に設定する必要があります。

次のメソッドを実装します。

  • extractMetadata():使用可能なすべてのメタデータを抽出します。
  • getThumbnailImage():渡されたアセットからサムネール画像を作成します。
  • getMimeTypes():アセットの MIME タイプを返します。

以下にテンプレートの例を示します。

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

インターフェイスとクラスには以下が含まれます。

  • com.day.cq.dam.api.handler.AssetHandler インターフェイス:特定の MIME タイプのサポートを追加するサービスを記述します。MIME タイプを追加するには、このインターフェイスを実装する必要があります。このインターフェイスには、特定のドキュメントの読み込みと書き出し、サムネールの作成およびメタデータの抽出をおこなうメソッドがあります。

  • com.day.cq.dam.core.AbstractAssetHandler クラス:その他すべてのアセットハンドラー実装の基礎として機能し、よく使用される機能を提供します。

  • com.day.cq.dam.core.AbstractSubAssetHandler クラス:

    • その他すべてのアセットハンドラー実装の基礎として機能し、よく使用される機能を提供します。さらに、サブアセットの抽出についてよく使用される機能も提供します。
    • 実装を開始するための最適な方法は、最も多くの点について対応し、適切なデフォルト動作を提供している付属の抽象実装から継承することです。それが com.day.cq.dam.core.AbstractAssetHandler クラスです。
    • このクラスには、抽象的なサービス記述子が用意されています。そのため、このクラスから継承し、maven-sling-plugin を使用する場合、inherit フラグを true に設定する必要があります。

以下のメソッドを実装する必要があります。

  • extractMetadata():使用できるすべてのメタデータを抽出します。
  • getThumbnailImage():渡されたアセットのサムネール画像を作成します。
  • getMimeTypes():アセットの MIME タイプを返します。

以下にテンプレートの例を示します。

package my.own.stuff; /&ast;&ast; &ast; @scr.component inherit="true" &ast; @scr.service &ast;/ public class MyMediaHandler extends com.day.cq.dam.core.AbstractAssetHandler

インターフェイスとクラスには以下が含まれます。

  • com.day.cq.dam.api.handler.AssetHandler インターフェイス:特定の MIME タイプのサポートを追加するサービスを記述します。MIME タイプを追加するには、このインターフェイスを実装する必要があります。このインターフェイスには、特定のドキュメントの読み込みと書き出し、サムネールの作成およびメタデータの抽出をおこなうメソッドがあります。
  • com.day.cq.dam.core.AbstractAssetHandler クラス:その他すべてのアセットハンドラー実装の基礎として機能し、よく使用される機能を提供します。
  • com.day.cq.dam.core.AbstractSubAssetHandler クラス:その他すべてのアセットハンドラー実装の基礎として機能し、よく使用される機能を提供します。さらに、サブアセットの抽出についてよく使用される機能も提供します。

例:特定のテキストハンドラーの作成

この節では、透かし入りのサムネールを生成する、特定のテキストハンドラーを作成します。

以下の手順を実行します。

Eclipse に Maven プラグインをインストールして設定する方法、および Maven プロジェクトに必要な依存関係を設定する方法は、開発ツール を参照してください。

以下の手順を実行した後、TXTファイルを Experience Manager にアップロードすると、ファイルのメタデータが抽出され、透かしありの 2 つのサムネールが生成されます。

  1. Eclipse で、myBundle Maven プロジェクトを作成します。

    1. メニューバーで、ファイル新規その他 ​をクリックします。

    2. ダイアログボックスで、Maven フォルダーを展開し、Maven プロジェクトを選択して、「次へ」をクリックします。

    3. 「簡単なプロジェクトを作成する」と「デフォルトのワークスペースの場所を使用する」の各チェックボックスをオンにして、「次へ」をクリックします。

    4. Maven プロジェクトを定義します。

      • グループ Id:com.day.cq5.myhandler
      • アーティファクト Id:myBundle.
      • 名前:My Experience Manager バンドル。
      • 説明:これは Experience Manager バンドルです。
    5. 終了」をクリックします。

  2. Java™ コンパイラーをバージョン 1.5 に設定します。

    1. myBundle プロジェクトを右クリックし、プロパティを選択してください。

    2. Java™ コンパイラーを選択して、次のプロパティを 1.5 に設定します。

      • Compiler compliance level
      • Generated .class files compatibility
      • Source compatibility
    3. OK」をクリックします。ダイアログウィンドウで、「はい」をクリックします。

  3. pom.xml ファイルのコードを以下のコードで書き換えます。

<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>
  1. myBundle/src/main/java の下に Java™ クラスを含むパッケージ com.day.cq5.myhandler を作成します。

    1. myBundle の下の src/main/java を右クリックし、「新規」、「パッケージ」の順に選択してください。
    2. com.day.cq5.myhandler という名前を付け、「終了」をクリックしてください。
  2. Java™ クラス MyHandler を作成します。

    1. Eclipse で myBundle/src/main/java の下の、com.day.cq5.myhandler パッケージを右クリックします。新規、クラスの順に選択します。
    2. ダイアログウィンドウで、Java™ クラスに MyHandler という名前を付け、「終了」をクリックしてください。Eclipse がファイル MyHandler.java を作成し、開きます。
    3. MyHandler.java で、既存のコードを以下のコードに置き換えてから、変更内容を保存してください。
    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/we-retail/en/products/apparel/gloves/Gloves.jpg");
       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 whitespaces in a row we do not 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;
     }
    }
    
  3. Java™ クラスをコンパイルして、バンドルを作成してください。

    1. myBundle プロジェクトを右クリックしてから、次として実行Maven インストール ​の順に選択してください。
    2. バンドル myBundle-0.0.1-SNAPSHOT.jar(コンパイル済みのクラスが含まれる)が myBundle/target の下に作成されます。
  4. CRX Explorer で、/apps/myApp の下にノードを作成します。名前 = install、タイプ = nt:folder

  5. バンドル myBundle-0.0.1-SNAPSHOT.jar をコピーしてから、/apps/myApp/install の下に保存します(WebDAV などを使用)。新しいテキストハンドラーが Experience Manager でアクティブになります。

  6. ブラウザーで、Apache Felix Web Management Console を開きます。コンポーネントタブを選択し、デフォルトのテキストハンドラー com.day.cq.dam.core.impl.handler.TextHandler を無効にしてください。

コマンドラインベースのメディアハンドラー

Experience Manager を使用すると、ワークフロー内で任意のコマンドラインツールを実行して、アセットを変換し(ImageMagick など)、新しいレンディションをアセットに追加できます。コマンドラインツールは、Experience Manager サーバーをホストするディスクにのみインストールし、ワークフローにプロセスステップを追加して設定します。また、CommandLineProcess という起動プロセスによって、特定の MIME タイプに従ってフィルター処理を実行し、新しいレンディションに基づいて複数のサムネールを作成することもできます。

以下の変換を自動的に実行し、Assets 内に保存することができます。

  • ImageMagick および Ghostscript を使用した EPS および AI 変換。
  • FFmpeg を使用した FLV ビデオのトランスコーディング。
  • LAME を使用した MP3 エンコーディング。
  • SOX を使用したオーディオ処理。
NOTE
Windows 以外のシステムでは、ファイル名に一重引用符(')を含むビデオアセットのレンディションの生成中に FFMpeg ツールがエラーを返します。ビデオファイル名に一重引用符が含まれている場合は、Experience Manager にアップロードする前に削除してください。

CommandLineProcess プロセスは、リストに表示されている順序で以下の操作を実行します。

  • MIME タイプを指定した場合、そのタイプに従ってファイルをフィルターします。
  • Experience Manager サーバーをホストするディスクに一時ディレクトリを作成します。
  • 元のファイルを一時ディレクトリにストリーミングします。
  • ステップの引数で定義されたコマンドを実行します。Experience Manager を実行しているユーザーの権限を使用して、一時ディレクトリ内でコマンドが実行されます。
  • 結果を Experience Manager サーバーのレンディションフォルダーにストリーミングします。
  • 一時ディレクトリを削除します。
  • 指定した場合は、それらのレンディションに基づいてサムネールを作成します。サムネールの数とサイズは、ステップの引数で定義されます。

ImageMagick を使用した例

以下の例は、miMIME e-type GIF または TIFF を含むアセットが Experience Manager サーバーの /content/dam に追加されるたびに、元の画像の反転画像が作成されるように、コマンドラインプロセスのステップを設定する方法を示しています。さらに 140 x 100、48 x 48 および 10 x 250 の 3 つのサムネールも作成されます。

そのためには ImageMagick を使用します。ImageMagick は、ビットマップ画像の作成、編集、合成に使用される無料のコマンドラインソフトウェアです。

Experience Manager サーバーをホストするディスクに ImageMagick をインストールします。

  1. ImageMagick のインストール:ImageMagick のドキュメントを参照してください。

  2. コマンドラインで convert を実行できるようにツールを設定します。

  3. ツールが適切にインストールされているかどうかを確認するには、コマンド convert -h をコマンドラインで実行します。

    convert ツールの使用できるすべてのオプションが記載されたヘルプ画面が表示されます。

    NOTE
    Windows のバージョンによっては、「convert」コマンドを実行できない場合があります。このコマンドは、Windows インストールの一部であるネイティブな変換ユーティリティと競合するためです。このような場合は、画像ファイルをサムネールに変換するために使用する ImageMagick ソフトウェアの完全パスを指定します。(例:"C:\Program Files\ImageMagick-6.8.9-Q16\convert.exe" -define jpeg:size=319x319 ${filename} -thumbnail 319x319 cq5dam.thumbnail.319.319.png)。
  4. このツールが正しく実行されていることを確認するには、JPG 画像を作業ディレクトリに追加して、コマンド convert <image-name>.jpg -flip <image-name>-flipped.jpg をコマンドラインで実行します。反転画像がディレクトリに追加されます。コマンドラインプロセスのステップを DAM アセット更新 ​ワークフローに追加します。

  5. ワークフロー ​コンソールを開きます。

  6. モデル」タブで、DAM アセット更新 ​モデルを編集します。

  7. Web 対応レンディション ​手順の引数を mime:image/gif,mime:image/tiff,tn:140:100,tn:48:48,tn:10:250,cmd:convert ${directory}/${filename} -flip ${directory}/${basename}.flipped.jpg に変更します。

  8. ワークフローを保存します。

変更したワークフローをテストするには、/content/dam にアセットを追加します。

  1. ファイルシステムで、任意の TIFF 画像を取得します。名前を myImage.tiff に変更し、WebDAV などを使用して、/content/dam にコピーします。
  2. CQ5 DAM コンソール(例:https://localhost:4502/libs/wcm/core/content/damadmin.html)に移動します。
  3. アセット myImage.tiff を開き、反転画像と 3 つのサムネールが作成されたことを確認します。
前のページAssets のカスタマイズと拡張
次のページ検索機能の拡張

Experience Manager