URL の外部化

最終更新日： 2024年7月15日

作成対象：

  • 開発者

Adobe Experience Manager（AEM）の Externalizer は、あらかじめ設定された DNS を接頭辞として、リソースパス（例えば /path/to/my/page）をプログラム的に外部の絶対URL（例えば https://www.mycompany.com/path/to/my/page）に変換できる OSGi サービスです。

インスタンスが Web レイヤーの背後で実行されている場合、自身の外部向け URL がわかりません。また、リンクをリクエストスコープの範囲外で作成する必要がある場合があります。これらの理由で、このサービスは、そのような外部 URL を設定して組み立てるための一元化された場所を提供します。

このページでは、Externalizer サービスの設定方法と使用方法について説明します。詳しくは、Javadocs を参照してください。

Externalizer サービスの設定

Externalizer サービスでは、プログラムでリソースパスに接頭辞を付けるために使用可能な複数のドメインを一元的に定義できます。各ドメインは一意の名前によって識別され、その名前を使用して、プログラムからそのドメインを参照できます。

Externalizer サービスのドメインマッピングを定義するには：

  1. ツール ​から設定マネージャー、Web コンソール ​の順に移動するか、以下を入力します。

    https://<host>:<port>/system/console/configMgr

  2. 「Day CQ Link Externalizer」をクリックして設定ダイアログボックスを開きます。

    NOTE
    この設定に直接アクセスするためのリンクは https://<host>:<port>/system/console/configMgr/com.day.cq.commons.impl.ExternalizerImpl です。

    aem-externalizer-01

  3. ドメイン ​マッピングを定義します。マッピングは、次のようなコード内でドメインを参照するために使用できる独自の名前、スペース、ドメインにより構成されます。

    <unique-name> [scheme://]server[:port][/contextpath]

    ここで、

    • スキーム ​は http または https ですが、ftp などでもかまいません。

      • 必要に応じて、https を使用して https リンクを強制的に適用します。
      • URL の外部化を要求する際にクライアントコードがスキームを上書きしない場合に使用されます。

    • server はホスト名です（ドメイン名または IP アドレス）。

    • port（オプション）はポート番号です。

    • contextpath（オプション）は、AEM が異なるコンテキストパスの下の Web アプリケーションとしてインストールされている場合に限り設定します。

    例：production https://my.production.instance

    次のマッピング名は事前定義されており、AEM で使用されるので、設定されている必要があります。

    • local - ローカルインスタンス
    • author - オーサリングシステムの DNS
    • publish - 公開 Web サイトの DNS
    NOTE
    カスタム設定を使用すると、production や staging などのカテゴリまたは my-internal-webservice などの AEM 以外の外部システムを追加できます。このような URL をプロジェクトのコードベースの様々な場所にハードコーディングするのを防ぐのに役立ちます。

  4. 「保存」をクリックして変更を保存します。

NOTE
アドビでは、この設定をリポジトリに追加することをお勧めします。

Externalizer サービスの使用

ここでは、Externalizer サービスの使用方法に関するいくつかの例を紹介します。

  1. JSP で Externalizer サービスを取得する：

    Externalizer externalizer = resourceResolver.adaptTo(Externalizer.class);

  2. 「publish」ドメインを付与してパスを外部化するには：

    String myExternalizedUrl = externalizer.publishLink(resolver, "/my/page") + ".html";

    ドメインマッピングが次のような場合：

    • publish https://www.website.com

    myExternalizedUrl が次の値で終わる。

    • https://www.website.com/contextpath/my/page.html

  3. 「author」ドメインを付与してパスを外部化するには：

    String myExternalizedUrl = externalizer.authorLink(resolver, "/my/page") + ".html";

    ドメインマッピングが次のような場合：

    • author https://author.website.com

    myExternalizedUrl が次の値で終わる。

    • https://author.website.com/contextpath/my/page.html

  4. 「local」ドメインを付与してパスを外部化するには：

    String myExternalizedUrl = externalizer.externalLink(resolver, Externalizer.LOCAL, "/my/page") + ".html";

    ドメインマッピングが次のような場合：

    • local https://publish-3.internal

    myExternalizedUrl が次の値で終わる。

    • https://publish-3.internal/contextpath/my/page.html

  5. 他の例については、関連する Javadoc を参照してください。

Experience Manager