Documentation

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

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

重要

ブラックリストは、DXP がアプリのアンインストールに使用する OSGi 設定 です。 これを使用すると、リストされているアプリは削除されるまでインストールされなくなります。

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

ブラックリスト登録

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

注釈

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

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

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

  1. [コントロールパネル]から、 [設定] → [System Settings] → [Module Container] へ行きます。 [Bundle Blacklist]画面が表示されます。

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

    このブラックリストは、classic-theme プラグイン WAR、Liferayコラボレーション - Liferay Blogs - API モジュール、および com.acme.greeter モジュールをアンインストールするものです。

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

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

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

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

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

  1. 現在使用中のブラックリストをエクスポートするには、そのアクションボタン(操作)から [エクスポート] をクリックします。 ブラックリスト構成ファイルがダウンロードされます(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 フォルダは通常、アプリケーションサーバーの親フォルダです。

バンドルシンボリック名をブラックリストに追加

タイプ

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

アプリ

App Managerに表示されるアプリ名

LPKG

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

モジュール/バンドルJAR

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

WAR

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

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

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

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

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

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

ちなみに

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

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

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