Dispatcher の設定

以下の節では、Dispatcher の様々な側面を設定する方法について説明します。

IPv4 および IPv6 のサポート

AEM と Dispatcher のすべての要素は、IPv4 と IPv6 の両方のネットワークにインストールできます。詳しくは、 IPV4 と IPV6.

Dispatcher の設定ファイル

デフォルトでは、Dispatcher の設定は dispatcher.any テキストファイルに格納されますが、インストール時にこのファイルの名前と場所を変更することができます。

設定ファイルには、Dispatcher の動作を制御する一連の単一値または複数値プロパティが含まれます。

設定例を次に示します。

# name of the dispatcher
/name "internet-server"

# each farm configures a set off (loadbalanced) renders
/farms
 {
  # first farm entry (label is not important, just for your convenience)
   /website
     {
     /clientheaders
       {
       # List of headers that are passed on
       }
     /virtualhosts
       {
       # List of URLs for this Web site
       }
     /sessionmanagement
       {
       # settings for user authentification
       }
     /renders
       {
       # List of AEM instances that render the documents
       }
     /filter
       {
       # List of filters
       }
     /vanity_urls
       {
       # List of vanity URLs
       }
     /cache
       {
       # Cache configuration
       /rules
         {
         # List of cachable documents
         }
       /invalidate
         {
         # List of auto-invalidated documents
         }
       }
     /statistics
       {
       /categories
         {
         # The document categories that are used for load balancing estimates
         }
       }
     /stickyConnectionsFor "/myFolder"
     /health_check
       {
       # Page gets contacted when an instance returns a 500
       }
     /retryDelay "1"
     /numberOfRetries "5"
     /unavailablePenalty "1"
     /failover "1"
     }
 }

設定に影響を与える他のファイルを含めることができます。

例えば、myFarm.any ファイルを /farms の設定に含めるには、次のコードを使用します。

/farms
  {
  $include "myFarm.any"
  }

含めるファイルの範囲を指定するには、アスタリスク (*) をワイルドカードとして使用できます。

例えば、farm_1.any ～ farm_5.any のファイルにファーム 1 ～ 5 が設定されている場合、これらのファイルを次のように含めることができます。

/farms
  {
  $include "farm_*.any"
  }

環境変数の使用

値を直接記述する代わりに、dispatcher.any ファイルの単一値プロパティに環境変数を使用できます。環境変数の値を含めるには、${variable_name} という形式を使用します。

例えば、dispatcher.any ファイルがキャッシュディレクトリと同じディレクトリにある場合、 docroot プロパティは次の場合に使用できます。

/docroot "${PWD}/cache"

もう 1 つの例として、AEM パブリッシュインスタンスのホスト名を格納する PUBLISH_IP という環境変数を作成した場合は、/renders プロパティの次の設定を使用できます。

/renders {
  /0001 {
    /hostname "${PUBLISH_IP}"
    /port "8443"
  }
}

Dispatcher インスタンスの命名

Dispatcher インスタンスを識別する一意の名前を指定するには、/name プロパティを使用します。/name プロパティは、設定構造の最上位プロパティです。

ファームの定義

/farms プロパティは、1 つまたは複数の Dispatcher の動作セットを定義します。各セットは、異なる Web サイトまたは URL に関連付けられます。/farms プロパティには、1 つまたは複数のファームを含めることができます。

/farms プロパティは、設定構造の最上位プロパティです。ファームを定義するには、/farms プロパティに子プロパティを追加します。Dispatcher インスタンス内でファームを一意に識別するプロパティ名を使用してください。

/farmname プロパティは複数値で、次のような Dispatcher 動作を定義する他のプロパティを含みます。

値には、任意の英数字 (a ～ z、0 ～ 9) を含めることができます。 /daycom および /docsdaycom という 2 つのファームのスケルトン定義の例を次に示します。

#name of dispatcher
/name "day sites"

#farms section defines a list of farms or sites
/farms
{
   /daycom
   {
       ...
   }
   /docdaycom
   {
      ...
   }
}

各ファームプロパティには、以下の子プロパティを含めることができます。

デフォルトページの指定（IIS のみ） - /homepage

通過させる HTTP ヘッダーの指定

/clientheaders プロパティでは、Dispatcher がクライアント HTTP 要求からレンダラー（AEM インスタンス）に渡す HTTP ヘッダーのリストを定義します。

デフォルトでは、Dispatcher は標準の HTTP ヘッダーをAEMインスタンスに転送します。 場合によっては、追加のヘッダーを転送したり、特定のヘッダーを削除したりすることがあります。

通過させる一連のヘッダーをカスタマイズした場合は、ヘッダーの完全なリスト（通常はデフォルトで含まれるヘッダーを含む）を指定する必要があります。

例えば、パブリッシュインスタンス向けのページアクティベーション要求を処理する Dispatcher インスタンスには、PATH セクションに /clientheaders ヘッダーが必要です。The PATH ヘッダーは、レプリケーションエージェントと Dispatcher 間の通信を可能にします。

次のコードは、/clientheaders の設定例です。

/clientheaders
  {
  "CSRF-Token"
  "X-Forwarded-Proto"
  "referer"
  "user-agent"
  "authorization"
  "from"
  "content-type"
  "content-length"
  "accept-charset"
  "accept-encoding"
  "accept-language"
  "accept"
  "host"
  "max-forwards"
  "proxy-authorization"
  "proxy-connection"
  "range"
  "cookie"
  "cq-action"
  "cq-handle"
  "handle"
  "action"
  "cqstats"
  "depth"
  "translate"
  "expires"
  "date"
  "dav"
  "ms-author-via"
  "if"
  "lock-token"
  "x-expected-entity-length"
  "destination"
  "PATH"
  }

仮想ホストの識別

/virtualhosts プロパティは、Dispatcher がこのファームに受け入れるすべてのホスト名と URI の組み合わせのリストを定義します。アスタリスク (*) 文字をワイルドカードとして使用できます。 /virtualhosts プロパティの値には、次の形式を使用します。

[scheme]host[uri][*]

次の設定例では、 .com および .ch myCompany のドメイン、および mySubDivision のすべてのドメイン：

   /virtualhosts
    {
    "www.myCompany.com"
    "www.myCompany.ch"
    "www.mySubDivison.*"
    }

次の設定は、すべての ​要求を処理します。

   /virtualhosts
    {
    "*"
    }

仮想ホストの解決

HTTP 要求または HTTPS 要求を受信すると host,、uri および scheme ヘッダーに最適な仮想ホスト値を探します。Dispatcher は、次の順序で virtualhosts プロパティの値を評価します。

Dispatcher は、以下の方法で最良一致の仮想ホスト値を探します。

したがって、デフォルトの仮想ホストを virtualhosts プロパティを dispatcher.any ファイル。

仮想ホストの解決の例

次の例は、 dispatcher.any 2 つの Dispatcher ファームを定義し、各ファームは virtualhosts プロパティ。

/farms
  {
  /myProducts
    {
    /virtualhosts
      {
      "www.mycompany.com/products/*"
      }
    /renders
      {
      /hostname "server1.myCompany.com"
      /port "80"
      }
    }
  /myCompany
    {
    /virtualhosts
      {
      "www.mycompany.com"
      }
    /renders
      {
      /hostname "server2.myCompany.com"
      /port "80"
      }
    }
  }

この例を使用して、次の表に、指定された HTTP 要求に対して解決される仮想ホストを示します。

セキュアセッションの有効化 — /sessionmanagement

レンダーファームにアクセスするためのセキュアセッションを作成し、ユーザーがファーム内のページにアクセスするためにログインする必要があるようにします。 ログイン後、ユーザーはファーム内のページにアクセスできます。詳しくは、 閉じられたユーザーグループの作成 を参照してください。 また、運用を開始する前に、Dispatcher のセキュリティチェックリストを参照してください。

/sessionmanagement プロパティは /farms のサブプロパティです。

/sessionmanagement には、いくつかのサブパラメーターがあります。

/directory（必須）

セッション情報を格納するディレクトリ。ディレクトリが存在しない場合は自動的に作成されます。

/sessionmanagement
  {
  /directory "/usr/local/apache/.sessions"
  }

/encode（オプション）

セッション情報のエンコード方法。用途 md5 md5 アルゴリズムを使用した暗号化の場合、または hex を 16 進数エンコーディング用に作成します。 セッションデータを暗号化すると、ファイルシステムにアクセスできるユーザーはセッションの内容を読み取れません。 デフォルトは、md5 です。

/header（オプション）

認証情報を格納する HTTP ヘッダーまたは cookie の名前。ヘッダーに情報を格納する場合は、HTTP:<header-name> を適用します。cookie に情報を格納する場合は、Cookie:<header-name> を適用します。値を指定しない場合、 HTTP:authorization が使用されます。

/timeout（オプション）

最後の使用から、セッションのタイムアウトまでの秒数。指定されていない場合 "800" が使用されているので、ユーザーの最後の要求の少し後、セッションが 13 分以上タイムアウトします。

設定例を次に示します。

/sessionmanagement
  {
  /directory "/usr/local/apache/.sessions"
  /encode "md5"
  /header "HTTP:authorization"
  /timeout "800"
  }

ページレンダラーの定義

/renders プロパティは、ドキュメントをレンダリングするために Dispatcher が要求を送信する URL を定義します。次の /renders セクションの例では、レンダリングのために単一の AEM インスタンスを識別しています。

/renders
  {
    /myRenderer
      {
      # hostname or IP of the renderer
      /hostname "aem.myCompany.com"
      # port of the renderer
      /port "4503"
      # connection timeout in milliseconds, "0" (default) waits indefinitely
      /timeout "0"
      }
  }

次の /renders セクションの例では、Dispatcher と同じコンピューター上で動作する AEM インスタンスを識別しています。

/renders
  {
    /myRenderer
     {
     /hostname "127.0.0.1"
     /port "4503"
     }
  }

次の /renders セクションの例では、2 つの AEM インスタンス間で平等にレンダリング要求を分配しています。

/renders
  {
    /myFirstRenderer
      {
      /hostname "aem.myCompany.com"
      /port "4503"
      }
    /mySecondRenderer
      {
      /hostname "127.0.0.1"
      /port "4503"
      }
  }

レンダリングオプション

/timeout

AEM インスタンスにアクセスする接続タイムアウトをミリ秒単位で指定します。デフォルトはです。 "0"を呼び出し、Dispatcher が無期限に待機します。

/receiveTimeout

応答が返るまでに許容される時間をミリ秒単位で指定します。デフォルトはです。 "600000":Dispatcher が 10 分間待機します。 設定 "0" タイムアウトを排除します。

応答ヘッダーの解析中にタイムアウトに達した場合は、HTTP ステータス 504（Bad Gateway）が返されます。応答本文が読み取られる間にタイムアウトに達した場合、Dispatcher は不完全な応答をクライアントに返します。 また、書き込まれた可能性のあるキャッシュファイルも削除します。

/ipv4

レンダーの IP アドレスを取得するために Dispatcher が getaddrinfo 関数（IPv6 用）を使用するか gethostbyname 関数（IPv4 用）を使用するかを指定します。値 0 を指定すると、getaddrinfo が使用されます。値： 1 原因 gethostbyname を使用します。 デフォルト値は 0 です。

The getaddrinfo 関数は、IP アドレスのリストを返します。 Dispatcher は、TCP/IP 接続が確立されるまで、アドレスのリストを反復します。 したがって、 ipv4 プロパティは、レンダーホスト名が、 getaddrinfo 関数を使用すると、常に同じ順序の IP アドレスのリストを返します。 この場合、 gethostbyname 関数を使用して、Dispatcher が接続する IP アドレスがランダム化されるようにします。

Amazon Elastic Load Balancing(ELB) は、getaddrinfo に対応するサービスで、IP アドレスの同じ順序のリストを使用します。

/secure

次の場合、 /secure プロパティの値は "1"の場合、Dispatcher は HTTPS を使用してAEMインスタンスと通信します。 詳しくは、Using SSL with Dispatcher を参照してください。

/always-resolve

Dispatcher バージョン 4.1.6 では、次のように /always-resolve プロパティを設定できます。

また、次の例に示すように、このプロパティは動的な IP 解決の問題が発生した場合にも使用できます。

/renders {
  /0001 {
     /hostname "host-name-here"
     /port "4502"
     /ipv4 "1"
     /always-resolve "1"
     }
  }

コンテンツへのアクセスの設定

Dispatcher が受け入れる HTTP 要求を指定するには、/filter セクションを使用します。それ以外のすべての要求は、エラーコード 404（ページが見つかりません）で Web サーバーに返送されます。/filter セクションが存在しない場合は、すべての要求が受け入れられます。

注意： ​statfile に対する要求は常に拒否されます。

The /filter セクションは、HTTP 要求の要求行部分のパターンに従ってコンテンツへのアクセスを拒否または許可する一連のルールで構成されます。 に対して許可リストに加える戦略を使用 /filter セクション：

フィルターの定義

/filter の各アイテムには、要求行の特定の要素または要求行全体と照合するタイプとパターンが含まれます。各フィルターには、次のアイテムを含めることができます。

HTTP 要求の要求行部分

HTTP/1.1 では リクエストライン 次のように指定します。

Method Request-URI HTTP-Version<CRLF>

The <CRLF> 文字は、キャリッジリターンとそれに続くラインフィードを表します。 次の例は、クライアントが WKND サイトの US-English ページをリクエストしたときに受け取るリクエスト行です。

GET /content/wknd/us/en.html HTTP.1.1<CRLF>

パターンは、要求行と <CRLF> 文字。

二重引用符と一重引用符

フィルタールールを作成する場合、単純なパターンには二重引用符を使用します（例："pattern"）。Dispatcher 4.2.0 以降を使用しており、パターンに正規表現が含まれている場合は、正規表現パターンを一重引用符で囲む必要があります（例：'(pattern1|pattern2)'）。

正規表現

4.2.0 より後のバージョンの Dispatcher では、フィルターパターンに POSIX 拡張正規表現を含めることができます。

フィルターのトラブルシューティング

フィルターが想定どおりにトリガーされない場合は、を有効にします。 トレースログ Dispatcher 上で実行し、要求を傍受しているフィルターを確認できるようにします。

サンプルフィルター：すべて拒否

以下のサンプルのフィルターセクションを使用すると、Dispatcher がすべてのファイルに対する要求を拒否します。 すべてのファイルへのアクセスを拒否し、特定の領域へのアクセスを許可します。

/0001  { /type "deny" /url "*"  }

明示的に拒否された領域への要求に対して、404 エラーコード（ページが見つかりません）が返される。

サンプルフィルター：特定の領域へのアクセスを拒否

また、フィルターを使用して、ASP ページやパブリッシュインスタンス内の機密領域など、様々な要素へのアクセスを拒否することもできます。 次のフィルターは、ASP ページへのアクセスを拒否するものです。

/0002  { /type "deny" /url "*.asp"  }

サンプルフィルター：POST要求の有効化

次のサンプルフィルターを使用して、POST メソッドでフォームデータを送信できます。

/filter {
    /0001  { /glob "*" /type "deny" }
    /0002 { /type "allow" /method "POST" /url "/content/[.]*.form.html" }
}

サンプルフィルター：ワークフローコンソールへのアクセスを許可

次の例は、Workflow コンソールへの外部アクセスを許可するために使用するフィルターを示しています。

/filter {
    /0001  { /glob "*" /type "deny" }
    /0002  {  /type "allow"  /url "/libs/cq/workflow/content/console*"  }
}

パブリッシュインスタンスで Web アプリケーションコンテキスト（パブリッシュなど）を使用する場合は、フィルター定義に追加することもできます。

/0003   { /type "deny"  /url "/publish/libs/cq/workflow/content/console/archive*"  }

制限された領域内の単一のページにアクセスする必要がある場合は、それらのページへのアクセスを許可できます。 例えば、ワークフローコンソール内の「アーカイブ」タブにアクセスできるようにするには、次のセクションを追加します。

/0004  { /type "allow"  /url "/libs/cq/workflow/content/console/archive*"   }

サンプルフィルター：正規表現の使用

このフィルターは、一重引用符で囲んで定義された正規表現を使用して、非公開コンテンツディレクトリ内の拡張を有効にします。

/005  {  /type "allow" /extension '(css|gif|ico|js|png|swf|jpe?g)' }

サンプルフィルター：要求 URL の追加要素のフィルタリング

以下に、 /content パスとそのサブツリー（path、selector および extensions に対するフィルターを使用）:

/006 {
        /type "deny"
        /path "/content/*"
        /selectors '(feed|rss|pages|languages|blueprint|infinity|tidy|sysview|docview|query|jcr:content|_jcr_content|search|childrenlist|ext|assets|assetsearch|[0-9-]+)'
        /extension '(json|xml|html|feed))'
        }

/filter セクションの例

Dispatcher を設定する場合は、外部アクセスをできるだけ制限する必要があります。 次の例では、外部訪問者に対するアクセスを最小限に抑えます。

フィルターを作成した後、 ページアクセスのテスト AEMインスタンスのセキュリティを確保するため。

次の /filter のセクション dispatcher.any ファイルは、 Dispatcher 設定ファイル。

このサンプルは、Dispatcher に付属するデフォルトの設定ファイルをベースとしており、実稼動環境での使用例の役割を果たすことを目的としています。プレフィックスが付いた項目 # は非アクティブ化（コメントアウト）されています。 これらの項目をアクティベートする場合 ( # を設定します )。 これは、セキュリティに影響を与える可能性があります。

すべてに対するアクセスを拒否し、特定の（制限された）要素へのアクセスを許可します。

  /filter
      {
      # Deny everything first and then allow specific entries
      /0001  { /type "deny" /url "*"  }

      # Open consoles
#     /0011 { /type "allow" /url "/admin/*"  }  # allow servlet engine admin
#     /0012 { /type "allow" /url "/crx/*"    }  # allow content repository
#     /0013 { /type "allow" /url "/system/*" }  # allow OSGi console

      # Allow non-public content directories
#     /0021 { /type "allow" /url "/apps/*"   }  # allow apps access
#     /0022 { /type "allow" /url "/bin/*"    }
      /0023 { /type "allow" /url "/content*" }  # disable this rule to allow mapped content only

#     /0024 { /type "allow" /url "/libs/*"   }
#     /0025 { /type "deny"  /url "/libs/shindig/proxy*" } # if you enable /libs close access to proxy

#     /0026 { /type "allow" /url "/home/*"   }
#     /0027 { /type "allow" /url "/tmp/*"    }
#     /0028 { /type "allow" /url "/var/*"    }

      # Enable extensions in non-public content directories, using a regular expression
      /0041
        {
        /type "allow"
        /extension '(css|gif|ico|js|png|swf|jpe?g)'
        }

      # Enable features
      /0062 { /type "allow" /url "/libs/cq/personalization/*"  }  # enable personalization

      # Deny content grabbing, on all accessible pages, using regular expressions
      /0081
        {
        /type "deny"
        /selectors '((sys|doc)view|query|[0-9-]+)'
        /extension '(json|xml)'
        }
      # Deny content grabbing for /content and its subtree
      /0082
        {
        /type "deny"
        /path "/content/*"
        /selectors '(feed|rss|pages|languages|blueprint|infinity|tidy)'
        /extension '(json|xml|html)'
        }

#     /0087 { /type "allow" /method "GET" /extension 'json' "*.1.json" }  # allow one-level json requests
}

アクセスを拡張する場合は、次の推奨事項を考慮してください。

インストールによっては、/apps、/libs またはその他の場所（使用可能にする必要があります）の下に、追加のリソースが存在する場合があります。外部からアクセスされるリソースを判別するための方法として、access.log ファイルを使用することができます。

クエリ文字列の制限

Dispatcher バージョン 4.1.5 以降では、/filter セクションを使用してクエリ文字列を制約します。allow フィルター要素を使用して、クエリ文字列を明示的に許可し、一般的な許可を除外することを強くお勧めします。

1 つのエントリに、 glob または組み合わせ method, url, query、および versionですが、両方ではありません。 以下の例では、a=* ノードに解決される URL に対してクエリ文字列 /etc を許可し、その他すべてのクエリ文字列を拒否しています。

/filter {
 /0001 { /type "deny" /method "POST" /url "/etc/*" }
 /0002 { /type "allow" /method "GET" /url "/etc/*" /query "a=*" }
}

/filter {
>/0001 { /type "deny" /method "*" /url "/path/*" }
>/0002 { /type "allow" /method "GET" /url "/path/*" }
>/0003 { /type "deny" /method "GET" /url "/path/*" /query "*" }
>/0004 { /type "allow" /method "GET" /url "/path/*" /query "a=*" }
}

Dispatcher のセキュリティのテスト

AEMパブリッシュインスタンス上の次のページおよびスクリプトへのアクセスは、Dispatcher フィルターによってブロックされる必要があります。 Web ブラウザーを使用して、サイト訪問者がおこなうように次のページを開き、コード 404 が返されることを確認します。 他の結果が得られた場合は、フィルタを調整します。

次の場合、通常のページレンダリングが表示されます。 /content/add_valid_page.html?debug=layout.

匿名書き込みアクセスが有効かどうかを判断するには、ターミナルまたはコマンドプロンプトで次のコマンドを実行します。 ノードにデータを書き込めないはずです。

curl -X POST "https://anonymous:anonymous@hostname:port/content/usergenerated/mytestnode"

Dispatcher キャッシュを無効にして、コード 403 の応答を受け取るようにするには、ターミナルまたはコマンドプロンプトで次のコマンドを発行します。

curl -H "CQ-Handle: /content" -H "CQ-Path: /content" https://yourhostname/dispatcher/invalidate.cache

バニティー URL へのアクセスの有効化

AEMページ用に設定されたバニティー URL へのアクセスを有効にするように Dispatcher を設定します。

バニティー URL へのアクセスが有効な場合、Dispatcher は定期的にレンダーインスタンス上で実行されるサービスを呼び出し、バニティー URL のリストを取得します。 Dispatcher はこのリストをローカルファイルに保存します。 ページの要求が /filter セクションのフィルターによって拒否されると、Dispatcher はバニティー URL のリストを調べます。拒否された URL がリストにある場合、Dispatcher はバニティー URL へのアクセスを許可します。

バニティー URL へのアクセスを有効にするには、以下の例のような /vanity_urls セクションを /farms セクションに追加します。

 /vanity_urls {
      /url "/libs/granite/dispatcher/content/vanityUrls.html"
      /file "/tmp/vanity_urls"
      /delay 300
 }

/vanity_urls セクションには、以下のプロパティが含まれます。

バニティー URL へのアクセスを有効にするには、以下の手順を実行します。

シンジケーション要求の転送 — /propagateSyndPost

シンジケーション要求は Dispatcher 専用なので、デフォルトではレンダラー (AEMインスタンスなど ) に送信されません。

必要に応じて、 /propagateSyndPost プロパティを "1" シンジケーション要求を Dispatcher に転送する場合。 設定する場合、フィルターセクションで POST 要求が拒否されていないことを確認する必要があります。

Dispatcher キャッシュの設定 — /cache

/cache セクションは、Dispatcher によるドキュメントのキャッシュ方法を制御します。次のいくつかのサブプロパティを設定して、キャッシュ戦略を実装します。

キャッシュセクションの例を次に示します。

/cache
  {
  /docroot "/opt/dispatcher/cache"
  /statfile  "/tmp/dispatcher-website.stat"
  /allowAuthorized "0"

  /rules
    {
    # List of files that are cached
    }

  /invalidate
    {
    # List of files that are auto-invalidated
    }
  }

キャッシュディレクトリの指定

/docroot プロパティは、キャッシュされたファイルを保存するディレクトリを識別します。

複数のファームを使用する場合は、ファームごとに異なるドキュメントルートを使用する必要があります。

statfile の命名

/statfile プロパティは、statfile として使用するファイルを識別します。Dispatcher は、このファイルを使用して、最新のコンテンツ更新の時刻を登録します。 statfile は、Web サーバー上の任意のファイルにすることができます。

statfile にはコンテンツがありません。 コンテンツが更新されると、Dispatcher がタイムスタンプを更新します。 デフォルトの statfile の名前はです。 .stat とは docroot に保存されます。 Dispatcher は、statfile へのアクセスをブロックします。

エラー発生時の古くなったドキュメントの提供

/serveStaleOnError プロパティは、レンダーサーバーがエラーを返した場合に Dispatcher が無効になったドキュメントを返すかどうかを制御します。デフォルトでは、statfile にアクセスし、キャッシュされたコンテンツが無効になると、Dispatcher は次回要求時にキャッシュされたコンテンツを削除します。

次の場合 /serveStaleOnError が "1"に設定すると、レンダーサーバーが成功応答を返さない限り、Dispatcher は無効になったコンテンツをキャッシュから削除しません。 AEM からの応答 5xx または接続タイムアウトによって、Dispatcher は期限切れのコンテンツを返し、HTTP ステータス 111（再検証失敗）で応答します。

認証使用時のキャッシュ

/allowAuthorized プロパティは、以下のいずれかの認証情報を含む要求をキャッシュするかどうかを制御します。

デフォルトでは、この認証情報を含む要求は、キャッシュされたドキュメントがクライアントに返されたときに認証が実行されないので、キャッシュされません。 この設定により、Dispatcher は、必要な権限を持たないユーザーに対して、キャッシュされたドキュメントを提供できなくなります。

ただし、認証済みドキュメントのキャッシュが要件によって許可されている場合は、 /allowAuthorized を 1 に変更します。

/allowAuthorized "1"

キャッシュするドキュメントの指定

/rules プロパティは、ドキュメントパスに応じてキャッシュされるドキュメントを制御します。/rules プロパティにかかわらず、Dispatcher は以下の状況にあるドキュメントをキャッシュしません。

各項目 ( /rules プロパティにはが含まれます glob パターンとタイプ：

動的ページがない場合（上記のルールで既に除外されたページを超える場合）、すべてをキャッシュするように Dispatcher を設定できます。 「ルール」セクションは次のようになります。

/rules
  {
    /0000  {  /glob "*"   /type "allow" }
  }

glob プロパティについて詳しくは、glob プロパティのパターンのデザインを参照してください。

ページ内に動的なセクション（ニュースアプリケーションなど）や、非公開のユーザーグループで使用するセクションがある場合は、以下のように例外を定義できます。

/rules
  {
   /0000  { /glob "*" /type "allow" }
   /0001  { /glob "/en/news/*" /type "deny" }
   /0002  { /glob "*/private/*" /type "deny"  }
  }

圧縮

Apache Web サーバーでは、キャッシュされたドキュメントを圧縮できます。 クライアントから要求された場合は、Apache から圧縮形式のドキュメントを返すことができます。例えば、Apache モジュールの mod_deflate を有効にすることで、圧縮は自動的に行われます。

AddOutputFilterByType DEFLATE text/plain

このモジュールは Apache 2.x にデフォルトでインストールされています。

フォルダーレベルでのファイルの無効化

/statfileslevel プロパティを使用して、キャッシュされたファイルをパスに応じて選択的に無効化します。

リソースのみ 道に沿って 無効化されたファイルに影響を与えます。 次の例を考えて見ましょう。Web サイトで /content/myWebsite/xx/. 構造を使用していて、statfileslevel を 3 に設定している場合、.stat ファイルは次のように作成されます。

ファイルが /content/myWebsite/xx が無効化された場合、 .stat docroot からまでのファイル /content/myWebsite/xxがタッチされます。 このシナリオは、次の場合にのみ該当します。 /content/myWebsite/xx 例えば、 /content/myWebsite/yy または /content/anotherWebSite.

キャッシュされたファイルの自動無効化

/invalidate プロパティは、コンテンツが更新されたときに自動的に無効化されるドキュメントを定義します。

自動無効化の場合、Dispatcher はキャッシュされたファイルをコンテンツの更新後に削除しませんが、次に要求されたときにその有効性を確認します。 自動無効化されていないキャッシュ内のドキュメントは、コンテンツの更新によって明示的に削除されるまで、キャッシュに残ります。

自動無効化は、通常、HTMLページで使用されます。 HTMLページには他のページへのリンクが含まれることが多いので、コンテンツの更新がページに影響を与えるかどうかを判断するのが困難です。 コンテンツの更新時にすべての関連ページが無効化されるようにするには、すべての HTML ページを自動的に無効化します。以下の設定は、すべての HTML ページを無効化します。

  /invalidate
  {
   /0000  { /glob "*" /type "deny" }
   /0001  { /glob "*.html" /type "allow" }
  }

glob プロパティについて詳しくは、glob プロパティのパターンのデザインを参照してください。

この設定により、次のアクティビティが発生します。 /content/wknd/us/en 有効化済み：

ダウンロード用に自動生成されたPDFと ZIP ファイルを提供する場合は、これらのファイルも自動的に無効にする必要が生じる場合があります。 設定例を次に示します。

/invalidate
  {
   /0000 { /glob "*" /type "deny" }
   /0001 { /glob "*.html" /type "allow" }
   /0002 { /glob "*.zip" /type "allow" }
   /0003 { /glob "*.pdf" /type "allow" }
  }

AEMとAdobe Analyticsの統合により、 analytics.sitecatalyst.js ファイルを Web サイト内に配置する必要があります。 例 dispatcher.any Dispatcher で提供されるファイルには、このファイルに対して次の無効化ルールが含まれます。

{
   /glob "*/analytics.sitecatalyst.js"  /type "allow"
}

カスタム無効化スクリプトの使用

The /invalidateHandler プロパティを使用すると、Dispatcher が受け取った無効化要求ごとに呼び出されるスクリプトを定義できます。

次の引数を指定して呼び出されます。

この方法は、複数の異なる使用例をカバーするために使用できます。 例えば、他のアプリケーション固有のキャッシュを無効にする、またはページの外部化された URL とドキュメントルート内の URL がコンテンツパスと一致しない場合の処理をおこないます。

以下の例では、無効化要求のたびにをファイルに記録します。

/invalidateHandler "/opt/dispatcher/scripts/invalidate.sh"

サンプルの無効化ハンドラースクリプト

#!/bin/bash

printf "%-15s: %s %s" $1 $2 $3>> /opt/dispatcher/logs/invalidate.log

キャッシュをフラッシュできるクライアントの制限

The /allowedClients プロパティは、キャッシュのフラッシュを許可する特定のクライアントを定義します。 このグロビングパターンが、IP と照合されます。

以下の例の内容は次のとおりです。

/allowedClients
  {
   /0001 { /glob "*.*.*.*"  /type "deny" }
   /0002 { /glob "127.0.0.1" /type "allow" }
  }

glob プロパティについて詳しくは、glob プロパティのパターンのデザインを参照してください。

URL パラメーターを無視する

ignoreUrlParams セクションでは、ページをキャッシュするかキャッシュから提供するかを判断するときにどの URL パラメーターを無視するかを定義します。

あるページのパラメーターが無視された場合、そのページが初めて要求されたときにそのページがキャッシュされます。 ページに対する後続のリクエストは、リクエスト内のパラメーターの値に関係なく、キャッシュされたページに提供されます。

無視するパラメーターを指定するには、ignoreUrlParams プロパティに glob ルールを追加します。

次の例では、Dispatcher が、 nocache パラメーター。 したがって、 nocache パラメーターは、Dispatcher によってキャッシュされることはありません。

/ignoreUrlParams
{
    # ignore-all-url-parameters-by-dispatcher-and-requests-are-cached
    /0001 { /glob "*" /type "allow" }
    # allow-the-url-parameter-nocache-to-bypass-dispatcher-on-every-request
    /0002 { /glob "nocache" /type "deny" }
}

のコンテキストでは、 ignoreUrlParams 上記の設定例では、次の HTTP 要求によって、ページがキャッシュされます。これは、 willbecached パラメーターは無視されます：

GET /mypage.html?willbecached=true

のコンテキストでは、 ignoreUrlParams 設定例では、次の HTTP 要求によってページが not キャッシュされるのは、 nocache パラメーターは無視されません：

GET /mypage.html?nocache=true
GET /mypage.html?nocache=true&willbecached=true

glob プロパティについて詳しくは、glob プロパティのパターンのデザインを参照してください。

HTTP 応答ヘッダーのキャッシュ

/headers プロパティを使用して、Dispatcher がキャッシュする HTTP ヘッダータイプを定義できます。キャッシュされていないリソースへの最初のリクエストでは、設定済みの値（以下の設定サンプルを参照）のいずれかに一致するすべてのヘッダーが、キャッシュファイルの隣の別ファイルに格納されます。キャッシュされたリソースに対する後続のリクエストでは、保存されたヘッダーが応答に追加されます。

以下に、デフォルト設定のサンプルを示します。

/cache {
  ...
  /headers {
    "Cache-Control"
    "Content-Disposition"
    "Content-Type"
    "Expires"
    "Last-Modified"
    "X-Content-Type-Options"
    "Last-Modified"
  }
}

FileETag none

Dispatcher キャッシュファイルの権限

mode プロパティは、新しいディレクトリおよびキャッシュ内のファイルに適用されるファイル権限を指定します。この設定は、呼び出し元のプロセスの umask によって制限されます。これは、次の値のうち 1 つまたは複数の合計から構成される 8 進数です。

デフォルト値は 0755 これにより、所有者は読み取り、書き込み、または検索を行い、グループとその他のユーザーは読み取りや検索を行うことができます。

.stat ファイルの更新のスロットリング

デフォルトの /invalidate のプロパティでは、アクティベーションごとに、すべての .html ファイルが無効化されます（パスが /invalidate セクションに一致する場合）。トラフィック量が多い Web サイトでは、複数回のアクティベーションを実行すると、バックエンドの CPU 負荷が増加します。 このようなシナリオでは、「スロットル」が望ましい .stat web サイトをレスポンシブに保つために、ファイルに touch します。 このアクションは、 /gracePeriod プロパティ。

The /gracePeriod プロパティは、自動的に無効化された古いリソースを、最後に発生したアクティベーション後にキャッシュから引き続き使用できる秒数を定義します。 このプロパティは、アクティベートのバッチによってキャッシュ全体が繰り返し無効化されるような設定で使用できます。推奨される値は 2 秒です。

詳細については、上記の /invalidate および /statfileslevel セクションも参照してください。

時間に基づくキャッシュの無効化の設定 — /enableTTL

時間ベースのキャッシュの無効化は、 /enableTTL プロパティに含まれ、HTTP 標準の正規の有効期限ヘッダーが存在することを確認します。 プロパティを 1 に設定した場合 (/enableTTL "1") の場合、バックエンドからの応答ヘッダーを評価します。 ヘッダーに Cache-Control, max-age または Expires 日付：キャッシュされたファイルの横に、有効期限と同じ変更時刻を持つ、補助的な空のファイルが作成されます。 変更時刻を過ぎてキャッシュされたファイルがリクエストされると、バックエンドから自動的に再リクエストされます。

Dispatcher 4.3.5 以前は、TTL 無効化ロジックは設定済みの TTL 値にのみ基づいていました。 Dispatcher 4.3.5 では、両方の TTL が設定されます。 および Dispatcher キャッシュの無効化ルールが計上されます。 したがって、キャッシュされたファイルの場合は次のようになります。

この新しい実装では、ファイルの TTL が長い（CDN 上などで）場合でも、TTL が期限切れになっていなくても無効にできます。 Dispatcher のキャッシュヒット率よりもコンテンツの鮮度を優先します。

逆に、必要に応じて のみ 有効期限ロジックをファイルに適用し、 /enableTTL を 1 に設定し、そのファイルを標準のキャッシュ無効化メカニズムから除外します。 例えば、次のことができます。

  /invalidate
  {
   /0000  { /glob "*" /type "deny" }
   /0001  { /glob "*.html" /type "allow" }
   /0002  { /glob "*.example.html" /type "deny" }
  }

これにより、次のことが可能になります。 .stat ファイルの無効化は使用されず、指定したファイルに対して TTL の有効期限のみが有効になります。

ロードバランシングの設定 — /statistics

/statistics セクションは、Dispatcher が各レンダーの応答性のスコアを付けるファイルのカテゴリを定義します。Dispatcher は、スコアを使用して、要求を送信するレンダーを決定します。

作成した各カテゴリが glob パターンを定義します。 Dispatcher は、要求されたコンテンツの URI をこれらのパターンと比較し、要求されたコンテンツのカテゴリを判断します。

Dispatcher は、最大 8 つの統計カテゴリをサポートします。 8 つを超えるカテゴリを定義した場合は、最初の 8 つのカテゴリのみが使用されます。

レンダリング選択

Dispatcher がレンダリングされたページを必要とするたびに、次のアルゴリズムを使用してレンダリングを選択します。

レンダーのカテゴリのスコアは、以前の応答時間と、Dispatcher が試行する、以前の失敗した成功した接続に基づいています。 試行のたびに、要求された URI のカテゴリのスコアが更新されます。

統計カテゴリの定義

レンダリングの選択に関する統計を保持するドキュメントのタイプごとにカテゴリを定義します。 The /statistics セクションには /categories 」セクションに入力します。 カテゴリを定義するには、 /categories セクションに次の形式が含まれる場合。

/name { /glob "pattern"}

カテゴリ name は、ファームに対して一意である必要があります。pattern については、glob プロパティのパターンのデザインのセクションで説明します。

URI のカテゴリを決定するために、Dispatcher は一致が見つかるまで、URI と各カテゴリパターンを比較します。 Dispatcher はリストの最初のカテゴリから始まり、順番に続きます。 したがって、より具体的なパターンを持つカテゴリを最初に配置します。

例えば、Dispatcher はデフォルト dispatcher.any ファイルは、カテゴリと othersHTMLを定義します。 HTML カテゴリのほうが具体的なので、先頭に配置されています。

/statistics
  {
  /categories
    {
      /html { /glob "*.html" }
      /others  { /glob "*" }
    }
  }

以下の例には、検索ページ用のカテゴリも含まれています。

/statistics
  {
  /categories
    {
      /search { /glob "*search.html" }
      /html { /glob "*.html" }
      /others  { /glob "*" }
    }
  }

Dispatcher 統計へのサーバー使用不可の反映

/unavailablePenalty プロパティは、レンダーへの接続が失敗した場合にレンダー統計に適用される時間（0.1 秒単位）を設定します。Dispatcher は、要求された URI に一致する統計カテゴリにこの時間を追加します。

例えば、AEM が実行されていない（したがってリッスンしていない）か、ネットワーク関連の問題が発生したので、指定したホスト名およびポートへの TCP/IP 接続を確立できない場合にペナルティが適用されます。

/unavailablePenalty プロパティは、/farm セクション（/statistics セクションの兄弟）の直接の子です。

いいえの場合 /unavailablePenalty プロパティが存在する場合、値は "1" が使用されます。

/unavailablePenalty "1"

スティッキー接続フォルダーの識別 — /stickyConnectionsFor

The /stickyConnectionsFor プロパティは、スティッキードキュメントを格納する 1 つのフォルダーを定義します。 このプロパティには、URL を使用してアクセスします。 Dispatcher は、このフォルダーにある 1 人のユーザーから同じレンダーインスタンスに、すべての要求を送信します。 スティッキー接続を使用すると、セッションデータがすべてのドキュメントに対して一貫性を保ち、存在することを確認できます。 このメカニズムは、renderid cookie を利用しています。

次の例は、/products フォルダーへのスティッキー接続を定義しています。

/stickyConnectionsFor "/products"

ページが複数のコンテンツノードのコンテンツで組み立てられている場合は、コンテンツへのパスをリストする /paths プロパティを含めます。例えば、/content/image、/content/video および /var/files/pdfs のコンテンツを含むページがあるとします。以下の設定を使用すると、ページ上のすべてのコンテンツに対してスティッキー接続が有効になります。

/stickyConnections {
  /paths {
    "/content/image"
    "/content/video"
    "/var/files/pdfs"
  }
}

httpOnly:anchor-httponly:

スティッキー接続が有効な場合、Dispatcher モジュールは renderid cookie. この cookie には httponly フラグ。セキュリティを強化するために追加する必要があります。 次の項目を追加します。 httponly フラグを設定する httpOnly プロパティを /stickyConnections のノード dispatcher.any 設定ファイル。 プロパティの値 ( 0 または 1) は、 renderid cookie に HttpOnly 属性が追加されました。 デフォルト値は 0は、属性が追加されていないことを意味します。

詳しくは、 httponly フラグ、読み取り このページ.

secure

スティッキー接続が有効な場合、Dispatcher モジュールは renderid cookie. この cookie には secure フラグ。セキュリティを強化するために追加する必要があります。 次の項目を追加します。 secure フラグ設定 secure プロパティを /stickyConnections のノード dispatcher.any 設定ファイル。 プロパティの値 ( 0 または 1) は、 renderid cookie に secure 属性が追加されました。 デフォルト値は 0は、属性が追加されたことを意味します。 if 受信リクエストはセキュリティで保護されています。 値が 1を指定した場合、受信リクエストがセキュアかどうかに関係なく、secure フラグが追加されます。

レンダー接続エラーの処理

レンダーサーバーが 500 エラー、すなわち使用不可を返した場合の Dispatcher の動作を設定します。

ヘルスチェックページの指定

/health_check プロパティを使用して、ステータスコード 500 が発生したときに確認する URL を指定します。このページもステータスコード 500 を返す場合、インスタンスは使用不可能で、設定可能なタイムペナルティ ( /unavailablePenalty) は、再試行の前にレンダーに適用されます。

/health_check
  {
  # Page gets contacted when an instance returns a 500
  /url "/health_check.html"
  }

ページ再試行遅延の指定

The /retryDelay プロパティは、Dispatcher が待機する、ファームレンダーへの接続試行周期（秒単位）を設定します。 周期ごとに、Dispatcher が 1 つのレンダーに対して接続を試行する最大回数は、ファーム内のレンダーの数です。

/retryDelay が明示的に定義されていない場合、Dispatcher は値 "1" を使用します。通常は、デフォルト値が適切です。

/retryDelay "1"

再試行回数の設定

/numberOfRetries プロパティは、Dispatcher がレンダーに対して実行する。接続試行周期の最大回数を設定します。この回数の再試行の後、Dispatcher がレンダーに正常に接続できない場合、Dispatcher は失敗した応答を返します。

周期ごとに、Dispatcher が 1 つのレンダーに対して接続を試行する最大回数は、ファーム内のレンダーの数です。したがって、Dispatcher が接続を試みる最大回数は（/numberOfRetries）x（レンダー数）になります。

明示的な定義がない場合、デフォルト値は 5.

/numberOfRetries "5"

フェイルオーバーメカニズムの使用

元の要求が失敗した場合に、別のレンダーに要求を再送信するには、Dispatcher ファームのフェイルオーバーメカニズムを有効にします。 フェイルオーバーが有効な場合、Dispatcher は次の動作を行います。

フェイルオーバーを有効にするには、次の行をファーム（または Web サイト）に追加します。

/failover "1"

中断エラーを無視 — /ignoreEINTR

ファイル・システム指向のシステム・コールが中断される EINTR システムコールの対象が、NFS を介してアクセスするリモートシステム上にある場合。 これらのシステムコールがタイムアウトしたり中断されたりする可能性があるかどうかは、基になるファイルシステムがローカルマシンにどのようにマウントされたかに基づきます。

以下を使用します。 /ignoreEINTR インスタンスにそのような設定があり、ログに次のメッセージが含まれる場合は、パラメーターを指定します。

Error while reading response: Interrupted system call

内部的に、Dispatcher は次のように表現できるループを使用して、リモートサーバー (AEM) から応答を読み取ります。

while (response not finished) {
read more data
}

このようなメッセージは、「EINTR」セクションで read more data が発生した場合に生成されることがあります。原因は、データの受信前にシグナルを受信したことです。

このような中断を無視するには、次のパラメーターを dispatcher.any ( /farms):

/ignoreEINTR "1"

/ignoreEINTR を "1" に設定すると、Dispatcher は応答全体が読み込まれるまでデータの読み込みを続行します。デフォルト値は 0 オプションを無効にします。

glob プロパティのパターンのデザイン

Dispatcher 設定ファイルのいくつかのセクションでは、glob プロパティをクライアント要求の選択条件として使用します。の値 glob プロパティとは、要求されたリソースのパスやクライアントの IP アドレスなど、Dispatcher が要求の側面と比較するパターンです。 例えば、 /filter セクション使用 glob Dispatcher が従う、または拒否するページのパスを識別するパターン。

The glob の値には、ワイルドカード文字と英数字を含めて、パターンを定義できます。

ログ

Web サーバー設定で、次の属性を設定できます。

詳しくは、Web サーバーのドキュメント、および使用する Dispatcher インスタンスの readme ファイルを参照してください。

Apache の交替されるログ／パイプ経由のログ

を使用する場合、 Apache Web サーバーでは、交替されるログ、パイプ経由のログ、またはその両方に対する標準機能を使用できます。 例えば、次のようにパイプ経由のログを使用できます。

DispatcherLog "| /usr/apache/bin/rotatelogs logs/dispatcher.log%Y%m%d 604800"

この機能は自動的に回転します。

ログの交替やパイプ経由のログについては、Apache Web サーバーのドキュメントを参照してください。 例： Apache 2.4.

トレースログ

Dispatcher の機能強化の中で、バージョン 4.2.0 ではトレースログも導入されています。

この機能は、ログに追加情報を表示するデバッグログよりも高いレベルです。 次のログが追加されます。

Web サーバーでログレベルを 4 に設定して、トレースログを有効にすることができます。

トレースを有効にしたログの例を以下に示します。

[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Host] = "localhost:8443"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[User-Agent] = "curl/7.43.0"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Accept] = "*/*"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Client-Cert] = "(null)"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Via] = "1.1 localhost:8443 (dispatcher)"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-For] = "::1"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL] = "on"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Cipher] = "DHE-RSA-AES256-SHA"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-SSL-Session-ID] = "ba931f5e4925c2dde572d766fdd436375e15a0fd24577b91f4a4d51232a934ae"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[X-Forwarded-Port] = "8443"
[Thu Mar 03 16:05:38 2016] [T] [17183] request.headers[Server-Agent] = "Communique-Dispatcher"

ブロックルールに一致するファイルが要求されたときにログに記録されるイベント：

[Thu Mar 03 14:42:45 2016] [T] [11831] 'GET /content.infinity.json HTTP/1.1' was blocked because of /0082

基本操作の確認

Web サーバー、Dispatcher および AEM インスタンスの基本の操作とやり取りを確認するには、次の手順を実行します。

複数の Dispatcher の使用

複雑な設定では、複数の Dispatcher を使用できます。 例えば、次のように使用できます。

この場合、各要求が経由する Dispatcher は 1 つだけにしてください。別の Dispatcher から渡された要求は処理されません。したがって、両方の Dispatcher がAEM Web サイトに直接アクセスしていることを確認してください。

デバッグ

ヘッダーを追加する場合 X-Dispatcher-Info 要求に対して、Dispatcher は、ターゲットがキャッシュされたか、キャッシュから返されたか、またはキャッシュ不可能であるかを返します。 応答ヘッダー X-Cache-Info には、この情報が読み取り可能な形式で格納されます。これらの応答ヘッダーを使用して、Dispatcher によってキャッシュされた応答に関する問題をデバッグできます。

この機能はデフォルトでは有効になっていないので、応答ヘッダーの場合は有効です X-Cache-Info を含めるには、ファームに次のエントリが含まれている必要があります。

/info "1"

例：

/farm
{
    /mywebsite
    {
        # Include X-Cache-Info response header if X-Dispatcher-Info is in request header
        /info "1"
    }
}

また、 X-Dispatcher-Info ヘッダーに値は必要ありませんが、 curl テストの場合は、ヘッダーに送信する値を次のように指定する必要があります。

curl -v -H "X-Dispatcher-Info: true" https://localhost/content/wknd/us/en.html

以下は、の応答ヘッダーの一覧です。 X-Dispatcher-Info 戻り値：