实用程序脚本
该脚本库提供多个脚本过程来自动完成应用程序配置。请参阅脚本的用法信息,了解有关设置通知选项、保存配置更改以及显示脚本编制库信息的内容。
每个实用程序脚本过程都位于 app_server_root/scriptLibraries/utilities/V70 目录中。使用下列脚本过程来执行实用程序函数:
convertToList
此脚本会将字符串转换为列表。例如,AdminApp.list() 命令返回应用程序名称的字符串。使用 convertToList 脚本来将输出更改为列表格式,例如 ['DefaultApplication', 'a1', 'a2', 'ivtApp', 'query']。
参数 | 描述 |
---|---|
variable | 指定包含要转换为列表的字符串的变量的名称。 |
语法
AdminUtilities.convertToList(variable)
用法示例
apps=AdminApp.list()
AdminUtilities.convertToList(apps)
debugNotice
此脚本会设置调试通知文本。
参数 | 描述 |
---|---|
message | 为调试通知指定消息文本。 |
语法
AdminUtilities.debugNotice(message)
用法示例
AdminUtilities.debugNotice(“Server is started”)
getExceptionText
此脚本显示特定异常类型、异常值或追溯信息的异常消息。
参数 | 描述 |
---|---|
type | 指定相关异常类型。该异常类型表示异常的类对象。 |
value | 指定相关异常值。该值表示作为异常参数或 raise 语句的第二个参数的实例对象。 |
traceback | 指定相关追溯信息。追溯对象包含特殊属性,其中包括发生错误的行号。请不要将 traceback 指定给处理异常的函数中的局部变量,因为这种指定会创建循环引用。 |
语法
AdminUtilities.getExceptionText(type, value, traceback)
用法示例
AdminUtilities.getExceptionText(“com.ibm.ws.scripting.ScriptingException”
, “com.ibm.ws.scripting.ScriptingException: AdminControl service not available”
, "")
发生故障
此脚本会设置故障消息。
参数 | 描述 |
---|---|
message | 为故障通知指定消息文本。 |
语法
AdminUtilities.fail(message)
用法示例
AdminUtilities.fail(“The script failed”)
fileSearch
此脚本会根据特定路径或目录搜索文件系统。
参数 | 描述 |
---|---|
path | 指定要用于搜索特定文件的文件路径。 |
directory | 指定要用于搜索特定文件的目录。 |
语法
AdminUtilities.fileSearch(path, directory)
用法示例
![[Windows]](../images/windows.gif)
Paths = []
Directory = java.io.File(“c:\\WebSphere\\AppServer\\scriptLibraries”)
AdminUtilities.fileSearch(directory, paths)
![[Linux]](../images/linux.gif)
![[AIX]](../images/aixlogo.gif)
![[HP-UX]](../images/hpux.gif)
![[Solaris]](../images/solaris.gif)
![[IBM i]](../images/iseries.gif)
![[z/OS]](../images/ngzos.gif)
Paths = []
Directory = java.io.File(“//WebSphere//AppServer//scriptLibraries”)
AdminUtilities.fileSearch(directory, paths)
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 脚本库的帮助信息,其中包括一般库信息、脚本名称和脚本描述。
参数 | 描述 |
---|---|
scriptName | (可选)指定相关 AdminUtilities 脚本的名称。 |
语法
AdminUtilities.help(scriptName)
用法示例
AdminUtilities.help(“sleepDelay”)
infoNotice
此脚本为命令或脚本的信息通知设置文本。
参数 | 描述 |
---|---|
message | 指定消息文本或消息标识,例如“Application is installed”或 resourceBundle.getString(“WASX7115I”)。 |
语法
AdminUtilities.infoNotice(message)
用法示例
AdminUtilities.infoNotice(resourceBundle.getString(“WASX7115I”))
保存
此脚本会将配置更改保存至系统。
语法
AdminUtilities.save()
用法示例
AdminUtilities.save()
setDebugNotices
此脚本会启用和禁用调试通知。
参数 | 描述 |
---|---|
debug | 指定是启用还是禁用调试通知。指定 true 以启用调试通知,或指定 false 以禁用调试通知。 |
语法
AdminUtilities.setDebugNotices(debug)
用法示例
AdminUtilities.setDebugNotices(“true”)
setFailOnErrorDefault
此脚本会启用或禁用“出错中止”行为。
参数 | 描述 |
---|---|
failOnError | 指定是启用还是禁用“出错中止”行为。指定 true 以启用“出错中止”行为,或指定 false 以禁用该行为。 |
语法
AdminUtilities.setFailOnErrorDefault(failOnError)
用法示例
AdminUtilities.setFailOnErrorDefault(“false”)
sleepDelay
此脚本设置在两个操作期间系统等待完成的秒数。
参数 | 描述 |
---|---|
delaySeconds | 指定等待完成的秒数。 |
语法
AdminUtilities.sleepDelay(delaySeconds)
用法示例
AdminUtilities.sleepDelay(“10”)
warningNotice
此脚本将文本设置为以警告消息的形式显示。
参数 | 描述 |
---|---|
message | 指定警告通知的未转换文本或消息标识(例如 resourceBundle.getString("WASX7411W"))。 |
语法
AdminUtilities.warningNotice(message)
用法示例
AdminUtilities.warningNotice(resourceBundle.getString(“WASX7411W”))
configureAutoSave
此脚本会启用和禁用自动将配置更改保存到主配置库的功能。
参数 | 描述 |
---|---|
autosave | 指定是否要自动将配置更改保存到主配置库。缺省值为 True。 |
语法
AdminUtilities.configureAutoSave(autosave)
用法示例
AdminUtilities.configureAutoSave(false)