Adobe Content Package Maven Plugin

パッケージデプロイメントおよび管理タスクを Maven プロジェクトに組み込むには、Adobe Content Package Maven プラグインを使用します。

構築したパッケージは Adobe Content Package Maven プラグインによって AEM にデプロイされ、通常 AEM Package Manager： を使って実行するタスクの自動化を可能にします。

• ファイルシステム内のファイルから新しいパッケージを作成する。
• AEM にパッケージをインストールまたはアンインストールする。
• AEM で定義済みのパッケージをビルドする。
• AEM にインストールされているパッケージのリストを取得する。
• AEM からパッケージを削除する。

このドキュメントでは、Maven を使用してこれらのタスクを管理する方法について詳しく説明します。また一方、AEM プロジェクトとそのパッケージの構造を理解することも重要です。

パッケージと AEM プロジェクト構造

AEM as a Cloud Service は、最新の AEM プロジェクトアーキタイプによって実装された、パッケージ管理とプロジェクト構造に関する最新のベストプラクティスに従っています。

Content Package Maven Plugin の入手

このプラグインは Maven Central リポジトリーから入手できます。

Content Package Maven Plugin のゴールとパラメーター

Content Package Maven Plugin を使用するには、POM ファイルの build 要素内に次のプラグイン要素を追加します。

<plugin>
 <groupId>com.day.jcr.vault</groupId>
 <artifactId>content-package-maven-plugin</artifactId>
 <version>1.0.4</version>
 <configuration>
       <!-- parameters and values common to all goals, as required -->
 </configuration>
</plugin>

Maven がプラグインをダウンロードできるようにするには、 Content Package Maven プラグインの取得 」セクションに表示されます。

Content Package Maven プラグインの目標

Content Package プラグインが提供する目標と目標のパラメーターは、以降の節で説明します。 共通パラメーターの節で説明したパラメーターは、ほとんどの目標に使用できます。 1 つの目標に適用されるパラメーターについては、その目標の「 」セクションで説明します。

プラグインプレフィックス

プラグインプレフィックスは content-package です。次の例に示すように、コマンドラインからゴールを実行するには、このプレフィックスを使用します。

mvn content-package:build

パラメータープレフィックス

特に指定がない限り、プラグインのゴールおよびパラメーターでは、次の例に示すように vault プレフィックスを使用します。

mvn content-package:install -Dvault.targetURL="https://192.168.1.100:4502/crx/packmgr/service.jsp"

プロキシ

AEM にプロキシを使用するゴールでは、Maven 設定で最初に見つかった有効なプロキシ設定を使用します。プロキシ設定が見つからない場合、プロキシは使用されません。共通パラメーターの節の useProxy パラメーターを参照してください。

共通パラメーター

次の表に示すパラメーターは、すべてのゴールに共通です（ゴール​列に記載されている場合を除く）。

build

AEM インスタンスで既に定義されているコンテンツパッケージをビルドします。

パラメーター

build ゴールのすべてのパラメーターについては、共通パラメーターを参照してください。

install

リポジトリー内のパッケージをインストールします。このゴールの実行に Maven プロジェクトは不要です。このゴールは Maven のビルドライフサイクルの install フェーズにバインドされます。

パラメーター

以下のパラメーターに加えて、 共通パラメーター の説明も参照してください。

ls

パッケージマネージャー にデプロイされているパッケージを一覧表示します。

パラメーター

ls ゴールのすべてのパラメーターについては、共通パラメーターを参照してください。

rm

パッケージマネージャー からパッケージを削除します。

パラメーター

rm ゴールのすべてのパラメーターについては、共通パラメーターを参照してください。

uninstall

パッケージをアンインストールします。 パッケージは、アンインストールされた状態でサーバーに残ります。

パラメーター

uninstall ゴールのすべてのパラメーターについては、共通パラメーターを参照してください。

package

コンテンツパッケージを作成します。package ゴールのデフォルト設定には、コンパイルしたファイルを保存するディレクトリの内容が含まれます。package ゴールを実行するには、compile build フェーズを完了しておく必要があります。package ゴールは Maven のビルドライフサイクルの package フェーズにバインドされます。

パラメーター

以下のパラメーターに加えて、 共通パラメーター の name パラメーターの説明も参照してください。

フィルターの使用

パッケージ内容を定義するには、フィルター要素を使用します。フィルターはパッケージの META-INF/vault/filter.xml ファイルの workspaceFilter 要素に追加されます。

次に示すフィルターの例は、使用する XML 構造を示しています。

<filter>
   <root>/apps/myapp</root>
   <mode>merge</mode>
       <includes>
              <include>/apps/myapp/install/</include>
              <include>/apps/myapp/components</include>
       </includes>
       <excludes>
              <exclude>/apps/myapp/config/*</exclude>
       </excludes>
</filter>

インポートモード

mode 要素は、パッケージが読み込まれる際にリポジトリー内の内容がどのような影響を受けるかを定義します。次の値を使用できます。

• merge：​まだリポジトリーに含まれていないパッケージ内容が追加されます。パッケージとリポジトリーの両方に含まれている内容は変更されません。リポジトリーの内容が削除されることはありません。
• replace：​リポジトリーに含まれていないパッケージ内容がリポジトリーに追加されます。リポジトリー内の内容が、パッケージ内の一致する内容に置き換えられます。パッケージ内に存在しない内容はリポジトリーから削除されます。
• update：​リポジトリーに含まれていないパッケージ内容がリポジトリーに追加されます。リポジトリー内の内容が、パッケージ内の一致する内容に置き換えられます。既存の内容はリポジトリーから削除されます。

フィルターに mode 要素が含まれていない場合は、デフォルト値 replace が使用されます。

help

パラメーター

パッケージへのサムネール画像またはプロパティファイルの追加

デフォルトのパッケージ設定ファイルを置き換えて、パッケージのプロパティをカスタマイズします。 例えば、 パッケージマネージャー でパッケージを区別するためのサムネール画像を含めます。

ソースファイルはファイルシステム内のどこにあっても構いません。POM ファイルでは、ソースファイルを target/vault-work/META-INF にコピーするように、パッケージに追加するビルドリソースを定義します。

次の POM コードでは、プロジェクトソースの META-INF フォルダー内のファイルをパッケージに追加します。

<build>
    <resources>
        <!-- vault META-INF resources (thumbnail etc.) -->
        <resource>
            <directory>${basedir}/src/main/content/META-INF</directory>
            <targetPath>../vault-work/META-INF</targetPath>
        </resource>
    </resources>
</build>

次の POM コードでは、1 つのサムネール画像だけをパッケージに追加します。サムネール画像の名前を thumbnail.png と指定して、パッケージの META-INF/vault/definition フォルダーに配置してください。この例では、ソースファイルはプロジェクトの /src/main/content/META-INF/vault/definition フォルダーにあります。

<build>
    <resources>
        <!-- thumbnail only -->
        <resource>
            <directory>${basedir}/src/main/content/META-INF/vault/definition</directory>
            <targetPath>../vault-work/META-INF/vault/definition</targetPath>
        </resource>
    </resources>
</build>

AEM プロジェクトアーキタイプを使用した AEM プロジェクトの生成

最新の AEM プロジェクトアーキタイプでは、オンプレミス実装でも AMS 実装でも、ベストプラクティスに従ったパッケージ構造を実装しているので、すべての AEM プロジェクトにこのプロジェクトアーキタイプを使用することをお勧めします。

Business.Adobe.com リソース