アプリのブラックリスト登録
バンドルブラックリストは、複数のアプリケーション、OSGiバンドル(モジュール)、およびWARプラグインを一度にアンインストールまたは再インストールするための便利な方法です。これにより、アプリケーションマネージャーやGogoシェルを使って、アプリ、モジュール、プラグインのインストールを個別に管理する手間が省けます。
ブラックリストは、DXP がアプリをアンインストールするために使用する OSGi 構成 です。これを使用すると、リストされているアプリは削除されるまでインストールできなくなります。
リストは、コントロールパネルで、またはOSGi構成(.config)ファイル(コントロールパネルからエクスポート)を使用して設定できます。
ブラックリスト登録
DXPは、ブラックリストにあるインストール済みのアプリ、モジュール、プラグインをすべて削除します。ブラックリストに登録されている間はインストールできません。ログには、各アンインストールが記録されます。
LPKGファイルをブラックリストに登録すると、そのファイルに含まれるすべての内部モジュールがアンインストールされます。
コントロールパネル経由でのブラックリスト登録
次の手順に従って、アプリ、モジュール、プラグインをブラックリストに登録します。
-
コントロール パネルで、 システム設定 → モジュール コンテナー に移動します。バンドルブラックリスト画面が表示されます。
-
バンドルブラックリスト画面で、アンインストールするアプリ、LPKG ファイル、 モジュール JAR、または WAR のバンドルシンボル名を追加します。各項目について、「追加」ボタン(
)をクリックし、その項目のバンドルシンボリック名を入力してください(下の表を参照)。完了したら、 保存 ボタンをクリックしてください。 DXPはブラックリストに登録されたアイテムを即座にアンインストールします。
設定ファイルによるブラックリスト登録
ブラックリストは、コントロールパネルからOSGi構成(.config)ファイルにエクスポートすることもできます。ファイルを変更してDXPにデプロイすると、次のような追加の効果があります。
- DXPサーバーの起動後も変更内容が保持されます。
- ローカルクラスタノードで行われた変更を、他のすべてのノードに伝播します。
次の手順に従って、構成ファイルを使用してブラックリストに登録します。
-
現在使用中のブラックリストをエクスポートするには、そのアクションボタン(
)をクリックし、 エクスポートをクリックします。ブラックリスト設定ファイルがダウンロードされます (com.liferay.portal.bundle.blacklist.internal.configuration.BundleBlacklistConfiguration.config)。以下は、サンプルブラックリストをエクスポートした際のファイルの内容です。blacklistBundleSymbolicNames=[ \ "classic-theme", \ "Liferay\ Collaboration\ -\ Liferay\ Blogs\ -\ API", \ "com.acme.greeter", \ ] -
アンインストールして、以降の DXP サーバー起動時にインストールされないようにしたい、リストに載っていないアプリ、モジュール、またはプラグインのバンドルシンボル名を追加してください。
警告設定値には余分なスペースを含めることはできません。余分なスペースがあると、リストが正しく機能しなかったり、設定エントリが無効になったりする可能性があります。
-
構成ファイルをデプロイするには、フォルダ
[Liferay Home]/osgi/configsにコピーします。 Liferay Home フォルダは、通常、アプリケーション サーバーの親フォルダです。
ブラックリストバンドルのシンボル名
ブラックリストに登録されたアイテムの再インストール
ブラックリストに登録されたアイテムを再インストールするには、次の手順に従います。
-
設定ファイル
com.liferay.portal.bundle.blacklist.internal.configuration.BundleBlacklistConfiguration.configを開きます。 -
LPKG、モジュールJAR、またはWARのシンボリック名を
blacklistBundleSymbolicNamesリストから削除し、ファイルを保存します。
ブラックリストに登録された項目をすべて再インストールするには、以下のいずれかのオプションを実行してください:
- 設定ファイルを削除してください。
com.liferay.portal.bundle.blacklistを Application Manager または Felix Gogo Shell を使用してアンインストールします。
ブラックリストに登録されたアイテムを一時的に再インストールするには、 システム設定 のバンドル ブラックリスト モジュールからそのシンボル名を削除し、 更新 ボタンをクリックします。ブラックリスト設定ファイル( [Liferay Home]/osgi/configs フォルダー内)を使用しており、次回のサーバー起動時にアイテムをインストールしたい場合は、ファイルからアイテムのシンボリック名を削除してください。
ログには、各アイテムのインストールが記録されます。
簡単なリストを使用して、複数のアプリ、モジュール、プラグインのインストールを管理できるようになりました。