Documentation

OSGiコンポーネントのブラックリスト登録

コンポーネントブラックリストは、複数の OSGi宣言型サービスコンポーネント (コンポーネント)を管理する便利な方法です。 リストは、DXPがコンポーネントを無効にするために使用する OSGi設定 です。 これらのリストを使用すると、アプリケーションマネージャーGogoシェルで個別に変更する手間が省けます。

ブラックリストは、コントロールパネルからOSGi構成(.config)ファイルにエクスポートできます。 ファイルを変更してDXPにデプロイすると、次のような追加の効果があります。

  • DXPサーバーの起動時の変更を保持します

  • ローカルクラスターノードから他のすべてのノードに変更を伝播します。

UIと構成ファイルを使用してコンポーネントをブラックリストに登録する方法を示します。

コンポーネントのブラックリスト登録

OSGiコンポーネントを無効にするには、次の手順に従います。

  1. [コントロールパネル]から、 [設定] → [システム設定] → [モジュール・コンテナー] へ行きます。 [コンポーネントブラックリスト]画面が表示されます。

  2. [コンポーネントブラックリスト]画面で、無効にするコンポーネントの名前を追加し、 [保存] ボタンをクリックします。 コンポーネントはすぐに無効になります。

    このブラックリストは、コンポーネントcom.liferay.portal.security.ldap.internal.authenticator.LDAPAuthおよびcom.liferay.ip.geocoder.sample.web.internal.portlet.IPGeocoderSamplePortletを無効にします。

  3. ブラックリストをエクスポートするには、コンポーネントブラックリストモジュールのアクションボタン(操作)から [エクスポート] をクリックします。 ブラックリスト構成ファイルがダウンロードされます(com.liferay.portal.component.blacklist.internal.ComponentBlacklistConfiguration.config)。 サンプルのリストから作成されたファイルの内容は次のとおりです。

    blacklistComponentNames=["com.liferay.portal.security.ldap.internal.authenticator.LDAPAuth","com.liferay.ip.geocoder.sample.web.internal.portlet.IPGeocoderSamplePortlet "]
    
  4. まだリストにない有効にしたくないコンポーネント(たとえば、まだインストールされていないモジュールのコンポーネント)の名前を追加します。

    重要

    構成値に余分なスペースを含めることはできません。 余分なスペースがあると、リストが短絡したり、構成エントリが無効になったりする可能性があります。

  5. 構成ファイルをデプロイするには、フォルダ[Liferay Home]/osgi/configsにコピーします。 Liferay Homeフォルダは通常、アプリケーションサーバーの親フォルダです。

ブラックリストに登録されたコンポーネントを再度有効にする

ブラックリストに登録されたOSGiコンポーネントの再有効化と有効化を許可するには、次の手順に従います。

  1. 構成ファイル[Liferay Home]/osgi/configs/com.liferay.portal.component.blacklist.internal.ComponentBlacklistConfiguration.configを開きます。

  2. blacklistComponentNamesリストからコンポーネントの名前を削除し、ファイルを保存します。

ブラックリストに登録されている すべての コンポーネントを有効にするには、構成ファイルを削除します。

注釈

ブラックリストに登録されているコンポーネントを一時的に再度有効にするには、システム設定でコンポーネントブラックリスト設定モジュールからその名前を削除し、[アップデート]をクリックします。 コンポーネントのブラックリスト構成ファイル([Liferay Home]/osgi/configsフォルダ内)を使用していて、その後のサーバー起動時にコンポーネントを有効にする場合は、そのコンポーネントの名前をファイルから忘れずに削除してください。

これで、単純なリストを使用して複数のコンポーネントを管理できるようになりました。