|
|
WebOTX Manual V10.3 (第4版) 目次を表示 |
|
|
|
WebOTX Manual V10.3 (第4版) 目次を表示 |
本章では、WebOTX にて提供している運用ツール及びサポートツールについて設定方法、使用方法を解説します。
adminutilツールはotxadminコマンドに機能が統合されました。adminutilツールで提供していた機能については、[ 移行: > エクスポート/インポート] を確認してください。
staticclassgenは、EJB 3.0のビジネスインタフェースから、Homeインタフェース、Remoteインタフェースおよび、Wrapperクラスを生成するツールです。 これらインタフェースおよびクラスは既定ではEJBクライアントからのビジネスインタフェース名での初回lookup時に動的に生成されます。 アプリケーションクライアントや、単体EJBクライアントからの初回のlookupが遅いときは、これらクラスを生成していることが原因の可能性があります。 これが問題になる場合、staticclassgenを用いて静的にこれらクラスを生成し、EJBクライアントのクラスパスに追加してください。
${AS_INSTALL}/bin> staticclassgen.bat [-jar <jarFileName>] [-classpath <classpaths>] [-d <dest>] businessInterface1 [businessInterface2...]
${AS_INSTALL}/bin> staticclassgen [-jar <jarFileName>] [-classpath <classpaths>] [-d <dest>] businessInterface1 [businessInterface2...]
| コマンド引数 | 説明 |
|---|---|
| -jar | 生成されたクラスをパッケージングするJarファイルの名前を指定します。省略時はパッケージングされず、classファイルが出力されます。 |
| -classpath | クラスパスを指定します。少なくともビジネスインタフェースはクラスパスに含まれている必要があります。ビジネスインタフェースが他のライブラリを参照している場合、それも必要です。 |
| -d | Jarファイルあるいはclassファイルの出力先ディレクトリを指定します。無指定の場合はカレントディレクトリに出力されます。 |
| businessInterface | ビジネスインタフェースを完全修飾クラス名で指定します。複数列挙することにより、同時に複数のビジネスインタフェースを対象にできます。 |
Hello.jar内のsample.Helloというビジネスインタフェースに対応するHomeとRemoteインタフェースとWrapperクラスを生成し、/tmp/Hello-additional.jarというファイルにパッケージングする場合の例です。
${AS_INSTALL}/bin> staticclassgen.bat -d tmp -classpath Hello.jar -jar Hello-additional.jar sample.Hello
${AS_INSTALL}/bin> ./staticclassgen -d tmp -classpath Hello.jar -jar Hello-additional.jar sample.Hello
マイクロサービスビルドツールは、コマンドオプションで指定されたマイクロサービスプロファイルを展開し、
ユーザアプリケーション、ユーザライブラリ、任意設定ファイル、起動スクリプト、Dockerファイルの配置、
設定ファイル（config.properties）によるDomain.xmlの更新を行い、マイクロサービスパッケージとしてアーカイブファイル（*.zip）を出力するツールです。
マイクロサービスビルドツールは、Windows環境においてWebOTX Developer をインストールすることで、<WebOTXインストールディレクトリ>\Developer\ms-build-tool にインストールされます。（以降、マイクロサービスビルドツールのインストールディレクトリを ${TOOL_DIR} と記述します。）
Linux環境においてもコマンドで使用することが可能ですが、 ${TOOL_DIR} 配下をアーカイブし、Linux環境にファイル転送して、展開する必要があります。
詳細は、[Linux環境へのインストール方法]を確認してください。
${TOOL_DIR}\bin>ms-build-tool.bat --app-server-name MicroServiceProfile --app-file application(*.war) [--lib-file LibraryFile] [--config-file configProperties] [--option-file optionFile] [--bootstrap-file scriptFile] [--docker-setting DockerSettingFile] [--output-file outputFile] [--echo [ true｜false ]] [--version] [--help [オプション名|all]] [--clean]
${TOOL_DIR}/bin>./ms-build-tool.sh --app-server-name MicroServiceProfile --app-file application(*.war) [--lib-file LibraryFile] [--config-file configProperties] [--option-file optionFile] [--bootstrap-file scriptFile] [--docker-setting DockerSettingFile] [--output-file outputFile] [--echo [ true｜false ]] [--version] [--help [オプション名|all]] [--clean]
| コマンド引数 | 説明 |
|---|---|
| --app-server-name | インストーラ、あるいは任意のリポジトリからダウンロードしたマイクロサービスプロファイルを指定します。 ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、${TOOL_DIR}/app-server をカレントとする相対パスで指定します。 このオプションは、必須です。 |
| --app-file | コンパイルしてパッケージングしたアプリケーションファイル(*.war)を指定します。 ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。 このオプションは、必須です。 |
| --lib-file | アプリケーションファイル(*.war)が使用するライブラリファイル(*.jar)を指定します。 ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。 Windows環境でライブラリファイルを複数指定する場合は、";"（セミコロン）で区切って指定します。Linux環境の場合は、":"（コロン）で区切って指定します。 このオプションは、省略可能です。 |
| --config-file | マイクロサービスの domain.xml の設定変更を行うコンフィグプロパティファイル（config.properties）を指定します。 ファイルの指定は、絶対パスまたは、相対パスで指定します。相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。 このオプションは、省略可能です。オプションを省略した場合は、${TOOL_DIR}/config/default-config.properties を使用して、domain.xmlの設定を行います。 コンフィグプロパティファイル（config.properties）の設定内容については、[設定値の変更]を確認してください。 |
| --option-file | マイクロサービス向け任意設定ファイルを指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。 相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。 Windows環境で任意設定ファイルを複数指定する場合は、";"（セミコロン）で区切って指定します。Linux環境の場合は、":"（コロン）で区切って指定します。 このオプションは、省略可能です。 |
| --bootstrap-file | 起動スクリプト(ドメインの起動+プロセス監視)を指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。 相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。 このオプションは、省略可能です。オプションを省略した場合は、${TOOL_DIR}/config/default-run.sh.templateを使用します。 |
| --docker-setting | Dockerファイルを指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。 相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。 このオプションは、省略可能です。オプションを省略した場合は、${TOOL_DIR}/config/default-run.sh.templateを使用します。 |
| --output-file | マイクロサービスパッケージの出力ファイルを指定します。ファイルの指定は、絶対パスまたは、相対パスで指定します。 相対パスで指定する場合は、コマンドの実行ディレクトリをカレントとする相対パスで指定します。 このオプションは、省略可能です。オプションを省略した場合は、既定ファイル名my-ms-webotx-as.zipで、カレントディレクトリに出力します。 |
| --echo | コマンドエコーの表示（true）、非表示（false）を指定します。このオプションは、省略可能です。オプションを省略した場合は、表示（true）を使用します。 |
| --version | マイクロサービスビルドツールのバージョンを表示します。このオプションは、他のオプションと併用できません。 |
| --help | マイクロサービスビルドツールのヘルプを表示します。
allまたは、オプション名を省略した場合は、usageとしてコマンドの書式を一覧を表示します。 オプション名を指定した場合は、指定したオプション名の書式および説明を表示します。 |
| --clean | マイクロサービスプロファイル（*.zip）の展開ディレクトリを削除してファイルの展開を行います。展開ディレクトリは、--app-server-nameのコマンドオプションで指定されたファイルと同じディレクトリに作成します。 コマンドオプションを指定しない場合は、前回マイクロサービスプロファイルを展開した各ファイルを使用して、今回指定したファイルの配置および、更新を行います。前回と今回で配置するファイルが異なった場合、前回配置したファイルは削除されません。ファイル名が同一であれば、ファイルを上書きして配置します。 |
マイクロサービスプロファイル（${TOOL_DIR}/app-server/webotx-as-microprofile-1.2.zip）、アプリケーションファイル（${TOOL_DIR}/tmp/example.war）、ライブラリファイル（${TOOL_DIR}/tmp/example.jar）を使用して、マイクロサービスパッケージファイル（（${TOOL_DIR}/tmp/my-ms-package.zip）を作成する場合のコマンド例です。
${TOOL_DIR}> .\bin\ms-build-tool.bat --app-server-name webotx-as-microprofile-1.2.zip --app-file .\tmp\example.war --lib-file .\tmp\example.jar --output-file .\tmp\my-ms-package.zip
${TOOL_DIR}> ./bin/ms-build-tool.sh --app-server-name webotx-as-microprofile-1.2.zip --app-file ./tmp/example.war --lib-file ./tmp/example.jar --output-file ./tmp/my-ms-package.zip
Windows環境にインストールされているWebOTX Developer に同梱されているマイクロサービスビルドツールをLinux環境へインストールする方法を説明します。
マイクロサービスビルドツールがインストールされているディレクトリ（<WebOTXインストールディレクトリ>\Developer\ms-build-tool）を ${TOOL_DIR} として、以降記述します。
コンテナ向けアプリケーション検証ツールコマンドは、コマンドオプションで指定されたプロジェクトソースディレクトリやアプリケーションアーカイブなどのアプリケーション
を展開し、変更が必要な領域を強調するHTMLレポートを生成するコマンドです。
コンテナ向けアプリケーション検証ツールコマンドは、Windows環境においてWebOTX Developerをインストールすることで、<WebOTXインストールディレクトリ>\Developer\migration_Toolkit にインストールされます。（以降、インストールディレクトリを {TOOL_DIR} と記述します。）
Linux環境においてもコマンドで使用することが可能ですが、 {TOOL_DIR} 配下をアーカイブし、Linux環境にファイル転送して、展開する必要があります。
詳細は、[Linux環境へのインストール方法]を確認してください。
{TOOL_DIR}>.\bin\amt-cli.bat [--sourcemode] --input InputApplicationPath [--overwrite] --output ReportOutDirectory --target {[wo-mo] [wo-fp]} [--userignorepath IgnorePath] [--help] [--version]
{TOOL_DIR}>./bin/amt-cli.sh [--sourcemode] --input InputApplicationPath [--overwrite] --output ReportOutDirectory --target {[wo-mo] [wo-fp]} [--userignorepath IgnorePath] [--help] [--version]
| コマンド引数 | 説明 |
|---|---|
| --input | 検証対象のディレクトリパスまたは、ファイルを指定します。（複数指定不可） このオプションは、必須です。 |
| --output | レポート出力先のディレクトリパスを指定します。（複数指定不可） このオプションは、必須です。 |
| --target | 移行先ターゲットを指定します。 このオプションは、必須です。 オプションパラメータとして指定可能なターゲットは wo-fp、wo-mp のみ指定可能です。 ・wo-fp：フルプロファイル向け検証を行います。 ・wo-mp：マイクロプロファイル向け検証を行います。 このオプションパラメータは省略可能ですが、どちらか一方の指定が必須です。 |
| --sourcemode | --inputで指定したディレクトリにソースファイルが含まれる時に指定します。 このオプションは、省略可能です。 オプション省略時、ソースファイルなしと判断して検証します。 |
| --userignorepath | 検証除外設定ファイルを配置したディレクトリパスを指定します。 除外設定ファイルは、[任意文字]windup-ignore.txtの形式で作成する必要があります。 作成フォーマットについては、[検証除外ファイル作成方法]を確認してください。 このオプションは、省略可能です。 |
| --overwrite | --outputで指定された、既存の出力ディレクトリに上書き出力する場合に指定します。 このオプションは、省略可能です。 オプション省略時、--outputで指定されたディレクトリが存在する場合、実行プロントで[上書きの選択]を求められます。 |
| --version | バージョン情報を表示します。 他のオプションとの併用時、他のオプションは無視します。 |
| --help | usageとしてコマンドの書式を一覧を表示します。 他のオプションとの併用時、他のオプションは無視します。 |
{TOOL_DIR}> .\bin\amt-cli.bat --input INPUT_ARCHIVE_DIRECTORY_PATH\jee-example-app-1.0.0.ear --output OUTPUT_REPORT_DIRECTORY_PATH --target wo-mp wo-fp
{TOOL_DIR}> .\bin\amt-cli.bat --input INPUT_ARCHIVE_DIRECTORY_PATH --output OUTPUT_REPORT_DIRECTORY_PATH --target wo-mp wo-fp
{TOOL_DIR}> .\bin\amt-cli.bat --sourcemode --input INPUT_SOURCE_DIRECTORY_PATH --output OUTPUT_REPORT_DIRECTORY_PATH --target wo-mp wo-fp
{TOOL_DIR}> .\bin\amt-cli.bat --sourcemode --input INPUT_SOURCE_DIRECTORY_PATH --overwrite --output OUTPUT_REPORT_DIRECTORY_PATH --target wo-mp wo-fp
{TOOL_DIR}> .\bin\amt-cli.bat --sourcemode --input INPUT_SOURCE_DIRECTORY_PATH --overwrite --output OUTPUT_REPORT_DIRECTORY_PATH --target wo-mp
Caution
JavaDoc構文が存在する検証アプリケーションソースコードを --sourcemode 指定で検証した場合、ソースレポート内で指摘される行数がずれる事があります。
JavaDoc構文が存在する場合のソースレポートについては、[JavaDoc構文が存在する場合のSource Report (移行課題があるソースの詳細)]を参照してください。
レポート生成中に、含まれているライブラリや依存関係などの特定のファイルを除外できます。
無視されるファイルは、[任意文字]windup-ignore.txtファイル内で定義します。
このファイルには、除外する名前の詳細を示す正規表現文字列が含まれ、1行に1つ定義します。
たとえば、ant.jarで終わるライブラリと、ファイル名にExampleを含むJavaソースファイルを除外するには、以下のように定義します。
.*ant\.jar .*Example.*\.java
--outputで指定されたディレクトリが存在する場合、次のプロンプトが表示されます（デフォルトはN）。
Overwrite all contents of "OUTPUT_REPORT_DIRECTORY_PATH" (anything already in the directory will be deleted)? [y,N]
yを指定すると、コンテナ向けアプリケーション検証ツールコマンドはディレクトリの削除と再作成を続行します。
Nを指定すると、コンテナ向けアプリケーション検証ツールコマンドは検証を中断します。
Windows環境にインストールされているWebOTX Developerに同梱されているコンテナ向けアプリケーション検証ツールコマンドをLinux環境へインストールする方法を説明します。
コンテナ向けアプリケーション検証ツールコマンドがインストールされているディレクトリ（<WebOTXインストールディレクトリ>\Developer\migration_Toolkit）を {TOOL_DIR} として、以降記述します。