Liberty: featureManager コマンド

featureManager コマンドを使用して、フィーチャーをインストールしたり、 インストールされているすべてのフィーチャーの詳細を取得したりします。

インストールするフィーチャーは、サブシステム・アーカイブ (ESA ファイル) としてパッケージ化されている必要があります。

プロキシー・サーバーを介して featureManager コマンドを使用すると、 Liberty Repository にアクセスできます。 詳しくは、 Liberty での featureManager コマンドのプロキシー・サーバー・サポートの構成を参照してください。

重要: .esa ファイルをインストールする場合を除き、 featureManager findinstall、および uninstall の各アクションは安定化されます。

featureManager コマンドの代わりに、installUtility コマンドを使用します。 installUtility コマンドを使用すると、より多くのアセット・タイプを管理でき、複数のリポジトリーからアセットをインストール、検出、またはダウンロードすることができます。 詳しくは、 installUtility コマンドを使用した資産のインストールを参照してください。

構文

コマンド構文は次のようになります。

featureManager action [options]
ここで、action は、次のいずれかの値です。
install
安定化されたフィーチャー: このアクションは安定化されました。 .esa ファイルをインストールしない場合は、 installUtility install コマンドを使用します。 featureManager コマンドを使用して、 .esa ファイルをインストールします。
フィーチャーまたはエンタープライズ・サブシステム・アーカイブ (ESA) ファイルをランタイム環境にインストールします。
featureManager コマンドは、 Liberty Repositoryからアセットをダウンロードできます。 詳しくは、 Liberty Repository アセットのインストールを参照してください。
アンインストール
安定化されたフィーチャー: このアクションは安定化されました。 代わりに installUtility uninstall コマンドを使用してください。
フィーチャーのショート・ネームまたはフィーチャーのシンボル名のいずれかを使用してフィーチャーをアンインストールします。
注:
  • フィーチャーをアンインストールする前には、必ず、すべてのサーバー・プロセスを停止してください。
  • uninstall アクションは、ユーザー・フィーチャー (例えば、webCacheMonitor-1.0) をアンインストールできません。
featureList
インストールされているすべてのフィーチャーについて詳述するレポートを含む XML ファイルを生成します。
find
安定化されたフィーチャー: このアクションは安定化されました。 代わりに installUtility find コマンドを使用してください。
Liberty Repositoryのすべてのアセットのリストを生成するか、ご使用の構成に該当するアセットを Liberty Repository で検索するか、または詳細情報を表示します。
クラスパス
フィーチャー・リストからの API を使用するために、コンパイラー・クラスパスに追加できる JAR ファイルを生成します。 このアクションにより、フィックスパックの適用時に変更される可能性がある特定の JAR 名を参照することなく、製品に含まれている API JAR に対してビルド・スクリプトをコンパイルできます。 出力された JAR ファイルには、製品内の API JAR への相対パスが含まれます。 そのため、出力された JAR を別のディレクトリーに移動してはなりません。
注: このアクションでは、 --features オプションを指定する必要があります。
ヘルプ
指定したアクションのヘルプ情報を表示します。

オプション

featureManager install コマンドで使用可能なオプションは、以下のとおりです。
--acceptLicense
ライセンス条項に同意することを自動的に示します。
--downloadOnly=[all | required* | none]
要求したフィーチャーをインストールすることなくローカル・ディレクトリーにダウンロードします。 このオプションは、すべての依存関係フィーチャーをダウンロードするか、このランタイムに必要な依存関係フィーチャーをダウンロードするか、または依存関係フィーチャーを一切ダウンロードしないように構成できます。 デフォルトでは、必須の依存関係フィーチャーをダウンロードします。 --location オプションを使用してディレクトリーを指定します。
注: ファイル名または URL を使用してサブシステム・アーカイブの場所を指定する場合は、このオプションを使用できません。
-- location=directoryPath
フィーチャーのインストール時に、このオプションで、フィーチャーのインストール元として使用できるローカル・ソース・ディレクトリーを指定します。 --downloadOnly オプションとともに使用した場合、このオプションは、ダウンロードしたフィーチャーの宛先ディレクトリーを指定します。 --downloadOnly オプションおよび --offlineOnly オプションを使用する場合は、このオプションは必須です。
注: ファイル名または URL を使用してサブシステム・アーカイブの場所を指定する場合は、このオプションを使用できません。
--offlineOnly
Liberty Repositoryに接続しない場合は、このオプションを使用します。 このコマンドを使用した場合、ローカル・ディレクトリーからのフィーチャーのみがインストールされます。 ローカル・ディレクトリーは、--location オプションを使用して指定します。
注: ファイル名または URL を使用してサブシステム・アーカイブの場所を指定する場合は、このオプションを使用できません。
-- to=install_option
ここで、install_option は、次のいずれかの値です。
  • usr: フィーチャーはユーザー・フィーチャーとしてインストールされます。 これはデフォルト値です。
  • extension: フィーチャーをインストールするロケーション。 構成済みの任意の製品拡張ロケーションにフィーチャーをインストールできます。
--viewLicenseAgreement
ご使用条件を表示します。
--viewLicenseInfo
ライセンス情報を表示します。
--when-file-exists=exist_option
インストールするファイルが既に存在している場合の処置を指定します。 exist_option は、次のいずれかの値です。
  • fail: インストールを取り消します。
  • ignore: インストールを続行し、既存のファイルは無視します。
  • replace: 既存のファイルを上書きします。
--verbose
アクションの実行中に使用可能な追加情報を表示するには、このオプションを使用します。
名前
インストールする 1 つ以上のフィーチャーを、スペースまたはコンマで区切って指定します。 フィーチャーは以下の方法で指定できます。
フィーチャー ID
  • フィーチャーのショート・ネームを指定します (例: adminCenter-1.0)。
  • フィーチャーのシンボル名を指定します (例: com.ibm.websphere.appserver.adminCenter-1.0)。
.esa ファイル
  • ファイル名を指定します (例: my_feature.esa)。
  • URL を指定します (例: http://myhost.ibm.com/liberty/assets/my_feature.esa)。

このアクションは、サブシステムのシンボル名の後に名前変更される ${wlp.user.dir}/extensions/lib/features ディレクトリー ( --to プロパティーに値が指定されている場合は製品拡張ディレクトリー) にコピーできる新しいフィーチャー・マニフェストとして、 ESA ファイルの OSGI-INF/SUBSYTEM.MF ファイルを使用します。 サブシステムのすべてのバンドルが ${wlp.user.dir}/extensions/lib ディレクトリーに抽出され、{bundle symbolic name}_{bundle version}.jar と名前変更されます。 ライセンス・ファイル、チェックサム・ファイル、ローカリゼーション・ファイル、およびその他のサブシステム・コンテンツも、サブシステム・マニフェストで定義されたロケーションに抽出されます。

featureManager uninstall コマンドで使用可能なオプションは、以下のとおりです。
--noPrompts
ユーザーとの対話や確認メッセージなしでフィーチャーをアンインストールします。
--verbose
アクションの実行中に使用可能な追加情報を表示するには、このオプションを使用します。
名前
アンインストールする 1 つ以上のフィーチャーを指定します。名前はスペースまたはコンマで区切ります。 以下のオプションを指定できます。
  • サブシステム・アーカイブ (ESA ファイル) のショート・ネーム。例: adminCenter-1.0
  • サブシステム・アーカイブ (ESA ファイル) のシンボル名。例: com.ibm.websphere.appserver.adminCenter-1.0
featureManager featureList コマンドで使用可能なオプションは、以下のとおりです。
-- encoding=文字セット
ここで、charset は、XML レポート・ファイルの作成時に使用する文字セットです。
-- locale=言語
ここで、language は、XML レポート・ファイルの作成時に使用する言語を指定します。 これは、ISO-639 の小文字 2 文字の言語コードと、オプションで、その後に下線と ISO-3166 の大文字 2 文字の国別コードから構成されます。
--productExtension=名前
ここで name は、フィーチャーをリストする製品拡張の名前です。 製品拡張がデフォルト・ユーザー・ロケーションにインストールされている場合は、キーワード usrを使用します。 このオプションを指定しない場合、アクションは WebSphere® Application Server Liberty Coreに対して実行されます。
XML_report_file_name
作成する XML レポート・ファイルの名前を指定します。
--verbose
アクションの実行中に使用可能な追加情報を表示するには、このオプションを使用します。
featureManager find コマンドで使用可能なオプションは、以下のとおりです。
--viewInfo
詳細情報を表示します。
--verbose
アクションの実行中に使用可能な追加情報を表示するには、このオプションを使用します。
searchString
ご使用の構成に適用可能な Liberty Repository アセットのリストを生成します。
featureManager classpath コマンドで使用可能なオプションは、以下のとおりです。
-- features=feature1feature2、...
API JAR ファイルのリストが含まれているフィーチャーのリスト。 classpath アクションでは、このオプションは必須です。
fileName
生成される JAR ファイルの名前。

使用例

以下の例では、 サブシステム・アーカイブ my_feature.esa をユーザー・フィーチャーとしてインストールします。
featureManager install my_feature.esa --to=usr
以下の例では、 サブシステム・アーカイブ my_feature.esamy_extension の製品拡張ロケーションにインストールします。
featureManager install my_feature.esa --to=my_extension
以下の例では、 インストールされているすべてのフィーチャーに関するレポートを生成します。 このレポートは、ブラジル・ポルトガル語を使用してファイル my_feature_report.xml に作成されます。
featureManager featureList my_feature_report.xml --locale=pt_BR
以下の例では、ランタイム環境で usr 製品拡張と呼ばれる、デフォルトのユーザー・ロケーション wlp/usr/extensionにインストールされている製品拡張で定義されているすべてのインストール済みフィーチャーを含むレポートを生成します。 このレポートは、ファイル my_feature_report.xml に作成されます。
featureManager featureList --productExtension=usr my_feature_report.xml
以下の例では、製品インストール済み環境の etc/extensions ディレクトリーにある productExtensionName.properties ファイルの内容が指す場所にインストールされている製品拡張で定義されているすべての機能を含むレポートを生成します。 このレポートは、ファイル my_feature_report.xml に作成されます。
featureManager featureList --productExtension=productExtensionName my_feature_report.xml
以下の例では、 install アクションのヘルプ情報を表示します。
featureManager help install
以下の例では、フィーチャーをインストールし、追加情報を組み込みます。
featureManager install extendedPackage-1.0 --verbose
以下の例では、ご使用の構成に適用可能なアセットを検索します。
featureManager find searchString
以下の例では、詳細情報をリストします。
featureManager find searchstring --viewInfo
以下の例では、フィーチャーを検索し、追加情報を組み込みます。
featureManager find "adminCenter-1.0" --verbose
以下の例では、必要な依存関係を Liberty Repository からローカル・ディレクトリーにダウンロードしますが、インストールしません。
featureManager install feature_shortName --downloadOnly --location=c:\temp\download --acceptLicense
以下の例では、 Liberty Repositoryからすべての依存関係をダウンロードします。
featureManager install feature_shortName --downloadOnly=all --location=c:\temp\download --acceptLicense
以下の例では、ローカル・ディレクトリーにあるフィーチャーをインストールします。 欠落している依存関係がある場合、それらは Liberty Repositoryからインストールされます。
featureManager install feature_shortName --location=c:\temp\download --acceptLicense
以下の例では、欠落している依存関係を Liberty Repositoryからダウンロードせずに、ローカル・ディレクトリーからアセットをインストールします。
featureManager install feature_shortName --location=c:\temp\download --offlineOnly

以下の例では、クラスパス JAR ファイルを作成し、それを使用するアプリケーション・クラスをコンパイルします。

featureManager classpath --features=servlet-3.0 classpath.jar
javac -cp classpath.jar TestServlet.java
以下の例では、フィーチャーをアンインストールします。
featureManager uninstall adminCenter-1.0

戻りコード

表 1. 戻りコードと説明
戻りコード 説明
0 コマンドは、要求された操作を正常に完了しました。
20 1 つ以上の引数が無効です。
21 次の 1 つ以上の条件のため、実行時例外が発生しました。
  • .esa サブシステム・アーカイブ・ファイルのインストール中に実行時例外が発生した。
  • ライセンスが受諾も認知もされない。
  • .esa サブシステム・アーカイブ・ファイルが正しく解凍されなかった。
22 インストールしようとしているフィーチャーは既に存在します。
23 次の 1 つ以上の理由により、フィーチャー定義が無効でした。
  • フィーチャーが有効なマニフェスト・ファイルを持っていない。
  • フィーチャーのバージョンがこの Liberty 環境でサポートされていない。
  • フィーチャー・ファイルを含む .zip ファイルまたは .jar ファイルが存在しない。
24 .esa サブシステム・アーカイブ・ファイルにコンテンツが含まれていません。
25 インストールしようとしているファイルは既に存在しており、when-file-exists=fail オプションが指定されていました。
26 この製品はコア製品ではなく、製品拡張ファイルが見つかりません。
27 この製品はコア製品ではなく、製品拡張が ${wlp.install.dir}/etc/extensions/extension_name.properties ファイルに定義されていません。
28 製品拡張内のフィーチャーのマニフェスト・ファイルが見つかりません。
29 このフィーチャーは、現在の製品には無効です。
36 指定された拡張では、ユーザー・フィーチャーのインストールは無効です: --to=core。