Documentation

アプリのブラックリスト登録

バンドルブラックリストは、複数のアプリ、OSGiバンドル(モジュール)、WARプラグインを一度にアンインストールまたは再インストールする便利な方法です。 アプリケーションマネージャーまたは Gogoシェル を使用して、アプリ、モジュール、プラグインのインストールを個別に管理する手間を省きます。

重要

The blacklist is an OSGi configuration that DXP uses to uninstall apps. これを使用すると、リストされているアプリは削除されるまでインストールされなくなります。

リスト は、コントロールパネル で設定するか、 コントロールパネルから エクスポートすることでOSGi構成 (.config)ファイルを使用して 設定できます。

ブラックリスト登録

DXPは、ブラックリストにあるインストール済みのアプリ、モジュール、プラグインをすべて削除します。 ブラックリストに登録されている間はインストールできません。 ログには、各アンインストールが記録されます。

注釈

LPKGをブラックリストに登録すると、その内部モジュールがすべてアンインストールされます。

コントロールパネルを介したブラックリスト登録

次の手順に従って、アプリ、モジュール、プラグインをブラックリストに登録します。

  1. コントロールパネルで、 [Configuration] → [System Settings] → [Module Container] に移動します。 [Bundle Blacklist]画面が表示されます。

  2. [Bundle Blacklist]画面で、アンインストールする モジュール JAR、LPKGファイル、またはWARのバンドルシンボリック名( 下の表 を参照)を追加します。 完了したら、 [保存] ボタンをクリックします。 DXPはブラックリストに登録されたモジュールをすぐにアンインストールします。

このブラックリストは、com.liferay.docs.greeting.apiモジュール、Liferay マーケットプレイスアプリのLPKG、およびクラシックテーマのプラグインWARをアンインストールします。

構成ファイルによるブラックリスト登録

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

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

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

次の手順に従って、構成ファイルを使用してブラックリストに登録します。

  1. 現在使用中のブラックリストをエクスポートするには、そのアクションボタン(アクション)をクリックしてから、 [Export] をクリックします。 次に、ブラックリスト構成ファイルがダウンロードされます(com.liferay.portal.bundle.blacklist.internal。BundleBlacklistConfiguration.config)。 次に、サンプルのブラックリストをエクスポートしたときのファイルの内容を示します。

    blacklistBundleSymbolicNames=[ \
      "classic-theme", \
      "Liferay\ Collaboration\ -\ Liferay\ Blogs\ -\ API", \
      "com.acme.greeter", \
    ]
    
  2. アンインストールして以降のDXPサーバーの起動時にインストールしないようにする、リストにまだないアプリ、モジュール、またはプラグインのバンドルシンボリック名を追加します。

    警告

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

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

ブラックリストバンドルのシンボリック名

タイプ

バンドルのシンボリック名

LPKG

拡張子.lpkgなしのLPKGファイル名

バンドル/モジュールJAR

bnd.bndまたはMANIFEST.MFファイルのBundle-SymbolicName

WAR

liferay-plugin-package.propertiesファイル内のサーブレットコンテキスト名、またはサーブレットコンテキスト名プロパティがない場合はWARファイル名(.warを削除)

ブラックリスト登録されているアイテムの再インストール

ブラックリストに登録されたアイテムを再インストールするには、次の手順に従います。

  1. 構成ファイルcom.liferay.portal.bundle.blacklist.internalBundleBlacklistConfiguration.configを開きます。

  2. LPKG、モジュールJAR、またはWARのシンボリック名をblacklistBundleSymbolicNamesリストから削除し、ファイルを保存します。

ブラックリスト登録されている すべての アイテムを再インストールするには、次のいずれかのオプションを実行します。

ちなみに

ブラックリストに登録されているアイテムを一時的に再インストールするには、[System Settings]のバンドルブラックリストモジュールからそのシンボリック名を削除し、[Update]ボタンをクリックします。 If you're using a blacklist config file (in the [Liferay Home]/osgi/configs folder) and want the item to install on subsequent server startup, make sure to remove the item's symbolic name from the file.

ログには、各アイテムのインストールが記録されます。

簡単なリストを使用して、複数のアプリ、モジュール、プラグインのインストールを管理できるようになりました。