エラーハンドラーによって表示されるページのカスタマイズ

最終更新日: 2023-12-18

Adobe Experience Manager(AEM)には、HTTP エラーを処理するための標準的なエラーハンドラーが付属しています。例えば、次のようなメッセージが表示されます。

chlimage_1-67

エラーコードに応答するシステム提供のスクリプトが(/libs/sling/servlet/errorhandler の下に)あります。標準の CQ インスタンスでは、デフォルトで次のスクリプトを使用できます。

  • 403.jsp
  • 404.jsp
メモ

AEM は Apache Sling に基づいています。そのため、Sling エラー処理について詳しくは、エラー処理を参照してください。

メモ

オーサーインスタンスでは、CQ WCM Debug Filter がデフォルトで有効になっています。これにより、常に応答コード 200 を返します。デフォルトのエラーハンドラーは、応答に対してフルスタックトレースを書き込むことで応答します。

パブリッシュインスタンスでは、CQ WCM Debug Filter は、有効として設定されている場合も含めて​常に​無効になります。

エラーハンドラーによって表示されるページのカスタマイズ方法

独自のスクリプトを作成して、エラーの発生時にエラーハンドラーで表示されるページをカスタマイズできます。カスタマイズしたページが /apps の下に作成され、デフォルトのページ(/libs の下)をオーバーレイします。

メモ

詳しくは、オーバーレイの使用を参照してください。

  1. リポジトリ内で、デフォルトスクリプトを次のようにコピーします。

    • コピー元:/libs/sling/servlet/errorhandler/
    • コピー先:/apps/sling/servlet/errorhandler/

    コピー先のパスはデフォルトでは存在しないので、最初は作成する必要があります。

  2. /apps/sling/servlet/errorhandler に移動して、次のいずれかの操作を行います。

    • 既存のスクリプトを編集し、必要な情報を追加します。
    • 必要とするコード用に新しいスクリプトを作成し、編集します。
  3. 変更を保存し、テストします。

注意

404.jsp および 403.jsp ハンドラーは、CQ5 認証に合わせて設計されています。特に、これらのエラーの発生時にシステムログインができるようになっています。

そのため、これらの 2 つのハンドラーを置き換える際には十分に気をつけて作業してください。

HTTP 500 エラーへの応答のカスタマイズ

HTTP 500 エラーはサーバーサイドの例外によって発生します。

リクエストの処理で例外が発生した場合、Apache Sling フレームワーク(AEM の基盤)は次の処理を実行します。

  • 例外をログに記録します

  • 以下のものを返します

    • HTTP 応答コード 500
    • 例外スタックトレース

    これらを応答の本文に返します。

エラーハンドラーで表示されるページをカスタマイズすることで、500.jsp スクリプトを作成できます。ただし、このスクリプトが使用されるのは、HttpServletResponse.sendError(500) が明示的に(例外キャッチャーから)実行される場合に限ります。

それ以外の場合は、応答コードは 500 に設定されますが、500.jsp スクリプトは実行されません。

500 エラーを処理するには、エラーハンドラースクリプトのファイル名を例外クラス(またはスーパークラス)と同じにする必要があります。このような例外をすべて処理するには、スクリプト /apps/sling/servlet/errorhandler/Throwable.jsp または /apps/sling/servlet/errorhandler/Exception.jsp を作成します。

注意

オーサーインスタンスでは、CQ WCM Debug Filter はデフォルトで有効になっています。これにより、常に応答コード 200 を返します。デフォルトのエラーハンドラーは、応答に対してフルスタックトレースを書き込むことで応答します。

カスタムエラーハンドラーの場合、コード 500 を含む応答が必要です。そのため、CQ WCM Debug Filter を無効にする必要があります。そうすることで、応答コード 500 が返され、それによって正しい Sling エラーハンドラーがトリガーされます。

パブリッシュインスタンスでは、CQ WCM Debug Filter は、有効として設定されている場合も含めて​常に​無効になります。

このページ