パッケージマネージャー working-with-packages

パッケージを使用すると、リポジトリコンテンツの読み込みと書き出しが可能になります。パッケージを使用すると、新しいコンテンツのインストール、新しい機能のインストール、インスタンス間でのコンテンツの転送、リポジトリコンテンツのバックアップを行うことができます。

パッケージマネージャーを使用すると、開発目的で、AEM インスタンスとローカルファイルシステムの間でパッケージを転送できます。

パッケージとは what-are-packages

パッケージとは、リポジトリコンテンツをファイルシステムのシリアル化形式で保持する zip ファイルであり、コンテナのシリアル化と呼ばれ、使いやすく編集しやすい形式でファイルやフォルダーを表します。パッケージに含まれるコンテンツは、フィルターを使用して定義します。

パッケージには、フィルター定義や読み込み設定情報など、コンテナのメタ情報も含まれています。説明、視覚的な画像、アイコンなど、パッケージの抽出には使用されない追加のコンテンツプロパティをパッケージに含めることができます。これらの追加のコンテンツプロパティは、コンテンツパッケージのコンシューマー向けのもので、情報提供だけを目的としています。

パッケージマネージャー package-manager

パッケージマネージャーは、AEM インストール上のパッケージを管理します。必要な権限の割り当てを行うと、パッケージマネージャーを使用してパッケージの設定、ビルド、ダウンロード、インストールなど様々なアクションを実行できます。

必要な権限 required-permissions

パッケージを作成、変更、アップロード、インストールするには、次のノードで適切な権限が必要です。

パッケージマネージャーへのアクセス accessing

パッケージマネージャーには次の 3 つの方法でアクセスできます。

パッケージマネージャー UI ui

パッケージマネージャーは、次の 4 つの主な機能領域に分かれています。

左側のナビゲーションパネルでオプションをクリックすると、パッケージリストが直ちにフィルタリングされます。

パッケージ名をクリックすると、「パッケージリスト」のエントリが展開され、パッケージの詳細が表示されます。

パッケージの詳細を展開すると、ツールバーのボタンを使用して、パッケージに対して様々なアクションを実行できます。

「その他」ボタンの下には、利用できるアクションが他にもあります。

パッケージのステータス package-status

パッケージリスト内の各エントリには、パッケージのステータスを一目で把握できるステータスインジケーターが表示されます。ステータスの上にマウスポインターを置くと、ステータスの詳細を示すツールヒントが表示されます。

パッケージが変更された、または構築されなかった場合、ステータスは、パッケージを再構築またはインストールするためのクイックアクションを実行するリンクとして表示されます。

パッケージ設定 package-settings

パッケージとは基本的に、一連のフィルターと、これらのフィルターに基づくリポジトリデータです。パッケージマネージャーの UI を使用して、パッケージをクリックし、「編集」ボタンをクリックすると、次の設定を含むパッケージの詳細が表示されます。

一般設定 general-settings

様々なパッケージ設定を編集して、パッケージの説明、依存関係、プロバイダー詳細などの情報を定義できます。

パッケージ設定 ​ダイアログは、パッケージの作成中または編集中に「編集」ボタンから使用できます。変更が完了したら、「 保存」をクリックします。

パッケージサムネール thumbnails

サムネールは、パッケージの内容を、視覚的にすぐに把握できるような表示を提供します。これがパッケージリストに表示され、パッケージやパッケージのクラスを簡単に識別できます。

公式パッケージで使用される規則の例を次に示します。

公式のホットフィックス

拡張機能の公式 AEM インストール

公式サービスパック

パッケージに固有のアイコンを使用します。アドビが使用しているアイコンを再利用しないでください。

パッケージフィルター package-filters

フィルターは、パッケージに含めるリポジトリノードを識別します。フィルター定義 ​によって、以下の情報が指定されます。

「+ 」ボタンを使用して、ルールを追加します。「- 」ボタンを使用してルールを削除します。

ルールは順序に従って適用されるため、必要に応じて​ 上向き ​および​ 下向き ​の矢印ボタンを使用してルールを配置します。

フィルターにはルールを含めないことも、いくつか含めることもできます。ルールを何も定義しない場合、パッケージにはルートパスの下のすべてのコンテンツが含まれます。

1 つのパッケージに対して 1 つまたは複数のフィルター定義を指定できます。複数のルートパスのコンテンツを含めるには、複数のフィルターを使用します。

フィルターを作成する場合、パスを定義するか、正規表現を使用することにより、含めたり除外したりするすべてのノードを指定できます。

パッケージフィルターが定義されるのは、ほとんどの場合、最初にパッケージを作成するときです。 ただし、後で編集することもできますが、後でパッケージを再作成して、新しいフィルター定義に基づいてその内容を更新する必要があります。

依存関係 dependencies

詳細設定 advanced-settings

パッケージスクリーンショット package-screenshots

パッケージに複数のスクリーンショットを添付して、コンテンツがどのように表示されるかを視覚的に示すことができます。

パッケージアクション package-actions

1 つのパッケージで実行できるアクションは多数あります。

パッケージの作成 creating-a-new-package

パッケージを作成した後すぐにビルドする必要はありません。未ビルドパッケージにはコンテンツが含まれず、フィルターデータとパッケージの他のメタデータのみで構成されます。

パッケージのビルド building-a-package

多くの場合、パッケージはパッケージを作成と同時にビルドされますが、後の時点で戻ってビルドまたはリビルドのいずれかを行うことができます。これは、リポジトリ内のコンテンツが変更された場合や、パッケージフィルターが変更された場合に役立ちます。

パッケージの編集 edit-package

パッケージを AEM にアップロードした後は、その設定を変更できます。

変更した内容を反映するには、パッケージを再構築する必要がある場合があります。

パッケージを再度含める rewrapping-a-package

パッケージは、ビルド後に再度含めることができます。再度含めると、パッケージのコンテンツを変更せずに、サムネール、説明などを含まないパッケージ情報を変更します。

他のパッケージバージョンの表示 other-versions

パッケージのすべてのバージョンは他のパッケージとしてリストに表示されるので、パッケージマネージャーは選択したパッケージの他のバージョンを検索できます。

パッケージコンテンツの表示とインストールのテスト viewing-package-contents-and-testing-installation

パッケージがビルドされたら、コンテンツを表示できます。

ファイルシステムへのパッケージのダウンロード downloading-packages-to-your-file-system

パッケージの共有 share

Package Share は、コンテンツパッケージを配布するための一元化されたパブリックサービスです。Package Share は、ソフトウェア配布に取って代わられ、このボタンは機能しなくなりました。

ファイルシステムからのパッケージのアップロード uploading-packages-from-your-file-system

パッケージコンテンツが AEM に存在しますが、コンテンツを使用できるようにするには、パッケージのインストールを行ってください。

パッケージの検証 validating-packages

パッケージは既存のコンテンツを変更する可能性があるので、多くの場合、インストール前にこれらの変更を検証すると便利です。

検証オプション validation-options

パッケージマネージャーは次の検証を実行できます。

OSGi パッケージの読み込みを検証 osgi-package-imports

チェック内容

この検証では、パッケージ内のすべての JAR ファイル（OSGi バンドル）を調べ、それらの manifest.xml（OSGi バンドルが依存しているバージョン付きの依存関係が含まれているファイル）を抽出し、AEM インスタンスが正しいバージョンで依存関係を書き出すかを確認します。

レポート方法

AEM インスタンスで解決できないバージョン付きの依存関係は、パッケージマネージャーのアクティビティログに記載されます。

エラーの状態

未解決の依存関係がある場合、それらの依存関係を持つパッケージ内の OSGi バンドルは開始しません。この結果、起動されていない OSGi バンドルに依存しているものが正しく機能しなくなるため、アプリケーションのデプロイが破損します。

エラーの解決

OSGi バンドルが満たされていないことによるエラーを解決するには、満たされていない読み込みがあるバンドル内の依存関係のバージョンを調整する必要があります。

オーバーレイを検証 overlays

チェック内容

この検証では、インストールするパッケージに、宛先の AEM インスタンスにすでにオーバーレイされているファイルが含まれているかどうかを確認します。

例えば、既存のオーバーレイが /apps/sling/servlet/errorhandler/404.jsp にある場合、/libs/sling/servlet/errorhandler/404.jsp を含むパッケージは、/libs/sling/servlet/errorhandler/404.jsp の既存のファイルを変更します。

レポート方法

そのようなオーバーレイは、パッケージマネージャーのアクティビティログに記載されます。

エラーの状態

パッケージがすでにオーバーレイされているファイルをデプロイしようとしています。したがって、パッケージ内の変更はオーバーレイによって上書きされ（つまり「非表示」となり）、有効になりません。

エラーの解決

この問題を解決するために、/apps のオーバーレイファイルのメンテナンス者は、/libs のオーバーレイファイルへの変更を確認する必要があります。必要に応じて変更をオーバーレイ（/apps）に組み込み、オーバーレイしたファイルを再デプロイします。

ACL を検証 acls

チェック内容

この検証では、どの権限が追加されるか、それらがどのように処理されるか（結合／置換）、および現在の権限が影響を受けるかどうかを確認します。

レポート方法

権限については、パッケージマネージャーのアクティビティログに記載されます。

エラーの状態

明示的なエラーはありません。この検証は、パッケージをインストールすることで新しい ACL 権限が追加されるか、または影響があるかどうかを示すだけです。

エラーの解決

検証によって提供された情報を使用して、影響を受けたノードを CRXDE で確認したり、必要に応じて ACL をパッケージ内で調整したりできます。

検証の実行 performing-validation

パッケージの検証は 2 通りの方法で行うことができます。

検証は、パッケージをアップロードした後で、インストールする前に必ず行う必要があります。

パッケージマネージャーによるパッケージ検証 via-package-manager

HTTP POST リクエストを介したパッケージ検証 via-post-request

POST リクエストの形式は以下のとおりです。

https://<host>:<port>/crx/packmgr/service.jsp?cmd=validate&type=osgiPackageImports,overlays,acls

type パラメーターは、カンマで区切った順不同リストで、次のように構成されます。

明示的に値が渡されなかった場合、type のデフォルト値は osgiPackageImports に設定されます。

cURL を使用している場合は、次のようなステートメントを実行してください。

curl -v -X POST --user admin:admin -F file=@/Users/SomeGuy/Desktop/core.wcm.components.all-1.1.0.zip 'http://localhost:4502/crx/packmgr/service.jsp?cmd=validate&type=osgiPackageImports,overlays,acls'

POST リクエストを介して検証する場合、応答は JSON オブジェクトとして返されます。

パッケージカバレッジの表示 package-coverage

パッケージは、フィルターによって定義されます。パッケージマネージャーで既存のリポジトリコンテンツにパッケージのフィルターを適用して、パッケージのフィルター定義でカバーされるリポジトリのコンテンツを表示できます。

パッケージのインストール installing-packages

パッケージをアップロードすると、パッケージのコンテンツがリポジトリに追加するだけで、アクセスすることはできません。パッケージのコンテンツを使用するには、アップロードしたパッケージをインストールします。

パッケージをインストールする前に、上書きされるコンテンツを含むスナップショットパッケージがパッケージマネージャーによって自動的に作成されます。このスナップショットは、パッケージをアンインストールした場合に再インストールされます。

インストールが正常に完了すると、パッケージリストが更新され、「インストール済み」がパッケージのステータスに表示されます。

パッケージの再インストール reinstalling-packages

パッケージの再インストールでは、すでにインストールされているパッケージに対して、最初にパッケージをインストールした時の処理と同じ手順を実行します。

ファイルシステムベースのアップロードおよびインストール file-system-based-upload-and-installation

パッケージをインストールする際に、完全にパッケージマネージャーなしで済ませることができます。AEM は、ホストマシンのローカルファイルシステム上の特定の場所に配置されたパッケージを検出し、それらを自動的にアップロードしてインストールできます。

インスタンスを実行している場合、install フォルダーへのパッケージにインスタンスを追加すると、直ちにアップロードとインストールが始まります。

インスタンスを実行していない場合、install フォルダーに配置されたパッケージは、起動時にアルファベット順にインストールされます。

パッケージのアンインストール uninstalling-packages

パッケージをアンインストールすると、リポジトリの内容は、インストール前にパッケージマネージャーが自動的に作成したスナップショットに戻ります。

パッケージの削除 deleting-packages

パッケージを削除すると、パッケージマネージャーからその詳細のみが削除されます。このパッケージが既にインストールされている場合、インストール済みのコンテンツは削除されません。

パッケージのレプリケーション replicating-packages

パッケージのコンテンツをレプリケートして、パブリッシュインスタンスにインストールします。

ソフトウェア配布 software-distribution

AEM パッケージを使用すると、AEM 環境全体でコンテンツを作成および共有できます。

ソフトウェア配布は、AEM パッケージの検索とダウンロードを簡素化する一元化されたサービスです。

詳しくは、ソフトウェア配布ドキュメントを参照してください。