4. その他機能

本章では、WebOTX にて提供している運用ツール及びサポートツールについて設定方法、使用方法を解説します。

4.1. adminutilツール

4.1.1. はじめに

adminutilツールは、WebOTX Application Serverの運用設定をサポートする、コマンドベースのツールです。本ツールの対象バージョンは8.3以降となります。
実行の際は、環境変数にJAVA_HOMEの設定が必要となります。使用可能なJavaはJDK1.5以上です。

4.1.2. セットアップ

adminutilツールはCDの場合ディスクの1枚目に格納されています。格納名は以下の通りです。

• Windowsの場合

{メディアディレクトリ}\OTXTOOLS\webotx_tools.zip

• Linuxの場合

{メディアディレクトリ}/OTXTOOLS/OTXTOOLS-1.00.00.00.tar

• HP-UXの場合

{メディアディレクトリ}/OTXTOOLS/OTXTOOLS.tar

• Solarisの場合

{メディアディレクトリ}/OTXTOOLS/OTXTOOLS.tar

セットアップの手順は以下のとおりです。

1. メディアから、上記のアーカイブファイルを任意のディレクトリにコピーします。
   絶対パスに、2バイト文字が入るディレクトリにはコピーしないでください。

2. コピーしたアーカイブファイルを展開します。

3. [4.1.3. 使用方法]を参考にして使用してください。

4.1.3. 使用方法

4.1.3.1. export 機能

WebOTX Application Serverの管理対象であるドメインの設定情報の抽出(エクスポート)を行う機能です。
オプションを用いて、ドメインに接続し、設定された情報を取得します。

使用手順は以下のとおりです。なお、アーカイブファイルの展開した際に作成される webotx_tools ディレクトリを ${TOOLS_ROOT}と記載します。 Unix環境の場合は、\ を / に読み換えてください。

1. 以下の場所に移動します

   ${TOOLS_ROOT}\adminutil\bin

2. 以下のスクリプトを実行します。
   • Windows の場合　:　export.bat
   • Unix の場合　:　export.sh
   使用できるオプションについては、下記に記載してある「表4.1.3.1-1」を、オペランドについては「表4.1.3.1-2」を参照してください。
   
   実行例(Windows)

   > set JAVA_HOME={JDKインストールディレクトリ}
   > cd ${TOOLS_ROOT}\adminutil
   > bin\export.bat --user admin --password password --host localhost --port 6212 --outputfile sample domain1
   domain1 のすべての設定を出力します。
   設定の出力が完了しました。出力ファイルは{展開先ディレクトリ}\webotx_tools\adminutil\reports\sample.csvです。
   		

   実行例(Unix)

   $ export JAVA_HOME={JDKインストールディレクトリ}
   $ cd ${TOOLS_ROOT}/adminutil
   $ bin/export.sh --user admin --password password --host localhost --port 6212 --outputfile sample domain1
   domain1 のすべての設定を出力します。
   設定の出力が完了しました。出力ファイルは{展開先ディレクトリ}/webotx_tools/adminutil/reports/sample.csvです。
   		

   表4.1.3.1-1

   コマンド引数	説明	既定値
   --user	ドメインの管理ユーザ名です。	admin
   --password	ドメインの管理ユーザのパスワードです。	password
   --host	ドメインが起動しているマシン名です。	localhost
   --port	ドメインのポート番号です。	6212
   --protocol	ドメインとの接続プロトコルを選択します。 指定できるプロトコルは、rmi、jmxmpです。	rmi
   --secure	trueを指定すると、ドメインとの通信にSSL/TLSを利用します。既定値はfalseです。	false
   --help	コマンドで使用できるオプションを表示します。	false
   --outputfile	CSV形式にて出力するファイル名です。 以下に記述した文字はoutputfile及びディレクトリ名に指定することが出来ません。 \, /, :, *, ?, ", <, >, |, #, %	{ドメイン名}_{日時}.csv
   --version	本ツールのバージョン番号を表示します。	false
   --type	出力する設定の種類を以下より選択する。 全体(all) ドメイン(domain) TPシステム(tpsystem) アプリケーション(applications) リソース(resources) アプリケーションサーバ(server)	all
   --visibility	採取できる情報のレベルを指定します。設定できるレベルは1-3です。 レベルが高いほど多くの情報を採取します。	1
   --encrypt	trueの場合、パスワード情報を暗号化して出力します。 falseの場合、パスワード情報を平文で出力します。	true

   表4.1.3.1-2

   オペランド	説明
   domain_name	export対象のドメイン名を指定します。



3. 指定したオプションに従って、ドメインの設定情報がCSVファイルに出力されます。

   出力場所は outputfile オプションで指定された場所です。既定では ${TOOLS_ROOT}\adminutil\reports ディレクトリ配下となります。 出力される情報は以下となります。

   表4.1.3.1-3

   名称	説明
   ノード名	属性が所属する階層を表します。
   属性名	属性の名前です。
   設定値	属性の値です。
   import	import機能の対象とするかを 0 (対象外)か 1 (対象)で指定します。既定値は 1 です。
   識別子	本ツールで使用する識別子です。「UT**」またはCLINameが出力されます。

   "domain1/アプリケーションサーバ/Java EEサーバ"　　　...ノード名
   "Server Vendor","(c) NEC Corporation","1","UT185007"　　...属性名,　設定値,　import,　識別子
   		

4.1.3.2. import 機能

import機能とは、export機能を利用して出力した設定情報を、対象のドメインに設定を反映（インポート）する機能です。
export機能で出力した設定情報をjarファイルに変換し、jarファイルを実行することで、対象のドメインに設定を反映します。設定反映時にはオプションを用いて、インポート対象のドメインに接続する必要があります。

jarファイルの作成

使用手順は以下のとおりです。なお、アーカイブファイルの展開した際に作成される webotx_tools ディレクトリを ${TOOLS_ROOT}と記載します。 Unix環境の場合は、\ を / に読み換えてください。

1. 以下の場所に移動します

   ${TOOLS_ROOT}\adminutil\bin

2. 以下のスクリプトを実行してください。
   • Windows の場合　:　import.bat
   • Unix の場合　:　import.sh
   使用できるオプションについては、下記に記載してある「表4.1.3.2-1」を、オペランドについては「表4.1.3.2-2」を参照してください。
   
   実行例(Windows)

   > set JAVA_HOME={JDKインストールディレクトリ}
   > cd ${TOOLS_ROOT}\adminutil
   > bin\import.bat --outputfile outputfile --type all impot_file.csv
   impot_file.csv のすべての設定をインポートする jar を作成します。
   
   インポート用の Jarファイルの出力が完了しました。出力ファイルは{TOOLS_ROOT}\adminutil\artifacts\outputfile.jarです。

   実行例(Unix)

   $ export JAVA_HOME={JDKインストールディレクトリ}
   $ cd ${TOOLS_ROOT}/adminutil
   $ bin/import.sh --outputfile outputfile --type all impot_filename
   impot_file.csv のすべての設定をインポートする jar を作成します。
   
   インポート用の jarファイルの出力が完了しました。出力ファイルは{TOOLS_ROOT}/adminutil/artifacts/outputfile.jarです。

   表4.1.3.2-1

   コマンド引数	説明	既定値
   --help	コマンドで使用できるオプションを表示します。	false
   --outputfile	jar形式にて出力するファイル名です。 以下に記述した文字はoutputfile及びディレクトリ名に指定することが出来ません。 \, /, :, *, ?, ", <, >, |, #, %	{オペランドファイル名}.jar
   --version	本ツールのバージョン番号を表示します。	false
   --type	jarファイルに含める設定の種類を選択します。指定できる種類は以下の値です。 全体(all) ドメイン(domain) TPシステム(tpsystem) アプリケーション(applications) リソース(resources) アプリケーションサーバ(server)	all
   --importpass	trueの場合、インポート対象にパスワードを含めます。 falseの場合、インポート対象にパスワードを含めません。	false
   --decrypt	importpass オプションが true の場合に有効になります。 trueの場合、暗号化されたパスワード情報を復号化し、jar ファイルに含めます。 falseの場合、パスワード情報をそのまま jar ファイルに含めます。	true

   表4.1.3.2-2

   オペランド	説明
   file_name	export機能を使用して出力した設定情報ファイル(CSV形式)



3. 指定したオプションに従って、CSVファイルの情報を元に、インポート用のjarファイルが作成されます。なお、import 列の値が「1」となっている設定情報のみが対象となります。

出力場所は outputfile オプションで指定された場所です。既定では ${TOOLS_ROOT}\adminutil\artifacts ディレクトリ配下となります。

jarファイルの実行

上記で作成したjarファイルは、運用管理コマンド(otxadmin)を使用します。このため、運用管理コマンドが実行環境にインストールされていることを確認してください。また、Unixの場合、jarファイルを実行するユーザはWebOTXの管理ユーザと同様である必要があります。

1. jarファイルが配置されているディレクトリに移動し、以下のようにjarファイルを実行します。使用できるオプションについては、下記に記載してある「表4.1.3.2-3」を、オペランドについては「表4.1.3.2-4」を参照してください。
   


実行例(Windows)

> set JAVA_HOME={JDKインストールディレクトリ}
> cd {jarファイルが配置されているディレクトリ}
> java -jar {jarファイル名} --user admin --password password --adminuser admin --adminpassword password --type all domain_name

対象のドメインに対して、設定のインポートを開始します。この操作には数分かかることがあります。
JVMオプション設定のため、ドメインを再起動します。
domain_nameドメインを停止します。
domain_nameドメインを起動します。
Type:<domain> の設定が完了しました。
Type:<tpsystem> の設定のためサービス<tpsystem>を停止します。
Type:<tpsystem> の設定のためサービス<tpsystem>を起動します。
Type:<tpsystem1> の設定が完了しました。
Type:<applications> の設定が完了しました。
Type:<resources> の設定が完了しました。
Type:<server> の設定が完了しました。
Type:<tpsystem2> の設定が完了しました。
インポートは完了しました。全ての設定を反映させるために、ドメインを再起動する必要があります。

実行例(Unix)

$ export JAVA_HOME={JDKインストールディレクトリ}
$ cd {jarファイルが配置されているディレクトリ}
$ java -jar {jarファイル名} --user admin --password password --adminuser admin --adminpassword password --type all domain_name

対象のドメインに対して、設定のインポートを開始します。この操作には数分かかることがあります。
JVMオプション設定のため、ドメインを再起動します。
domain_nameドメインを停止します。
domain_nameドメインを起動します。
Type:<domain> の設定が完了しました。
Type:<tpsystem> の設定のためサービス<tpsystem>を停止します。
Type:<tpsystem> の設定のためサービス<tpsystem>を起動します。
Type:<tpsystem1> の設定が完了しました。
Type:<applications> の設定が完了しました。
Type:<resources> の設定が完了しました。
Type:<server> の設定が完了しました。
Type:<tpsystem2> の設定が完了しました。
インポートは完了しました。全ての設定を反映させるために、ドメインを再起動する必要があります。

4.1.4. コマンド実行に失敗した場合の対処方法

コマンドの実行に失敗した場合、${TOOLS_ROOT}\adminutil\logs配下にエラーログが出力されますので、内容を確認して対処してください。

以下に、コマンド実行に失敗する主なケースと、その対処方法を記載します。該当していないかを確認してください。

export/import機能が実行できない

環境変数に JAVA_HOME が正しく設定されているかを確認してください。
Windows環境の場合は、以下のようなエラーメッセージが出力されます。

指定されたパスが見つかりません。
	

ドメインへの接続ができない

user、password、host、port、protocol、secure オプションの値が正しいかを確認してください。
また、情報取得対象のドメインが起動していることを確認してください。

ファイルの上書きができない

outputfileオプションに既に存在するファイル名を指定した場合、実行に失敗します。別の出力ファイル名を指定するか、既に存在しているファイルを削除してください、

2バイト文字のディレクトリで実行することが出来ない

ディレクトリのパスに2バイト文字が含まれる場合実行に失敗し、以下のメッセージが出力されます。ディレクトリパスに2バイト文字を含まない場所に、adminutilツールを配置してください。

エラー:  'unknown protocol: d'
致命的エラー:  'スタイルシートをコンパイルできませんでした'
コマンド実行時にエラーが発生しました。ログファイルを確認してください
	

ファイルの破損

なんらかの原因により、ファイルが破損した場合は、再度ディスクから adminutil ツールをコピーしてください。

コマンドの実行でストール

情報取得対象のドメインに、大量のアプリケーション及びリソースが登録されていた場合、typeオプションにall、または applications を指定するとコマンドの実行に時間がかかることがあります。
実行中のコマンドを停止したい場合、Ctrl+Cにてコマンドの実行を停止することが可能です

4.1.5. 注意事項

adminutil ツールには以下の注意事項があります。

import機能

• 上位エディションの設定を、下位エディションにインポートすることはできません。
  
  
• スタンダードモードの設定をアドバンストモードのドメインにインポートする、または、アドバンストモードの設定をスタンダードモードのドメインにインポートすることはできません。
  
  
• CSVファイルにおいて属性値に「null」と記載してある場合、その属性への設定はスキップされます。 空文字列を設定したい場合は、属性値の欄を空にしてください。
  
  
• WebOTX Webサーバ を利用していないドメインに、「Webサーバ連携設定」の設定をインポートすると以下のエラーが出力されることがあります。
  

  server.web-container.plugin-configの属性設定に失敗しました。

  これは、WebOTX Webサーバ向けの設定を、WebOTX Webサーバを利用していない環境にインポートしようとしたために出力されています。「Webサーバ連携設定」の以下の設定をインポート対象外として、再度インポートを実施してください。
  • JkMountCopyの種類
  • ログのローテートの有効化
  • ログのローテート間隔
  • プラグインのログレベル
  
  
• WebServerの「SSL(HTTPS通信)の使用の有無」を true としていないドメインに、「WebServer」の設定をインポートすると以下のエラーが出力されることがあります。
  

  server.WebServerの属性設定に失敗しました。

  これは、SSLを有効にした場合のみ、設定が可能である設定をインポートしようとしたために出力されています。「WebServer」の以下の設定をインポート対象外として、再度インポートを実施してください。
  • HTTPS通信用の定義情報ファイル
  • HTTPS通信用のポート番号


• jdbcドライバ、キーファイル、証明書ファイルなど、ユーザが手動でWebOTXディレクトリ配下に配置したファイルはimport機能の対象外です。インポート先の同じディレクトリ配下に手動で配置してください。


• server.policyファイルはimport機能の対象外です。server.policyファイルを変更していた場合、インポート先のserver.policyに対して再度修正を行ってください。


• create-file-userコマンドで作成されたユーザはimport機能の対象外です。インポート先のドメインに対して、再度作成してください。

4.1.6. 制限事項

adminutil ツールには以下の制限事項があります。

export機能

• MBeanのプロパティは取得できません。


• 対象製品は、WebOTX Application Serverです。

import機能

• 対象製品は、WebOTX Application Serverです。


• 以下の設定は、インポートできません。
  • MBeanのプロパティ
  • Fileレルムの追加　(注1)
  • コネクタコネクションプールのセキュリティマップの作成
  • プロセスグループへのライフサイクルモジュールの追加
  • 仮想サーバの「リスナのリスト」への値の設定

  (注1) Fileレルムを作成しようとするとエラーになります。インポート対象外としてください。

• 以下の設定をインポートすると、ドメインの webotx_agent.log に警告ログが出力されます。adminutilツール側にエラーが出なければ、問題はありませんので、警告ログは無視してください。

  設定

  • クライアントセッション
    • 接続クライアント情報
  • キュー
    • キュー情報
  • プロセスグループ
    • プロセス情報
    • スレッド情報
  • JMXコネクタ
    • 接続中のクライアントのリスト
    • コネクタサーバの属性
  • JNDIサービス
    • 名前一覧

  警告メッセージ

        Failed to parse array : -1

4.2. 配備記述子変換ツール

配備記述子変換ツールは、V5以前のWebOTX上で動作するアプリケーションを、V6以降のWebOTX上で動作させたい場合に使用します。

V5以前のWebOTX上で動作するアプリケーションは、ベンダ固有配備記述子の変更により V6以降のWebOTX上では動作しません。V6、V7 では、配備ツールを利用することにより、 V5以前のアプリケーションをV6以降のWebOTXに配備することができます。 V8以降は、配備ツールを提供していないため、配備記述子変換ツールを用いてベンダ固有配備記述子を変換してください。

このツールは、 V5以前のWebOTX上で動作する、 .ear パッケージのうち、 .jar、または .war あるいはその両方を含むアプリケーションを対象とします。

4.2.1. 使用方法

• Windowsの場合

  ${AS_INSTALL}/bin> ddupdate.bat -d <outDirectoryPath> archiveFilePath1 [archiveFilePath2 archiveFilePath3...]

• Unixの場合

  ${AS_INSTALL}/bin> ./ddupdate -d <outDirectoryPath> archiveFilePath1 [archiveFilePath2 archiveFilePath3...]

4.2.1.1. 使用例

下記のコマンドを実行すると、変換された SampleApp1.ear と SampleApp2.ear が webotx_applications 配下に作成されます。

• Windowsの場合

  ${AS_INSTALL}/bin> ddupdate.bat -d C:/webotx_applications C:/sample/SampleApp1.ear C:/sample/SampleApp2.ear

• Unixの場合

  ${AS_INSTALL}/bin> ./ddupdate -d /webotx_applications /tmp/SampleApp1.ear /tmp/SampleApp2.ear

4.3. staticclassgen

staticclassgenは、EJB 3.0のビジネスインタフェースから、Homeインタフェース、Remoteインタフェースおよび、Wrapperクラスを生成するツールです。 これらインタフェースおよびクラスは既定ではEJBクライアントからのビジネスインタフェース名での初回lookup時に動的に生成されます。 アプリケーションクライアントや、単体EJBクライアントからの初回のlookupが遅いときは、これらクラスを生成していることが原因の可能性があります。 これが問題になる場合、staticclassgenを用いて静的にこれらクラスを生成し、EJBクライアントのクラスパスに追加してください。

4.3.1. 使用方法

• Windowsの場合

  ${AS_INSTALL}/bin> staticclassgen.bat [-jar <jarFileName>] [-classpath <classpaths>] [-d <dest>] businessInterface1 [businessInterface2...]

• Unixの場合

  ${AS_INSTALL}/bin> staticclassgen [-jar <jarFileName>] [-classpath <classpaths>] [-d <dest>] businessInterface1 [businessInterface2...]

4.3.1.1. 使用例

Hello.jar内のsample.Helloというビジネスインタフェースに対応するHomeとRemoteインタフェースとWrapperクラスを生成し、/tmp/Hello-additional.jarというファイルにパッケージングする場合の例です。

• Windowsの場合

  ${AS_INSTALL}/bin> staticclassgen.bat -d tmp -classpath Hello.jar -jar Hello-additional.jar sample.Hello

• Unixの場合

  ${AS_INSTALL}/bin> ./staticclassgen -d tmp -classpath Hello.jar -jar Hello-additional.jar sample.Hello