使用媒體處理常式和工作流程處理資產 processing-assets-using-media-handlers-and-workflows
Adobe Experience Manager Assets提供一組處理資產的預設工作流程和媒體處理常式。 工作流程會定義典型的資產管理和處理任務,然後將特定任務委派給媒體處理程式,例如縮圖產生或中繼資料擷取。
可以定義當特定類型或格式的資產上傳至伺服器時自動執行的工作流程。 處理步驟定義為一系列Experience ManagerAssets媒體處理常式。 Adobe Experience Manager提供 內置處理程式, 而且可以 自訂開發 或透過將程式委派給 命令列工具.
媒體處理常式是Experience Manager Assets內對資產執行特定動作的服務。 例如,當MP3音訊檔案上傳至Experience Manager時,工作流程會觸發MP3處理常式,擷取中繼資料並產生縮圖。 媒體處理常式與工作流程搭配使用。 Experience Manager支援最常見的MIME類型。 您可以執行下列任一操作,對資產執行特定工作
- 延伸或建立工作流程。
- 擴充或建立媒體處理常式。
- 禁用或啟用媒體處理程式。
預設媒體處理常式 default-media-handlers
下列媒體處理常式可在Experience Manager Assets中使用,並處理最常見的MIME類型:
- application/pdf
- application/illustrator
重要 — 上傳MP3檔案時, 使用協力廠商程式庫處理. 如果MP3具有可變位元速率(VBR),則程式庫會計算非精確的約略長度。
- application/java-archive
- application/zip
- image/gif
- image/png
- application/photoshop
- image/jpeg
- image/tiff
- image/x-ms-bmp
- image/bmp
- application/vnd.openxmlformats-officedocument.wordprocessingml.document
- application/vnd.openxmlformats-officedocument.spreadsheetml.sheet
- application/vnd.openxmlformats-officedocument.presentationml.presentation
所有處理程式都執行下列任務:
- 從資產擷取所有可用的中繼資料。
- 從資產中建立縮圖影像。
可以查看活動媒體處理程式:
- 在您的瀏覽器中,導覽至
http://localhost:4502/system/console/components
. - 按一下連結
com.day.cq.dam.core.impl.store.AssetStoreImpl
. - 將顯示包含所有活動媒體處理程式的清單。 例如:
在工作流程中使用媒體處理常式,對資產執行工作 using-media-handlers-in-workflows-to-perform-tasks-on-assets
媒體處理常式是與工作流程搭配使用的服務。
Experience Manager有一些處理資產的預設工作流程。 若要檢視,請開啟「工作流程」主控台,然後按一下 模型 標籤:以Experience Manager Assets開頭的工作流程標題是資產專屬標題。
可擴充現有的工作流程,並建立新的工作流程,以根據特定需求處理資產。
下列範例說明如何增強 AEM Assets同步 工作流程,以便為除PDF檔案外的所有資產產生子資產。
禁用/啟用媒體處理程式 disabling-enabling-a-media-handler
媒體處理常式可透過Apache Felix Web Management Console停用或啟用。 停用媒體處理常式時,不會對資產執行其工作。
要啟用/禁用媒體處理程式:
- 在您的瀏覽器中,導覽至
https://<host>:<port>/system/console/components
. - 按一下 停用 在媒體處理程式的名稱旁邊。 例如:
com.day.cq.dam.handler.standard.mp3.Mp3Handler
。 - 重新整理頁面:媒體處理程式旁會顯示圖示,指出其已停用。
- 要啟用媒體處理程式,請按一下 啟用 在媒體處理程式的名稱旁邊。
建立媒體處理常式 creating-a-new-media-handler
若要支援新的媒體類型或對資產執行特定工作,必須建立媒體處理常式。 本節說明如何繼續。
重要類和介面 important-classes-and-interfaces
開始實作的最佳方式是繼承所提供抽象實作的內容,這種實作會處理大部分內容,並提供合理的預設行為:the com.day.cq.dam.core.AbstractAssetHandler
類別。
此類已提供抽象服務描述符。 因此,如果您從此類繼承並使用maven-sling-plugin,請務必將繼承標幟設為 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,請務必將繼承標幟設為true。
必須實作下列方法:
extractMetadata()
:此方法會擷取所有可用的中繼資料。getThumbnailImage()
:此方法會從傳遞的資產中建立縮圖影像。getMimeTypes()
:此方法會傳回資產MIME類型。
範本範例如下:
package my.own.stuff;/***@scr.component inherit="true" *@scr.service */公用類MyMediaHandler擴展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
類別:此類別可做為所有其他資產處理常式實施的基礎,並提供常用功能以及子資產擷取的常用功能。
範例:建立特定文字處理常式 example-create-a-specific-text-handler
在本節中,將建立特定的文本處理程式,該處理程式將生成帶有水印的縮略圖。
按如下步驟進行:
請參閱 開發工具 使用Maven外掛程式安裝和設定Eclipse,以及設定Maven專案所需的相依性。
執行以下過程後,將txt檔案上載到Experience Manager中時,將提取該檔案的元資料並生成兩個帶有水印的縮略圖。
-
在Eclipse中,建立
myBundle
Maven專案:-
在菜單欄中,按一下 檔案>新增>其他.
-
在對話方塊中,展開Maven資料夾,選取Maven專案,然後按一下 下一個.
-
檢查 建立簡單專案 框和 使用預設工作區位置 框,然後按一下 下一個.
-
使用下列值定義Maven專案:
- 組Id:com.day.cq5.myhandler
- 工件Id:myBundle
- 名稱:我的Experience Manager套件
- 說明:這是我的Experience Manager包
-
按一下 完成.
-
-
將「Java™編譯器」設定為1.5版:
-
以滑鼠右鍵按一下
myBundle
項目,選擇屬性。 -
選擇「Java™編譯器」,並將以下屬性設定為1.5:
- 編譯器合規性級別
- 生成的.class檔案相容性
- 源相容性
-
按一下 「確定」。在對話框窗口中,按一下「是」。
-
-
將pom.xml檔案中的程式碼取代為下列程式碼:
code language-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>
-
建立套件
com.day.cq5.myhandler
包含下面的Java™類myBundle/src/main/java
:- 在myBundle下,按一下右鍵
src/main/java
,依序選取新增和封裝。 - 為其命名
com.day.cq5.myhandler
然後按一下「完成」。
- 在myBundle下,按一下右鍵
-
建立Java™類
MyHandler
:- 在Eclipse,在
myBundle/src/main/java
,按一下右鍵com.day.cq5.myhandler
包,依次選擇新建和類。 - 在對話框窗口中,將Java™類命名為MyHandler,然後按一下「完成」。 Eclipse會建立並開啟檔案MyHandler.java。
- 在
MyHandler.java
使用下列項目取代現有程式碼,然後儲存變更:
code language-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/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; } }
- 在Eclipse,在
-
編譯Java™類並建立包:
- 按一下右鍵myBundle項目,選擇 執行方式,然後 Maven安裝.
- 套件
myBundle-0.0.1-SNAPSHOT.jar
(包含編譯的類)建立於myBundle/target
.
-
在CRX Explorer中,在下方建立節點
/apps/myApp
. 名稱=install
,類型=nt:folder
. -
複製套件組合
myBundle-0.0.1-SNAPSHOT.jar
並儲存在/apps/myApp/install
(例如WebDAV)。 新的文字處理常式現在在Experience Manager中處於作用中狀態。 -
在您的瀏覽器中,開啟Apache Felix Web Management Console。 選擇「元件」頁簽並禁用預設文本處理程式
com.day.cq.dam.core.impl.handler.TextHandler
.
基於命令行的媒體處理程式 command-line-based-media-handler
Experience Manager可讓您在工作流程中執行任何命令列工具,以轉換資產(例如ImageMagick)並將新轉譯新增至資產。 在托管Experience Manager伺服器的磁碟上安裝命令行工具,並向工作流添加和配置進程步驟。 調用的過程,稱為 CommandLineProcess
,會根據特定MIME類型篩選,並根據新轉譯建立多個縮圖。
下列轉換可自動執行,並儲存在 Experience Manager Assets:
- EPS和AI轉換使用 ImageMagick 和 Ghostscript
- 使用FLV視訊轉碼 FFmpeg
- 使用的MP3編碼 跛腳
- 使用 SOX
此 CommandLineProcess
進程按列出順序執行以下操作:
- 如果指定,則根據特定mime類型篩選檔案。
- 在托管Experience Manager伺服器的磁碟上建立臨時目錄。
- 將原始檔案流到臨時目錄。
- 執行由步驟的參數定義的命令。 命令正在臨時目錄內執行,具有用戶運行Experience Manager的權限。
- 將結果串流回Experience Manager伺服器的轉譯資料夾。
- 刪除臨時目錄。
- 根據這些轉譯建立縮圖(如果指定)。 縮圖的數字和尺寸由步驟的參數定義。
使用ImageMagick的範例 an-example-using-imagemagick
以下示例說明如何設定命令行處理步驟。 每次將具有MIME類型gif或Tiff的資產新增至 /content/dam
在Experience Manager伺服器上,原始影像的翻轉影像會與另外三個縮圖(140x100、48x48和10x250)一起建立。
要執行此處理步驟,請使用ImageMagick。 在托管Experience Manager伺服器的磁碟上安裝ImageMagick :
-
安裝ImageMagick。 請參閱 ImageMagick檔案 以取得更多資訊。
-
設定工具以便執行
convert
在命令行上。 -
要查看工具是否已正確安裝,請運行以下命令
convert -h
在命令行上。它會顯示「說明」畫面,其中包含轉換工具的所有可能選項。
note note NOTE 在某些版本的Windows®(例如Windows® SE)中,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
. -
要查看工具是否正常運行,請將JPG映像添加到工作目錄並運行命令
convert <image-name>.jpg -flip <image-name>-flipped.jpg
在命令行上。已翻轉的影像將添加到目錄中。
然後,將命令列處理步驟新增至 DAM更新資產工作流程 :
-
前往 工作流程 控制台。
-
在 模型 頁簽,編輯 DAM更新資產 模型。
-
變更 啟用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
-
儲存工作流程。
若要測試修改的工作流程,請新增資產至 /content/dam
.
- 在檔案系統中,獲取您所選擇的TIFF影像。 將其重新命名為
myImage.tiff
並複製到/content/dam
,例如使用WebDAV。 - 前往 CQ5 DAM 例如,控制台
http://localhost:4502/libs/wcm/core/content/damadmin.html
. - 開啟資產
myImage.tiff
並確認已建立翻轉的影像和三個縮圖。
配置CommandLineProcess進程步驟 configuring-the-commandlineprocess-process-step
本節介紹如何設定 的ProcessCommandLineProcess
參數。區隔 處理參數 使用逗號,且請勿以空白字元開頭值。
可定義多個MIME類型。
可定義數個縮圖。
以下變數可用來建立命令:
${filename}
:輸入檔案的名稱,例如original.jpg${file}
:輸入檔案的完整路徑名,例如/tmp/cqdam0816.tmp/original.jpg${directory}
:輸入檔案的目錄,例如/tmp/cqdam0816.tmp${basename}
:不帶副檔名的輸入檔案的名稱,例如原始${extension}
:輸入檔案的副檔名,例如jpg例如,如果在托管Experience Manager伺服器的磁碟上安裝了ImageMagick,並且您使用 CommandLineProcess 作為實作,而下列值如 處理參數:
mime:image/gif,mime:image/tiff,tn:140:100,tn:48:48,tn:10:250,cmd:convert ${directory}/${filename} -flip ${directory}/${basename}.flipped.jpg
接著,當工作流程執行時,步驟僅會套用至具有 image/gif
或 mime:image/tiff
作為mime類型。 它會建立原始影像的翻轉影像,將其轉換為.jpg,並建立三個具有尺寸的縮圖:140x100、48x48和10x250。
使用下列項目 處理參數 要使用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
使用下列項目 處理參數 要使用ImageMagick建立啟用web的格式副本,請執行以下操作:
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
CommandLineProcess
步驟僅適用於資產(類型的節點) dam:Asset
)或資產的子系。