AEM(旧称 CQ)は、以前からオーバーレイという原理を利用して、開発者がコンソールおよびその他の機能(ページオーサリングなど)を拡張し、カスタマイズできるようにしてきました。
オーバーレイは様々なコンテキストで使用される用語です。このコンテキスト(AEM の拡張)では、オーバーレイとは、「事前定義済みの機能に対して独自の定義を強制的に付加する(標準の機能をカスタマイズする)こと」を表します。
標準インスタンスでは、事前定義された機能は /libs
以下に置かれるので、オーバーレイ(カスタマイズ)は /apps
ブランチ以下に定義することが推奨されます。AEM がリソースを検索するときは検索パスを使用します。具体的には、最初に /apps
ブランチを検索し、次に /libs
ブランチを検索します(検索パスは必要に応じて設定可能)。このメカニズムにより、オーバーレイ(およびそこに定義されているカスタマイズ)が優先されることになります。
AEM 6.0 以降、オーバーレイの実装方法と使用方法が次のように変更されました。
AEM 6.0 以降 - Granite 関連のオーバーレイ(つまりタッチ操作対応 UI)
方法
/apps
の下に適切な /libs
構造を再構築します。
これには 1:1 のコピーは不要です。Sling Resource Merger は、必要な元の定義を相互参照するために使用されるからです。Sling Resource Merger は、差分メカニズムによってリソースにアクセスおよびマージするためのサービスを提供します。
変更は /apps
以下で行います。
メリット
/libs
以下の変更に対する堅牢性が高まります。Granite 以外によるオーバーレイおよび AEM 6.0 より前のバージョンでのオーバーレイ
メソッド
コンテンツを /libs
から /apps
にコピーします。
プロパティを含むサブブランチ全体をコピーする必要があります。
変更は /apps
以下で行います。
デメリット
/libs
以下で変更しても変更内容は失われませんが、/apps
以下のオーバーレイでは一部の変更作業をやり直す必要がある場合があります。Sling Resource Merger および関連する手法は、Granite と併用する場合に限り使用できます。つまり、オーバーレイをスケルトン構造で作成する方法は、標準のタッチ操作対応 UI でのみ使用できます。
他の領域(クラシック UI など)でのオーバーレイには、該当するノードとサブ構造全体をコピーして、必要な変更を加えます。
オーバーレイは、コンソールの設定、サイドパネル内にあるアセットブラウザーへの選択カテゴリの作成(ページのオーサリング時に使用)など、多くの変更において推奨される方法です。オーバーレイは、次の理由で必要になります。
/libs
ブランチ**では**変更しないでください。
このブランチは次のように常に変更される可能性があるため、変更内容が失われる可能性があります。
オーバーレイにより、変更を 1 箇所に集中させることができます。そのため、必要に応じて変更の追跡、移行、バックアップ、デバッグを実行しやすくなります。
オーバーレイの場合、配信されるリソースは、取得されたリソースとプロパティの集合体で、定義可能な以下の検索パスに応じます。
OSGi 設定で Apache Sling Resource Resolver Factory 用に定義された、リソースの Resolver Search Path。
/apps
と /libs
で、/apps
のコンテンツの方が /libs
のコンテンツより優先されます(つまり、前者が後者をオーバーレイします)。スクリプトの保存場所への JCR:READ アクセス権を 2 人のサービスユーザーに付与する必要があります。この 2 人のユーザーは、components-search-service(com.day.cq.wcm.core でコンポーネントのアクセス/キャッシュに使用)と sling-scripting(org.apache.sling.servlets.resolver でサーブレットの検索に使用)です。
次の設定も、スクリプトの保存場所に応じて設定する必要があります(この例では /etc、/libs または /apps の下)。
PID = org.apache.sling.jcr.resource.internal.JcrResourceResolverFactoryImpl
resource.resolver.searchpath=["/etc","/apps","/libs"]
resource.resolver.vanitypath.whitelist=["/etc/","/apps/","/libs/","/content/"]
最後に、Servlet Resolver を設定する必要もあります(この例では /etc も追加します)。
PID = org.apache.sling.servlets.resolver.SlingServletResolver
servletresolver.paths=["/bin/","/libs/","/apps/","/etc/","/system/","/index.servlet","/login.servlet","/services/"]
以下のページで、一部の例が紹介されています。