28 inCacheフレームワークの使用
概要
inCacheはメモリーベースのページおよびアセット・キャッシング・システムで、これを使用すると、WebCenter Sitesのデータを中央の共有リポジトリや共有ファイル・システムにキャッシュする必要がなくなります。inCacheは、Terracotta社によるオープン・ソースのJavaキャッシング・フレームワークであるEhcacheに基づいており、任意のキャッシング・システム上に実装できます。(Ehcacheの詳細は、http://ehcache.org/
を参照してください。)
ノート:
WebCenter Sitesは、Ehcacheを使用して、コンテンツを様々なレベルでキャッシュします。サイト・クラスタ内のノードの1つでネットワーク障害が発生すると、Ehcacheは非同期になる場合があります。様々なノードでのキャッシュの同期を保つには、ネットワーク障害が発生しているノードを再起動することをお薦めします。この項では、次の項目について説明します。
Caching Frameworkの概要
inCacheフレームワークは、レガシーのページ・キャッシング・フレームワークに置き換わるものです。inCacheでは、デフォルトでアセットのキャッシングもサポートしています。inCacheフレームワークには次のような利点があります。
-
高パフォーマンス。レスポンスが速いので、パブリッシング・セッションの頻度を上げることができます。ページおよびアセットの効果的な無効化により、更新済コンテンツがすばやく提供されます。
-
分散化アーキテクチャ。ノードはそれぞれ独自のローカル・キャッシュを維持しています。inCacheフレームワークでは、データベースのキャッシングと共有ディスクが排除されています。
-
ブロードキャスト・システム。個別のノードがキャッシュ全体の完全なビューを持つ必要がなくなりました。コンテンツへの変更をリスニングしているノードが、個々のコンテンツの必要に応じてブロードキャストに応答します。
-
リニアなスケーラビリティが強化され、ディスクやメモリーのデータに対して拡張。
-
フェイルオーバーと永続性。シャットダウンされたノードはローカル・キャッシュ内にデータを保持し、再起動時に、中央管理されている無効化のレコードに対して自己更新します。
-
オンデマンドのページ評価と無効化。ノードは、コンテンツがリクエストされたときのみ、現在キャッシュされているコンテンツを有効化して更新します。
この章では、主にページ・キャッシングについて説明します。ここでは、「ページ」という用語を、ページ・アセットでなく、レンダリング済ページを意味するものとして使用します。アセットのキャッシングに関する説明を理解するために、この章、特にinCacheの仕組みの理解を最初に読み、キャッシュ・コンテナと、その相互に関連した機能に関する基本を理解しておくことをお薦めします。
ページ・キャッシングの概要
inCacheはディスクのストライプ化をサポートし、donoteregenerate
フラグを非アクティブ化することでリアルタイム・パブリッシュに影響を与えます。リアルタイム・パブリッシュの間にページの再生成を有効にするオプションでは、配信システムのFW_RegenCriteria
表に、クロールおよび再生成されるページのURLを移入する必要があります。ページ伝播も1つのオプションで、すべてのノードが同じページをホストするようにして、各ノードでページを再生成する必要をなくす場合に使用します。さらに、代替ページが再生成されるまでの少しの間、失効したページを引き続き提供するように、リモートのSatellite Serverを構成することもできます。
ノート:
必要に応じて、次の手順を実行することで、レガシーのページ・キャッシング方法に戻すこともできます。
-
すべてのWebCenter SitesノードとSatellite Serverノードで、
–Dcs.useEhcache=false
のようにVM引数を設定します。 -
すべてのWebCenter SitesノードとSatellite Serverノードを再構成して、データベースと共有ファイル・システムを使用するようにします。
-
無効化以降に古くなってしまっている可能性が高い状況での、操作を再開する前のレガシー・ページ・キャッシュの消去。
一般的に、キャッシュ方法を切り替える場合には、WebCenter SitesノードとSatellite Serverノードが同じキャッシュを使用するように再構成して、使用前にキャッシュを消去する必要があります(ベスト・プラクティスとして推奨)。
アセットのキャッシングの概要
アセットのキャッシングは、インストール時とアップグレード時にWebCenter Sitesシステム上で有効になります。アセットのキャッシングは、inCacheフレームワーク上に構築された、メモリーをベースにしたシステムで、そのままではデータベースに影響を与えるような負荷を担うことによってパフォーマンスを保護します。アセットのキャッシングにはAssetCacheコンテナという独自のコンテナが使用され、このコンテナは、他のinCacheコンポーネント(特にdependencyRepositoryキャッシュとnotifierキャッシュ)と相互に作用することによって機能します。
pageByQueryキャッシュは、アセットのキャッシングでは使用されませんが、キャッシュ・コンテナの仕組みの説明には便利です。それに相当するAssetCacheコンテナが同様に機能します。アセットのキャッシングとinCacheページ・キャッシングは、互いに独立に機能します。キャッシュの各タイプは、互いに関係なく有効または無効にできます。
AssetCacheコンテナの使用では、AssetCacheコンテナ、アセットのロードと無効化に関連する機能、アセット・キャッシングとページ・キャッシングの比較、およびアセットのキャッシングをアセット・タイプによってカスタマイズする方法について説明します。
inCacheの仕組みの理解
クラスタ化された環境では、inCacheはクラスタのデータベースの外側の分散化されたアーキテクチャに実装されます。次の図に示すように、各ノードにはそれぞれ独自のローカル・キャッシュがあります。各WebCenter Sitesノードは、他のWebCenter Sitesノードからのブロードキャストをリスニングすることで、ローカル・キャッシュを最新に保ち、HTTPを介してリモートのSatellite Serverに更新を伝達します。
ノードのローカル・キャッシュはパーティションで区切られています。
-
pageByQry
キャッシュには、ノードのWebページが格納されます。 -
dependencyRepository
キャッシュには、Webページを構成するアセットの識別子が格納されます。ノート:
pageByQry
キャッシュは、ページ・キャッシュとも呼ばれます。dependencyRepository
キャッシュは、依存性キャッシュとも呼ばれます。 -
notifier
キャッシュは、編集またはパブリッシュのプロセスで変更されたアセットの識別子をブロードキャストします。ブロードキャストは、アセットの変更されたノードによって開始されます。リスニングするノードがブロードキャストに応答する方法は、ノードによって異なります。たとえば:-
ノード
A
のWebCenter SitesユーザーがアセットA
を編集します。 -
ノード
A
のnotifierキャッシュが、その他のすべてのノードに変更の通知をブロードキャストします。 -
アセット
A
を含むすべてのWebCenter Sitesノードが、それぞれ独自のローカル・キャッシュ内のアセットを無効化することで応答します。各ノードは独自のdependencyRepository
キャッシュを参照し、アセットの識別子を無効にマークして、キャッシュ全体の依存性生成数を増分させます。無効化されたアセットは、そのアセットを参照するページで使用できなくなるので、これらのページそのものも無効になります。ただし、ノードは、ページがリクエストされるまでページを評価しません。ここにパフォーマンス上の利点があります。無効化されたアセットに対する依存性を持つページのリクエストにノードが応答する場合、このノードは
pageByQry
キャッシュを参照し、ページを評価し、無効化するページを決定し、それをフラッシュし、新規ページを生成し、そのページを訪問者のブラウザに提示して、ローカル・キャッシュ内に新規ページとその依存性を記録します(依存性は、ページを構成するアセットの識別子として記録されます)。その時点から、ページが異常終了するか、アセットが再び無効化されるまで、ノードのローカル・キャッシュからは同じページが提示されます。
-
WebCenter SitesとSatellite Serverは同じキャッシング・フレームワークを使用していますが、Satellite Serverノードは、HTTPを介してWebCenter Sitesノードと通信しています。
ノート:
pageByQuery
キャッシュはページ・キャッシングにしか使用されませんが、キャッシュ・コンテナの仕組みの説明には役立ちます。アセットのキャッシングの場合、inCacheフレームワークでは、それに相当するAssetCache
という名前のコンテナが使用されます。それはpageByQuery
と同様の方法で機能し、dependencyRepository
およびnotifier
キャッシュと対話します。「アセットのキャッシング操作の使用」を参照してください。
ノードの再起動
WebCenter SitesまたはSatellite Serverノードが停止している場合、そのキャッシュにあるデータは保持されますが、アクティブ・ノードが引き続きアセットを無効化するため、すぐに古くなります。その結果、ノードを再起動するには、それが持つキャッシュを更新する必要があります。再起動時の更新を保証するのが共通の無効化メモリーで、それはWebCenter Sitesクラスタのデータベースに表として格納され、クラスタのすべてのノードが再起動時に使用できる状態に維持されます。表の名前はFW_InvalidationMemory
です。
無効化メモリーには、アセット無効化のレコード(特に、コンテンツ管理またはパブリッシュ・プロセスで変更または削除されたアセットの識別子)が格納されます。15分間隔で実行されるクリーンアップ・メカニズムにより表の増大がチェックされ、最も古い期間の無効化レコードが破棄されます。
ノードは再起動時に、非アクティブであった期間に欠落した情報をリカバリしようとして、無効化メモリーを参照します。
-
ノードの非アクティブ期間の無効化レコードが存在する場合、ノードは自分自身でリプレイします。
-
非アクティブ期間に無効化されたアセットが存在しない場合、ノードはシャットダウンされなかったかのように動作を続行します。
-
ノードが非アクティブであった間にクリーンアップ・メカニズムによって無効化レコードが消去された場合、ノードのキャッシュは自らを破棄するので、再構築する必要があります。
リモートのSatellite Serverは、WebCenter Sitesに更新を求めるリクエストを送信することによって、失った情報を再起動時に取得します。
リアルタイム・パブリッシュ時のページの再生成
inCacheを有効にすると、リアルタイム・パブリッシュ・プロセス用のdonotregenerate
フラグが無効になります。このフラグが認識されなくなるので、リアルタイム・パブリッシュ・セッション時のページの再生成には、クロールが使用されます。クローリングを実装していなければ、ページはリクエスト時のみ再生成されます。
クロール・オプションでは、ページ・リジェネレータによって分析される一連のURLを指定する必要があります。通常、これらはホームページやその他のトラフィックの多いページのURLです。それらのページをクロールする深さを指定することもできます。たとえば、深度1では指定したページとそれらのページのリンク先のページがクロールされ、0では指定したページのみがクロールされます。クロールされるページは、そのコンポーネント・アセットがパブリッシュ・セッション時に無効化された場合か、それらのページがキャッシュされていない場合のみ再生成されます。指定したページ上のすべてのページレットがプロセス内で再生成されます。
URLとクロール深度のリストを、inCache構成後の最初のパブリッシュ・セッション時に配信システム上で作成されるFW_RegenCriteria
表で指定する必要があります。ft_ss
パラメータをURLに含むことで、ページ・リクエストをWebCenter Sitesで直接処理するのか、リモートのSatellite Serverによって処理するのかを指定できます。「アセットのキャッシング操作の使用」を参照してください。
ダブルバッファ・キャッシング
ダブルバッファによるWebcenter Sitesのページ・キャッシング方法では、ライブWebサイト上でWebCenter SitesとSatellite Serverのキャッシュを連結させて使用します。ダブル・バッファリングでは、ページが常にWebCenter SitesかSatellite Serverのいずれかのキャッシュ内に保持され、ページ・リクエストの過負荷からWebCenter Sitesを保護し、ライブWebサイトで空白ページやリンク切れが表示されないようにします。
inCacheフレームワークで従来のシステムのダブルバッファ・キャッシングを維持するために、HTTPリクエストを介してリモートのSatellite ServerはWebCenter Sitesと通信を続けるようになっています。Satellite Serverはこれまでどおりの方法で、HTTPリクエストを介してページ・データを読み取ってキャッシュします。ただし、ページ・データには、アセット識別子のカンマ区切りのリスト形式で依存性情報が含まれるようになり、この情報はリモートのSatellite Serverにもストリームされます。
inCacheによるページ・キャッシングのためのシステムの構成
この構成プロセスは、一連の必須のステップとオプションの最適化ステップによって構成されます。たとえば、複数のWebCenter Sitesノードの相互通信を有効にして、WebCenter SitesとリモートのSatellite Server上の各ローカル・キャッシュのストレージ・プロパティを設定します。
inCacheページ・キャッシング用にシステムを構成するには::
-
inCacheによるページのキャッシングが有効になっていることを確認します。VM引数
–Dcs.useEhcache
を検索して、これがtrue
に設定されているか、何も設定されていない(その場合の値はtrue
と想定される)かのどちらかであることを確認します。 -
システムの再起動時に、WebCenter SitesノードとSatellite Serverノードのそれぞれで、キャッシュ・コンテンツが保持されるように構成します。次のVM引数を渡します。
–Dnet.sf.ehcache.enableShutdownHook=true
-
オプションの最適化。各WebCenter SitesおよびSatellite Serverノードに
diskStore
パスを設定します。複数のノードが同じシステム上にある場合(垂直クラスタ)は、各ノードが固有のdiskStore
パスを持っていることを確認します。cs-cache.xml
およびss-cache.xml
ファイルで、diskStore path="<path to disk store>"
プロパティを設定します。両方のxml
ファイルが各WebCenter Sitesノードに格納されます。cs-cache.xml
はWebCenter Sites酔うで、ss-cache.xml
は共存するSatellite Server用です。リモートのSatellite Serverにはss-cache.xml
ファイルのみが格納されます。これらのファイルはWEB-INF/classes
フォルダの下に配置されます。diskStore
プロパティに関する詳細は、次のEhcache Webサイトにあるドキュメントを参照してください。http://ehcache.org/documentation/configuration.html
ノート:
inCacheは、WebCenter Sites、リモートのSatellite Server、共存するSatellite Serverに存在しています。アーキテクチャと機能の面で、共存するSatellite ServerとリモートのSatellite Serverに存在しているinCacheは同じものです。ただし、共存するSatellite Serverには次の推奨事項が適用されます。
-
ディスクの永続性をオフにします。
-
各キャッシュのサイズは、WebCenter Sitesのキャッシュ・サイズよりも小さくします。これはメモリーの過負荷を防ぐためです。共存するSatellite Server上の完全なダブルバッファ・キャッシングに対する要件などの特別な状況を除いて、このサイズは小さくしておくことをお薦めします。
-
-
inCacheポートの構成。inCacheは、クラスタ・メンバー間の通信には、EhcacheのRMIベースのトランスポート・メカニズムを使用します。通常、これに追加の設定は不要ですが、Ehcacheが使用する正確なポートを指定することは可能です。クラスタ・メンバー間にファイアウォールがある場合、これは特に重要です。
ネットワーク・オーバーヘッドを回避するため、Satellite Serverのキャッシュのレプリケーションを使用しないことをお薦めします。キャッシュのレプリケーションを有効にするには、各ss-cache.xmlファイル内のmulticastGroupPortプロパティを同一の値に設定します。
特定のポートを使用するようにEhcacheを構成する方法の詳細は、次のEhcache Webサイトのドキュメントを参照してください。
http://ehcache.org/files/documentation/EhcacheUserGuide-1.6.pdf
-
複数のノードに必要な手順です。WebCenter Sitesクラスタに対して自動ノード検出を構成します(Satellite Serverノードはクラスタ化できません)。例として、このステップでは、CS1、CS2、CS3という名前の3つのWebCenter Sitesノードを使用します。
ノート:
ある場合には、inCacheノード・ネットワーク上のファイアウォールにより、ノード間の通信が阻害されます。複数のノードにinCacheをインストールして構成する場合、それらのファイアウォールを無効にします。検証が済んだら、システム管理者/ネットワーク管理者は、inCacheテストおよびRemote Satellite Serverへのページ伝播の際にポートを監視し、それに応じてファイアウォールを適応させてください。
-
各WebCenter Sitesノードで、
cs-cache.xml
とss-cache.xml
(WEB-INF/classes
にある)でcacheManagerPeerListenerFactory
が指定されていることを確認します。これはCacheManagerPeerProvider
を作成するために使用されます。このプロバイダがクラスタ内の他のノードを検出します。次の例に示すように、自動検出を構成します。<cacheManagerPeerProviderFactory class="net.sf.ehcache.distribution.RMCacheManagerPeer ProviderFactory" properties="peerDiscovery = automatic, multicastGroupAddress = 230.0.0.1, multicastGroupPort = 4444, timeToLive = 32"/>
ノート:
multicastGroupPort
プロパティは、クラスタ・メンバー全体に対して同一に設定する必要があります。たとえば、CS1のcs-cache.xml
ファイル内でmulticastGroupPort=4444
と指定されている場合、CS2とCS3でもそれぞれのファイル内で同じ設定を指定する必要があります。timeToLive
プロパティは、1つのパケットに対して許可されるホップの数を指定するもので、これによってパケットの伝播距離が決まります。有効な値範囲は、0から255の間で、次の制約があります。-
0
- 同一ホスト -
1
- 同一サブネット -
32
- 同一サイト -
64
- 同一範囲 -
128
- 同一大陸 -
255
- 無制限
-
-
すべてのSatellite Server(共存およびリモート)で、次のいずれかを実行します。
-
各
ss-cache.xml
ファイル内のmulticastGroupPort
プロパティを一意の値に設定します。 -
キャッシュのレプリケーションをサポートする場合は、各
ss-cache.xml
ファイル内のmulticastGroupPort
プロパティを同一の値に設定します。ノート:
ss-cache.xml
ファイルに設定する値は、cs-cache.xml
ファイル内にあるWebCenter SitesのmulticastGroupPort
プロパティとは別の値にする必要があります。
inCacheが構成されている場合、
cs-cache.xml
およびss-cache.xml
に指定された構成を使用してシステムが起動します。キャッシュは、WebCenter Sites内のいずれかのページ(キャッシュされるかどうかにかかわらず)を最初にコールした時点で初期化されます。 -
-
-
オプションの最適化。必要に応じて、表28-1をプロパティ・リファレンスとして使用して、ローカル・キャッシュを構成します。WebCenter SitesとリモートのSatellite Serverの各ノードのローカル・キャッシュは、パーティションで区切られています。各部分は、
cs-cache.xml
ファイルとss-cache.xml
ファイルにある独自の<cache>
タグで定義されます。各部分の名前は次のとおりです。-
pageByQry
: ページ・データそのもののキャッシュで、問合せのURLによるキーが設定されています。 -
dependencyRepository
: ページ構築の基礎となる依存性のキャッシュです。pageByQry
キャッシュにページが追加されると、dependencyRepository
キャッシュにエントリが自動的に作成されます。このキャッシュ内の各エントリは、アセットのid
、unknowndep
またはunknowndep-<type>
のいずれかです。したがって、このキャッシュには最大でもシステム内のアセット数と、様々なバリエーションのunknowndep
の少数のアイテムが格納されるのみです。依存性のないページがキャッシュされると、そのページが
_NODEP_
(依存性のないページの識別に使用されるdependencyRepository
キャッシュ内の1つのアイテム)に依存性をログ記録します。_NODEP_
アイテムとページとの関連付けは、そのページが異常終了するか手動でフラッシュされるまで維持されます。リモートのSatellite Serverでは、(Satellite Serverごとに)JVMオプションの-Dignore_nodep_pages
をtrue
に設定することで、依存性のないページのキャッシュを無効にできます。 -
notifier
: このキャッシュは、アクティブなWebCenter Sitesクラスタ・メンバーが他のWebCenter Sitesクラスタ・メンバーにコンテンツの変更を通知するために使用します。
-
-
構成されたすべてのWebCenter SitesノードとSatellite Serverノードを再起動します。
-
すべてのアクティブなクラスタ・メンバーがキャッシング・ネットワーク内にあり、互いを認識していることを検証します。「クラスタ情報」診断ツールを使用すると、
notifier
キャッシュを持つすべてのWebCenter Sitesメンバーがリストされます。「クラスタ情報」をコールするには:-
キャッシュ可能なページをレンダリングすることで、inCacheをブートストラップします。
-
一般管理者(デフォルトでは
fwadmin
/xceladmin
)として、WebCenter Sites Adminインタフェースにログインします。 -
WebCenter Sitesのクラスタ・メンバーと、共存するSatellite Serverが、相互に通信していることを確認します。「一般的な管理」ツリーで、「管理」ノード、「システム・ツール」ノード、「キャッシュ管理」ノード、「Sitesキャッシュ」ノードの順に展開し、「クラスタ情報」をダブルクリックします。
キャッシュ構成ツールでは、様々なタイプのページ・キャッシュ統計を使用できます。
-
-
ディスク・ストライプの必要がある場合は、リアルタイム・パブリッシュ時のページの再生成を有効にするか、ページ伝播を有効にします。詳細は、チューニング・オプションを参照してください。
表28-1 キャッシュ構成プロパティ
プロパティ 必須かどうか 説明 name
Y
キャッシュの名前を指定します。
有効な値:
-
pageByQry
-
dependencyRepository
-
notifier
詳細は、ステップ5を参照してください。
diskPersistent
N
JVMの再起動と再起動の間にディスク上にデータを保持するかどうかを指定します。
デフォルト/推奨値:
true
ノート:
diskPersistent
設定は、生成数で競合が発生する可能性をなくすために、PageByQry
、dependencyRepository
およびnotifier
の各キャッシュ間で一貫性を保つ必要があります。maxElementsInMemory
Y
メモリーに格納するオブジェクトの最大数を指定します。
デフォルト値:
200000
maxElementsOnDisk
Y
ディスクに格納するオブジェクトの最大数を指定します。ディスクはストライプ化できます。「ディスク・キャッシュのストライプ化」を参照してください。
デフォルト値:
1000000
eternal
Y
WebCenter Sitesによってキャッシュをクリアするかどうかを指定します(inCacheによってクリアされることはありません)。
デフォルト値:
true
このプロパティの値を変更しないでください。
overflowToDisk
Y
メモリー・キャッシュをディスクベースのキャッシュにオーバーフロー可能にするかどうかを指定します。
デフォルト値:
true
このプロパティの値を変更しないでください。
diskSpoolBufferSizeMB
N
ディスク・バッファのサイズを指定します(MB単位)。大量のディスクI/Oが予想される場合(ディスク・キャッシュがメモリー・キャッシュよりはるかに大きい場合など)は、バッファを20MBに設定します。
デフォルト値:
5
memoryStoreEvictionPolicy
N
キャッシュからアイテムを削除する方法を指定します。推奨されるデフォルト値は、
LFU
(Least Frequently Used: 最低アクセス頻度)です。LRU
(Least Recently Used: 最低使用頻度)も適切な値です。デフォルト/推奨値:
LFU
clearOnFlush
N
メモリーがディスクにフラッシュされるときにこれをクリアするかどうかを指定します。
デフォルト値:
false
このプロパティの値を変更しないでください。
-
チューニング・オプション
inCacheフレームワークには多くのオプションがあり、システムにあわせて最適化できます。この項には、それらのオプションをまとめました。
ディスク・キャッシュのストライプ化
inCacheフレームワークでは、キャッシュの大部分をディスクに書き込む必要があるときに発生する競合をなくすために、pageByQry
キャッシュのストライプ化をサポートしています。
inCacheフレームワークでは、WebCenter SitesノードとリモートのSatellite Serverに対して次のステップを実行します。
pageByQryキャッシュをストライプ化するには::
この例では、ルート・キャッシュに依存性とnotifierキャッシュが格納されています。ディレクトリ0から4に拡散しているのは、pageByQry
キャッシュのストライプです。この例の0から4のディレクトリは、シンボリック・リンクの使用によって5つの別個のドライブに配置されました。
リアルタイム・パブリッシュ時のページの再生成の構成
ページは、リクエストされた場合のみ再生成されます。
リアルタイム・パブリッシュ時のページの再生成を構成するには::
-
デフォルトでは、
PageCacheUpdater
が、WebCenter Sitesインストーラによって、ParallelCacheRegenerator
を使用するように設定されます。WebCenter Sitesの配信システム上の
config
フォルダにあるAdvPub.xml
ファイルを開き、PageCacheUpdater
セクションに次に示すコード行があることを確認します。ノート:
クロールする同時スレッドの数を指定する
numThreadsPerServer
を除いて、PageCacheUpdaterセクションの値は、変更しないでください。<bean id="PageCacheUpdater" class="com.fatwire.realtime.regen.ParallelRegeneratorEh" singleton="false"> <property name="id" value="CacheFlusher" /> <property name="numThreadsPerServer" value="3" /> <property name="regenServers"> <list> <value>http://address:port of server where pages are regenerated/ servlet/ContentServer</value> </list> </property> </bean>
Property Managementツールを使用して、
<address>
および<port of server where pages are regenerated>
がWebCenter Sitesノードを指すようにregenServers
を更新します。完全なpagename
と引数を追加して、ページをプレビューできます。 -
配信システムを再起動します。
-
WebCenter Sitesの配信システムに対してリアルタイム・パブリッシュが行われ、そのシステム上に
FW_RegenCriteria
表が作成されます。 -
Sites Explorerを使用して、
FW_RegenCriteria
表を開きます。再作成するページと、フォローするリンクの深さ指定します。ft_ss
パラメータをURLに含むことで、ページ・リクエストをWebCenter Sitesで直接処理するのか、リモートのSatellite Serverによって処理するのかを指定できます。ノート:
URLアセンブラを使用する場合は、クロールするページの内部URLを指定します。リジェネレータはURLアセンブラのURLを認識しません。
例:
pagename=SiteName/HomePage&ft_ss=true Level=1
WebCenter Sitesによって
HomePage
と、HomePage
からリンクされるページが再生成されます。ft_ss=true
と指定した場合、Satellite Serverで生成されたもののように、リクエストが処理されます。 -
WebCenter Sitesの配信システムにリアルタイム・パブリッシュを行います。
パブリッシュ・セッションの間、配信システムは
FW_RegenCriteria
表で指定されたすべてのページをクロールしますが、再生成するのはコンポーネント・アセットが無効化されたものだけです(未キャッシュのページも生成します)。たとえば:
-
更新されたアセットが配信システムにパブリッシュされます。
-
配信システムは、
dependencyRepository
キャッシュ内でアセットの識別子を無効にマークし、依存性生成数を増分させることで、再パブリッシュされたアセットの既存の依存性情報を無効化します。無効化されたアセットは、そのアセットを参照するページで使用できなくなるので、これらのページも無効になります。 -
ページ・リジェネレータは、
FW_RegenCriteria
表に指定されているURLを使用してページをクロールし、無効化されたページを再生成します。さらに、未キャッシュのページも生成します。
-
ページ伝播の設定
ページ伝播によって、WebCenter Sitesクラスタ内のすべてのノード(Satellite Serverノードを含む)が同じページをホストでき、それぞれのノードがページを再生成する必要がなくなります。
inCacheを使用するように構成した場合は、各WebCenter Sitesが別個のJVMを持ち、別々のローカル・キャッシュを維持することになります。1つのWebCenter Sitesによって新しいページが生成され、キャッシュされても、その他のWebCenter Sitesで新しくページがキャッシュされたり、そのページについて通知されることはありません。同じページに対するリクエストを受信すると、各ノードがデータベースや共有のファイル・システムを参照することでそのページを生成する必要があり、両方のコンポーネントに余分な負担が課せられます。ページ伝播では、クラスタ全体にページが伝播されるので、別々のノードが同じページを再生成しなくてもよくなります。
ページ伝播は、ノードのローカル・キャッシュにページがロードされたときに引き起こされます。この機能は、inCacheの基本機能から始まる、次のシナリオに示すように機能します。
-
新しく生成されたページに対するinCacheのページ・キャッシング:
-
ノードA (WebCenter Sitesノード)が、新規ページのリクエストを受信します。
-
ノードAが、リクエストされたページを生成します。
-
ノードAは、新規ページと完全な依存性情報(コンポーネント・アセットの識別子)を、ローカル・キャッシュと依存性キャッシュにキャッシュします。
-
ページ伝播が有効な場合は、ステップ3に続きます。
-
-
再生成されたページに対するinCacheのページ・キャッシング:
-
ノードBもWebCenter Sitesノードで、無効化されたページに対するリクエストを受信します(コンポーネント・アセットが変更されました。このアセットは、ノードBのローカルの依存性キャッシュと、アセットを含むその他すべてのノードの依存性キャッシュで、無効としてマークされています)。
-
ノードBが、リクエストされたページを再生成します。
-
ノードBは、再生成されたページをキャッシュし、生成数を増分させることで依存性を更新します(ステップ2a)。
-
ページ伝播が有効な場合は、ステップ3に続きます。
-
-
ページ伝播によるinCacheのページ・キャッシング:
ノードは、ページを(再)生成するときに、その他のノードにもこのページを伝播します。伝播される情報は、次の内容で構成されています。
-
ページの完全な依存性情報。たとえば、ページにxの依存性(アセット識別子)が存在する場合は、xの依存性がすべて、ローカルの依存性キャッシュから他のWebCenter Sitesノードの依存性キャッシュに伝播されます。
-
ページ自体。ページは、ローカルのページ・キャッシュから他のWebCenter Sitesノードのページ・キャッシュに伝播されます。
受信側のノードにページが存在している場合、そのノードは伝播を無視します。
-
次のリストでは、ページ伝播のイベントと条件をまとめています。
-
WebCenter Sitesノードでページがキャッシュされた場合、その完全なページ情報(前述のステップ3を参照)が、その他すべてのWebCenter Sitesノードに伝播されます。
-
リモートのSatellite Serverノードでページがキャッシュされた場合、その完全なページ情報(前述のステップ3を参照)が、Java RMI (Remote Method Invocation)を経由して他のSatellite Serverに伝播されます。
-
ページが伝播されると、次のような処理が行われます。
-
そのページの最終更新時のタイムスタンプが、すべてのWebCenter SitesノードとSatellite Serverノードで保持されます。
-
所定のノードの再生数が、その他すべてのノードの再生数とは無関係に維持されます。たとえば、ノードAの再生数が10でも、他のノードは別のタイプの依存性の生成数に10を使用します。WebCenter SitesまたはSatellite Serverすべてに同じオブジェクトが伝播されても、WebCenter SitesノードまたはSatellite Serverノードごとに異なる生成数が割り当てられる場合もあります。オブジェクトとその最終更新/変更時間のタイムスタンプは、ノード全体で同じになります。
-
そのページが存在しているノードでは、伝播が無視されます。
-
-
キャッシュされたページの依存性を、そのページの存在しないノードに伝播できなかった場合、そのページがノード上でリクエストされて生成されるまで、ページはノード上にキャッシュされません。
-
それでもSatellite ServerキャッシュにはBLOBが格納されているので、それがSatellite Server全体にレプリケートされます。
この項の内容は次のとおりです。
ページ伝播の有効化
inCacheを使用するように構成されたシステムを起動します。
ページ伝播を有効化するには::
-
すべてのWebCenter Sitesノード上で、次の手順を実行します。
-
プロパティ管理ツールで、
propagatecache=true
を設定します。すべてのノードにこのプロパティを設定するために、「グローバル」を選択します。 -
cs-cache.xml
で、クラスタ内のすべてのWebCenter Sitesノードに対するmulticastGroupPort
が同一で、相互に通信可能であることを確認します。(このファイルはWEB-INF\classes
にあります。)
-
-
すべてのリモートのSatellite Serverで、次の手順を実行します。
-
リモート・サテライト・サーバーの
wcs_properties.json
ファイルで、propagatecache=true
を設定します。このファイルはconfigフォルダにあります。ノート:
Satellite Serverのconfigフォルダは、インストール時に、ユーザー定義の場所に配置されます。クラスタ化環境の場合、推奨される場所は、サイト共有ディレクトリ(
<WCSITES_SHARED DIR>
)配下です。非クラスタ化環境の場合、推奨される場所は、ホーム・ディレクトリ(<WCSITES_PRODUCT HOME>
)の外です。configフォルダがない場合、インストールのエンジニアに問い合せてください。 -
ss-cache.xml
で、キャッシュ伝播するつもりのすべてのSatellite ServerでmulticastGroupPort
が同一であるが、WebCenter SitesノードのmulticastGroupPort
とは異なっていることを確認します。
-
-
すべてのノードで、任意のページをレンダリングすることでページ伝播を初期化して、システムが次のように応答することを確認します。
-
WebCenter Sitesノードでは、ページのキャッシュによって、ローカル・キャッシュから他のWebCenter Sitesノードのキャッシュへの伝播が引き起こされます(ページ伝播の設定のステップ3を参照)。この間、すべてのWebCenter Sitesにわたり、ページの最終更新/変更時間のタイムスタンプが保持されます。そのページが存在しているWebCenter Sitesノードでは、伝播が無視されます。
-
Satellite Serverでの応答は、WebCenter Sitesノードでの応答と同じですが、こちらはJava RMIを経由しています。
-
バックグラウンドでページレットを再生成するための構成
リモートのSatellite Serverは、無効化されたページレットを提供する一方で、これがバックグラウンド・プロセスで再生成されるように構成できます。
無効化されたページレットを提供できるようにするには:
-
リモートのSatellite Serverの
wcs_properties.json
ファイル(クラスタ化環境の場合、WCSites_Shared_Dir
配下、非クラスタ化環境の場合、WCSites_Product_Home
配下にあります)に、serveStale=true
を追加します。それでもページレットが無効化されている場合は、次の方法で再生成します。
-
ブラウザが次の30分以内にページレットをリクエストする場合、リモートのSatellite Serverによって、ページを再生成するためのリクエストをWebCenter Sitesに送信するプロセスが、バックグラウンドで開始されます。バックグラウンド・プロセスの実行中、ブラウザには、リモートのSatellite Serverのキャッシュから、無効化されたページレットが提供されます。これ以降すべてのリクエストで、バックグラウンド・プロセスによってページレットが再生成されるまで、無効化されたページレットが提供されることになります。
-
ブラウザが30分経過後にページレットをリクエストする場合、リモートのSatellite Serverは通常のプロセスを使用してページレットを再生成します。つまり、ページレットを再生成するためのリクエストがWebCenter Sitesに送信されます。リクエスト側のブラウザは、ページが再生成されるまで待機する必要があります。
-
-
バックグラウンド・プロセスに関する情報を入手するには、
logging-config.properties
ファイルで、com.fatwire.logging.cs.cache.ehcache logger
をDEBUGに設定します。DEBUGによって、バックグラウンド・プロセスの開始時には次のメッセージが作成されます。
"Data for <cache key> is found to have been invalidated. A new request has started processing new data in the background."
プロセスの後で、次のメッセージが表示されます。
"Background process for request <cache key> has completed successfully, data in cache is updated."
AssetCacheコンテナの使用
WebCenter Sitesでは、アセットのプログラム的な使用は、その属性のロードと読込みで構成されます。アセットは、WebCenter Sitesに格納されているテンプレートによってロードされるため、AssetCacheはWebCenter Sitesノードでのみ使用されます。
-
AssetCacheは、inCacheフレームワークのコンポーネントです。pageByQryキャッシュと同様に、AssetCacheはinCacheフレームワーク内で各WebCenter Sitesノード下の独自のコンテナとして個別に使用できます。
-
AssetCacheコンテナは、各WebCenter Sitesの
cs-cache.xml
ファイル内でデフォルトで有効になっており、ここでは<cache>
エレメントという名前で呼ばれています。AssetCacheコンテナは、すべてのタイプのアセットをキャッシングし、次に示すinCacheコンポーネントと相互に作用することで機能します。特定のタイプのアセットについては、追加のAssetCacheコンテナを構成できます。「アセットのキャッシングのタイプ」および「アセットのキャッシングのカスタマイズ」を参照してください。 -
dependencyRepositoryキャッシュとの相互作用
AssetCacheにアセットをロードすると、表28-2に示すように、inCacheがdependencyRepositoryキャッシュ内にエントリを作成することで、そのアセットへの依存性をログ記録します。そのアセットを変更または保存すると、dependencyRepositoryキャッシュから依存情報が削除されるので、AssetCacheではこのアセットのエントリが無効になります。一般に、キャッシュされたアセットに対して保存または削除操作を実行すると、そのアセットは無効になります。
ノート:
アセットのキャッシングが有効になっている場合、Oracle WebCenter Sites ExplorerまたはCatalogManager APIを使用してデータベース表にアセットを直接保存したり削除しないでください。この方法で保存および削除操作を実行しても、アセットのキャッシュは無効になりません。
-
notifierキャッシュとの相互作用
どれか1つのノードで無効化が行われると、notifierキャッシュによって他のノードに反映されます。このキャッシュは、どのアセットが変更されたかという情報を広める働きをします。受信したノードのAssetCacheにそのアセットが含まれている場合、そのノードはこの情報に従って独自のdependencyRepositoryキャッシュを更新します。
次の表は、アセットのキャッシングがページ・キャッシングと独立して機能しながら、依然として様々なキャッシュ・コンテナを共有する仕組みを示しています。
表28-2 アセットとページのキャッシングで使用されるキャッシュ・コンテナ
アセットのキャッシング機能 | ページのキャッシング機能 | AssetCacheコンテナ | pageByQryコンテナ | dependency Repositoryコンテナ | notifierコンテナ |
---|---|---|---|---|---|
オフ |
オフ |
未使用 |
未使用 |
未使用 |
未使用 |
オフ |
オン |
未使用 |
ページのキャッシングで使用 |
ページのキャッシングで使用 |
ページのキャッシングで使用 |
オン |
オフ |
アセットのキャッシングで使用 |
未使用 |
アセットのキャッシングで使用 |
アセットのキャッシングで使用 |
オン |
オン |
アセットのキャッシングで使用 |
ページのキャッシングで使用 |
アセットのキャッシングとページのキャッシングで使用 |
アセットのキャッシングとページのキャッシングで使用 |
アセットのキャッシング操作の使用
この項の内容は次のとおりです。
アセット・ローディングの使用
アセットのデータは、APIまたはasset:loadタグを使用する複数の方法で読み込むことができます。
-
次のAPIは、アセットを、
readonly_complete
モードでAssetCacheにロードします。-
AssetDataManager.read(AssetId)
-
アセットに対するREST API GET
-
-
次のタグは、アセットをAssetCacheに、様々なモードでロードします。
-
asset:load(objectid="cid1" option="editable")
-
asset:load(objectid="cid1" option="readonly")
-
asset:load(objectid="cid1" option="readonly_complete")
-
optionパラメータでは、アセットをキャッシュするかどうかと、AssetCacheおよびdependencyRepositoryでの、キャッシュされたアセットのキーの命名方法を決定します。キャッシングのシナリオを、図28-3にまとめます。シナリオDでは、AssetCacheコンテナに同じアセットの複数のエントリが存在しています。これは、アセットがreadonlyおよびreadonly_completeという2つのモードでロードできるためです。
次のモードでは、アセットをキャッシュするかどうかと、AssetCacheおよびdependencyRepositoryでの、キャッシュされたアセットのキーの命名方法が決定されます。
アセットのキャッシングとinCacheのページ・キャッシングの比較
次の図に示すように、キャッシュされたアセットとページ、さらにそれぞれの依存性では、キーの名前が異なります。この違いを理解することは、(「一般的な管理」ツリーの「管理」ノードの「システム・ツール」ノードにある)キャッシュ管理ツールに表示されるキャッシング情報の解析に役立ちます。
たとえば、この前の図は、AssetCacheコンテナにおいて、キャッシュされたアセットのキーの名前がassettype:cid1:2であることを示しています。ここで最後の整数は、アセットが読み取られたモードを示します(2はreadonlyモード)。同じアセットがreadonly_completeモードでもロードされた場合、そのキーはassettype:cid1:3になります。アセットが複数のモードでコールされた場合、AssetCacheコンテナにはそのアセットに対する複数のエントリが確認されます。
キャッシュされたページのキーは、pagename
で始まります。ページにはモードは適用されません。ページのキャッシュは1度しか行われません。
「アセット・ローディングの使用」および「キャッシュ管理ツールの使用について」を参照してください。
AssetCacheのフラッシュ
アセットは、次のAPIやタグ経由で保存された場合、AssetCacheからフラッシュすることができます。
-
API
-
REST API PUT
-
AssetDataManagerWrite
-
-
JSPタグ
-
asset:save
-
asset:saveall
-
asset:delete
-
asset:deleteassettype
-
asset:void
-
asset:rollback
-
asset:deleterevision
-
asset:undocheckout
-
insite:edit
-
-
XMLタグ
-
INSITE.EDIT
-
ASSET.VOID
-
ASSET.SAVE
-
ASSET.SAVEALL
-
ASSET.DELETE
-
アセットのキャッシングのタイプ
WebCenter Sitesノードでアセットのキャッシングを有効にすると、そのノードにあるcs-cache.xml
ファイルには、次の<cache>
エレメントのどれか1つ以上が格納されます。
-
デフォルトの
<cache>
エレメント。すべてのタイプのアセットが、AssetCache
という名前の汎用のキャッシュ・コンテナにキャッシュされるように指定します。<cache name="AssetCache"
diskPersistent="true" maxElementsInMemory="100"
maxElementsOnDisk="100" eternal="true" overflowToDisk="true"
diskSpoolBufferSizeMB="20" memoryStoreEvictionPolicy="LFU"
clearOnFlush="false" />
汎用のAssetCacheコンテナは、WebCenter Sitesのインストール・プロセス中に、すべてのWebCenter Sitesノードで自動的に構成されます。
-
カスタムの
<cache>
エレメント。特定のタイプのアセットが、AssetCacheAsset_type_nameという名前の独自のコンテナにキャッシュされるように指定します。<cache name="AssetCacheAsset_type_name"
diskPersistent="true" maxElementsInMemory="100"
maxElementsOnDisk="100" eternal="true" overflowToDisk="true"
diskSpoolBufferSizeMB="20" memoryStoreEvictionPolicy="LFU"
clearOnFlush="false" />
タイプ固有のすべてのカスタムAssetCacheコンテナは、
cs-cache.xml
ファイル内で手動で構成する必要があります。タイプ固有のコンテナの作成数は、独自のコンテナにキャッシュする必要のあるアセットのタイプと、各コンテナのキャッシングに適用する必要のある条件によって異なります。
汎用のAssetCacheコンテナを、1つまたは多数のタイプ固有のアセット・キャッシュと共存させるか、あるいはそれらによって置き換えることができます。アセットがキャッシュするすべてのコンテンツは、排他的です。つまり、汎用のAssetCacheコンテナでは、タイプ固有のコンテナにキャッシュされているアセット・タイプは除外され、タイプ固有のコンテナでは、その他すべてのタイプのアセットが除外されます。
さらに、アセットのキャッシングが有効になっている場合、(「一般的な管理」ツリーの「管理」ノードの「システム・ツール」ノードにある)キャッシュ管理ツールには、AssetCache
コンテナのコンテンツ、dependencyRepositoryに対応するエントリ、およびその他のタイプの情報を示すダイアログが表示されます。検索もサポートされます。
「アセットのキャッシングのカスタマイズ」および「キャッシュ管理ツールの使用について」を参照してください。
アセットのキャッシングの無効化
アセットのキャッシングをサポートするようにinCacheフレームワークが設定されているときに、アセットのキャッシングを無効化する場合は、次の手順を実行します。
inCacheフレームワークの各WebCenter Sitesノードで、cs-cache.xml
ファイル(WEB-INF/classes/
ディレクトリにある)を開き、名前がAssetCacheで始まる<cache>
エレメントを削除します。選択した<cache>
エレメントを削除するか、すべての<cache>
エレメントを削除することができます。それぞれのエレメントはAssetCacheコンテナを表しています。「アセットのキャッシングのタイプ」を参照してください。
キャッシュ管理ツールの使用
アセットのキャッシングを構成する場合、キャッシュ管理ツールには、AssetCacheコンテナのコンテンツ、それに対応するdependencyRepository内のエントリ、その他の情報を示すダイアログが表示されます。検索もサポートされます。「キャッシュ管理ツールの使用について」を参照してください。
リモートのSatellite ServerのinCache機能の使用
リモートSatellite Serverは、ページ・キャッシングでのみ使用されます。これは、ページ伝播やバックグラウンドでのページ再生成など、高度な機能をサポートするように構成できます。
ページ伝播
ページ伝播オプションによって、すべてのWebCenter SitesノードとSatellite Serverノードが同じページをホストできるようになり、それぞれのノードがページを再生成する必要がなくなります。ノードは生成および再生成されたページを、ページの(再)生成元およびキャッシュ元のノードから、ローカル・キャッシュに受信します。ページのキャッシングによって伝播が引き起こされます。ページ伝播の詳細は、「ページ伝播の設定」を参照してください。
バックグラウンドでのページの再生成
リモートのSatellite Serverは、無効化されたページレットを提供する一方で、これがバックグラウンド・プロセスで再生成されるように構成できます。「バックグラウンドでページレットを再生成するための構成」を参照してください。