ユーティリティー・スクリプト

スクリプト・ライブラリーは、アプリケーションの構成を自動化するための複数のスクリプト・プロシージャーを提供します。スクリプトの使用法を参照してください。各スクリプトでは、通知オプションを設定し、構成変更を保存し、スクリプト・ライブラリーの情報を表示できます。

各ユーティリティー・スクリプト・プロシージャーは、app_server_root/scriptLibraries/utilities/V70 ディレクトリーにあります。 以下のスクリプト手順でユーティリティー機能を実行できます。

convertToList

このスクリプトは、ストリングをリストに変換します。 例えば、AdminApp.list() コマンドはアプリケーション名のストリングを返します。 convertToList スクリプトを使用すると、出力を ['DefaultApplication', 'a1', 'a2', 'ivtApp', 'query'] などのリスト・フォーマットに変換できます。

表 1. convertToList 引数の説明. ストリング出力を返して、その出力を変数に設定するには、このスクリプトを実行します。
引数 説明
variable リストに変換するストリングを格納する変数の名前を指定します。

構文

AdminUtilities.convertToList(variable)

使用例

apps=AdminApp.list()
AdminUtilities.convertToList(apps)

debugNotice

このスクリプトは、デバッグ通知テキストを設定します。

表 2. debugNotice 引数の説明. メッセージの引数を指定して、このスクリプトを実行します。
引数 説明
message デバッグ通知用のメッセージ・テキストを指定します。

構文

AdminUtilities.debugNotice(message)

使用例

AdminUtilities.debugNotice("Server is started")

getExceptionText

このスクリプトでは、特定の例外タイプ、例外値、トレースバック情報に関する例外メッセージを表示します。

表 3. getExceptionText 引数の説明. タイプ、値、またはトレースバックの引数を指定して、このスクリプトを実行します。
引数 説明
type 対象の例外タイプを指定します。 例外のタイプは、例外のクラス・オブジェクトに対応します。
value 対象の例外値を指定します。 この値は、例外の引数または raise ステートメントの 2 番目の引数であるインスタンス・オブジェクトに対応します。
traceback 対象のトレースバック情報を指定します。 トレースバック・オブジェクトには特別の属性 (エラーが発生した行番号など) が含まれています。例外を処理する関数のローカル変数に traceback を割り当てることはしないでください。そのようにすると、循環参照になります。

構文

AdminUtilities.getExceptionText(type, value, traceback)

使用例

AdminUtilities.getExceptionText("com.ibm.ws.scripting.ScriptingException"
, "com.ibm.ws.scripting.ScriptingException: AdminControl service not available"
, "")

fail

このスクリプトは、障害メッセージを設定します。

表 4. fail 引数の説明. メッセージの引数を指定して、このスクリプトを実行します。
引数 説明
message 障害通知用のメッセージ・テキストを指定します。

構文

AdminUtilities.fail(message)

使用例

AdminUtilities.fail("The script failed")

fileSearch

このスクリプトは、特定のパスまたはディレクトリーに基づいてファイル・システム内を検索します。

表 5. fileSearch 引数の説明. パスまたはディレクトリーの引数を指定して、このスクリプトを実行します。
引数 説明
path 特定のファイルを検索するためのファイル・パスを指定します。
directory 特定のファイルを検索するためのディレクトリーを指定します。

構文

AdminUtilities.fileSearch(path, directory)

使用例

[Windows]
Paths = []
Directory = java.io.File("c:¥¥WebSphere¥¥AppServer¥¥scriptLibraries")
AdminUtilities.fileSearch(directory, paths)
[Linux][AIX][HP-UX][Solaris][IBM i][z/OS]
Paths = []
Directory = java.io.File("//WebSphere//AppServer//scriptLibraries")
AdminUtilities.fileSearch(directory, paths)

getResourceBundle

このスクリプトは、対象のリソース・バンドルのインスタンスを表示します。

表 6. getResourceBundle 引数の説明. バンドル名の引数を指定して、このスクリプトを実行します。
引数 説明
bundleName 対象のバンドルの名前を指定します。 例えば、ScriptingLibraryMessage リソース・バンドルからメッセージ・オブジェクトを取得する場合は、com.ibm.ws.scripting.resources.scriptLibraryMessage を指定します。

構文

AdminUtilities.getResourceBundle(bundleName)

使用例

AdminUtilities.getResourceBundle("com.ibm.ws.scripting.resources.scriptLibraryMessage")

getScriptLibraryFiles

このスクリプトでは、各スクリプト・ライブラリー・ファイルのファイル・パスとファイル名を表示します。

構文

AdminUtilities.getScriptLibraryFiles()

使用例

AdminUtilities.getScriptLibraryFiles()

getScriptLibraryList

このスクリプトは、スクリプト・ライブラリー内の各スクリプト名を表示します。

構文

AdminUtilities.getScriptLibraryList()

使用例

AdminUtilities.getScriptLibraryList()

getScriptLibraryPath

このスクリプトでは、ファイル・システムにあるスクリプト・ライブラリー・ファイルのファイル・パスを表示します。

構文

AdminUtilities.getScriptLibraryPath()

使用例

AdminUtilities.getScriptLibraryPath()

help

このスクリプトは、AdminUtilities スクリプト・ライブラリーのヘルプ情報を表示します。この情報には、一般的なライブラリー情報、スクリプト名、およびスクリプトの説明が含まれます。

表 7. help 引数の説明. 対象のスクリプトに関する情報を取得するには、このスクリプトを実行します。
引数 説明
scriptName オプションとして、対象の AdminUtilities スクリプトの名前を指定します。

構文

AdminUtilities.help(scriptName)

使用例

AdminUtilities.help("sleepDelay")

infoNotice

このスクリプトは、コマンドまたはスクリプトの情報通知用のテキストを設定します。

表 8. infoNotice 引数の説明. メッセージの引数を指定して、このスクリプトを実行します。
引数 説明
message メッセージ・テキストまたはメッセージ ID ("Application is installed" または resourceBundle.getString("WASX7115I") など) を指定します。

構文

AdminUtilities.infoNotice(message)

使用例

AdminUtilities.infoNotice(resourceBundle.getString("WASX7115I"))

save

このスクリプトは、システムに対する構成変更を保存します。

構文

AdminUtilities.save()

使用例

AdminUtilities.save()

setDebugNotices

このスクリプトは、デバッグ通知を有効または無効にします。

表 9. setDebugNotices 引数の説明. デバッグの引数を指定して、このスクリプトを実行します。
引数 説明
debug デバッグ通知を有効にするか無効にするかを指定します。デバッグ通知を有効にする場合は true、無効にする場合は false を指定します。

構文

AdminUtilities.setDebugNotices(debug)

使用例

AdminUtilities.setDebugNotices("true")

setFailOnErrorDefault

このスクリプトは、「エラー時に中止」動作を有効または無効にします。

表 10. setFailOnErrorDefault 引数の説明. エラー時失敗の引数を指定して、このスクリプトを実行します。
引数 説明
failOnError エラー時失敗の動作を有効にするか無効にするかを指定します。エラー時失敗動作を有効にする場合は true、無効にする場合は false を指定します。

構文

AdminUtilities.setFailOnErrorDefault(failOnError)

使用例

AdminUtilities.setFailOnErrorDefault("false")

sleepDelay

このスクリプトでは、2 つの操作の実行時にシステムが完了を待機する秒数を設定します。

表 11. sleepDelay 引数の説明. 遅延秒数の引数を指定して、このスクリプトを実行します。
引数 説明
delaySeconds 完了を待機する秒数を指定します。

構文

AdminUtilities.sleepDelay(delaySeconds)

使用例

AdminUtilities.sleepDelay("10")

warningNotice

このスクリプトは、警告メッセージとして表示するテキストを設定します。

表 12. warningNotice 引数の説明. メッセージの引数を指定して、このスクリプトを実行します。
引数 説明
message 警告通知の翻訳なしのテキストまたはメッセージ ID (resourceBundle.getString("WASX7411W") など) を指定します。

構文

AdminUtilities.warningNotice(message)

使用例

AdminUtilities.warningNotice(resourceBundle.getString("WASX7411W"))

configureAutoSave

このスクリプトは、マスター構成リポジトリーへの構成変更の自動保存を使用可能および使用不可にするものです。

表 13. configureAutoSave 引数の説明. 自動保存の引数を指定して、このスクリプトを実行します。
引数 説明
autosave 構成変更を自動的にマスター構成リポジトリーに保存するかどうかを指定します。 デフォルト値は true です。

構文

AdminUtilities.configureAutoSave(autosave)

使用例

AdminUtilities.configureAutoSave(false)

トピックのタイプを示すアイコン 参照トピック



タイム・スタンプ・アイコン 最終更新: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rxml_7libutility
ファイル名:rxml_7libutility.html