AdminTask 对象的 STSManagement 命令组
要通过 wsadmin 工具配置安全性,可以使用 Jython 或 Jacl 脚本语言来实现。STSManagement 组中的命令和参数可用于管理和查询信任服务令牌提供程序配置和端点配置。
STSManagement 命令组包含一些命令,它们允许您配置现有令牌提供程序、为端点分配令牌提供程序以及修改常规信任服务配置数据。此命令组中用于执行配置更改的命令要求您执行保存命令以落实更改。如果执行命令时发生了异常,那么不会进行任何配置更改。
- createSTSTokenTypeConfiguration
- deleteSTSTokenTypeConfigurationCustomProperties
- listSTSConfiguredTokenTypes
- querySTSDefaultTokenType
- querySTSTokenTypeConfigurationDefaultProperties
- querySTSTokenTypeConfigurationCustomProperties
- setSTSDefaultTokenType
- updateSTSTokenTypeConfiguration
- removeSTSTokenTypeConfiguration
createSTSTokenTypeConfiguration
createSTSTokenTypeConfiguration 命令用于创建令牌提供程序配置。
目标对象
指定 LocalName 对象,它用作各种配置的标识。LocalName 对象的值必须唯一。
必需参数
- -URI
- 令牌提供程序的 URI。此值必须在所有配置标记类型 URI 中都是唯一的。(字符串,必需)
- -HandlerFactory
- 提供 org.eclipse.higgins.sts.IObjectFactory 接口的实现的标准类名。(字符串,必需)
可选参数
- -lifetimeMinutes
- 指定要为已发出的令牌提供程序分配的最长生存期。缺省值是 120 分钟。(整数,可选)
- -distributedCache
- 指定是启用还是禁用分布式高速缓存。指定 true 以启用分布式高速缓存功能。缺省值为 false。如果指定此选项,那么安全上下文令牌提供程序会生成警告并修改 WS-Security 分布式高速缓存配置。对于定制令牌,请不要为此参数指定值。(布尔值,可选)
- -tokenCacheFactory
- 指定令牌提供程序的标准类名。安全对话令牌处理程序类不能识别此参数。(字符串,可选)。
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.createSTSTokenTypeConfiguration('myTokenType', '[-HandlerFactory test.ibm.samples.myTokenType -URI http://ibm.com/tokens/schema/myTokenType]')
- 使用 Jython 列表:
AdminTask.createSTSTokenTypeConfiguration('myTokenType', ['-HandlerFactory', 'test.ibm.samples.myTokenType', '-URI', 'http://ibm.com/tokens/schema/myTokenType'])
交互方式示例用法
- 使用 Jython:
AdminTask.createSTSTokenTypeConfiguration('-interactive')
deleteSTSTokenTypeConfigurationCustomProperties
deleteSTSTokenTypeConfigurationCustomProperties 命令用来从令牌提供程序配置中除去定制属性。
目标对象
指定相关令牌提供程序的 LocalName 对象。
必需参数
None
可选参数
- -propertyNames
- 指定要从配置中删除的定制属性的名称。如果配置中不存在指定的任何属性,那么您将接收到错误消息。(String[],可选)
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('myTokenType', '[-propertyNames com.ibm.ws.security.webChallengeIfCustomSubjectNotFound com.ibm.ws.security.defaultLoginConfig]')
- 使用 Jython 列表:
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('myTokenType', ['-propertyNames', 'com.ibm.ws.security.webChallengeIfCustomSubjectNotFound com.ibm.ws.security.defaultLoginConfig'])
交互方式示例用法
- 使用 Jython:
AdminTask.deleteSTSTokenTypeConfigurationCustomProperties('-interactive')
listSTSConfiguredTokenTypes
listSTSConfiguredTokenTypes 命令用来列出已配置的所有令牌提供程序的局部名。
目标对象
None
必需参数
None
可选参数
None
返回值
此命令将返回已配置的所有令牌提供程序的局部名。
批处理方式示例用法
- 使用 Jython:
AdminTask.listSTSConfiguredTokenTypes()
交互方式示例用法
- 使用 Jython:
AdminTasklistSTSConfiguredTokenTypes('-interactive')
querySTSDefaultTokenType
querySTSDefaultTokenType 命令用来确定缺省令牌提供程序的局部名。
目标对象
None
必需参数
None
可选参数
None
返回值
此命令将返回缺省令牌提供程序的局部名。
批处理方式示例用法
- 使用 Jython:
AdminTask.querySTSDefaultTokenType()
交互方式示例用法
- 使用 Jython:
AdminTask.querySTSDefaultTokenType('-interactive')
querySTSTokenTypeConfigurationDefaultProperties
querySTSTokenTypeConfigurationDefaultProperties 命令用来查询令牌提供程序的非定制属性的信任服务。
目标对象
指定要查询的令牌提供程序的 LocalName 对象。
必需参数
None
可选参数
None
返回值
此命令将返回 java.util.Properties 实例,此实例中包含非定制属性的值。非定制属性包括 URI、HandlerFactory、lifetimeMinutes、distributedCache、postdatable、renewableAfterExpiration 和 renewalWindowMinutes。
批处理方式示例用法
- 使用 Jython:
AdminTask.querySTSTokenTypeConfigurationDefaultProperties('TokenType2')
交互方式示例用法
- 使用 Jython:
AdminTask.querySTSTokenTypeConfigurationDefaultProperties('-interactive')
querySTSTokenTypeConfigurationCustomProperties
querySTSTokenTypeConfigurationCustomProperties 命令用来查询信任服务。
目标对象
指定相关令牌提供程序的 LocalName 对象。
必需参数
None
可选参数
None
返回值
此命令将返回 java.util.Properties 实例,此实例中包含定制属性的值。
批处理方式示例用法
- 使用 Jython:
AdminTask.querySTSTokenTypeConfigurationCustomProperties('TokenType2')
交互方式示例用法
- 使用 Jython:
AdminTask.querySTSTokenTypeConfigurationCustomProperties('-interactive')
setSTSDefaultTokenType
setSTSDefaultTokenType 命令用来设置信任服务的缺省令牌提供程序。
目标对象
将令牌提供程序的 LocalName 对象指定为缺省值。
必需参数
None
可选参数
None
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython:
AdminTask.setSTSDefaultTokenType('TokenType2')
交互方式示例用法
- 使用 Jython:
AdminTask.setSTSDefaultTokenType('-interactive')
updateSTSTokenTypeConfiguration
updateSTSTokenTypeConfiguration 命令用来更新令牌提供程序的配置数据。所有参数都是可选参数。如果此属性已存在,那么在配置中已更新所指定的参数。如果此属性不存在,那么已将它添加至配置。要除去定制属性,请使用 deleteSTSTokenTypeConfigurationCustomProperties 命令。
目标对象
指定相关令牌提供程序的 LocalName 对象。
必需参数
None
可选参数
- -URI
- 令牌提供程序的 URI。此值必须在所有配置标记类型 URI 中都是唯一的。(字符串,可选)
- -HandlerFactory
- 提供 org.eclipse.higgins.sts.utilities.IObjectFactory 接口的实现的标准类名。(字符串,可选)
- -lifetimeMinutes
- 要为已发出的令牌提供程序指定的最长生存期。缺省值是 120 分钟。(整数,可选)
- -distributedCache
- 指定是启用还是禁用分布式高速缓存。指定 true 以启用分布式高速缓存功能。缺省值为 false。如果指定此选项,那么安全上下文令牌提供程序会生成警告并修改 WS-Security 分布式高速缓存配置。对于定制令牌,请不要为此参数指定值。(布尔值,可选)
- -postdatable
- 将此参数的值设置为 true 以允许此令牌提供程序的令牌从将来某个时间开始变得有效。缺省值为 false。(布尔值,可选)
- -renewableAfterExpiration
- 将此参数的值设置为 true 以允许此令牌提供程序的令牌在到期之后可更新。缺省值为 false。(布尔值,可选)
- -renewableWindowMinutes
- 提供在令牌到期之后多少分钟就可以开始更新此令牌提供程序的令牌。如果在到期之后已经超过了此指定时间,那么将不再能够更新此令牌。缺省值是 120 分钟。(整数,可选)
- -tokenCacheFactory
- 指定令牌提供程序的标准类名。安全对话令牌处理程序类不能识别此参数。(字符串,可选)。
- -customProperties
- 提供任何附加定制属性。(java.util.Properties,可选)。
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.updateSTSTokenTypeConfiguration('myTokenType', '[-lifetimeMinutes 100 -renewableAfterExpiration false -distributedCache true]')
- 使用 Jython 列表:
AdminTask.updateSTSTokenTypeConfiguration('myTokenType', ['-lifetimeMinutes', '100', ' -renewableAfterExpiration', 'false', '-distributedCache', 'true'])
交互方式示例用法
- 使用 Jython:
AdminTask.updateSTSTokenTypeConfiguration('-interactive')
removeSTSTokenTypeConfiguration
removeSTSTokenTypeConfiguration 命令除去令牌提供程序配置。
目标对象
指定相关令牌提供程序的 LocalName 对象。
必需参数
None
可选参数
None
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython:
AdminTask.removeSTSTokenTypeConfiguration('myTokenType')
交互方式示例用法
- 使用 Jython:
AdminTask.removeSTSTokenTypeConfiguration ('-interactive')
assignSTSEndpointTokenType
assignSTSEndpointTokenType 命令用来在访问特定端点时提供令牌提供程序。
目标对象
指定端点的 endpointURI 对象以指定给定的令牌提供程序。如果指定的端点已经指定了令牌提供程序,那么您将接收到错误消息。
必需参数
None
可选参数
- -LocalName
- 指定要对指定端点分配的令牌提供程序的局部名。如果令牌提供程序配置不存在,那么您将接收到错误消息。如果未指定此参数,那么将使用缺省令牌提供程序。(字符串,可选)
- -issuer
- 指定发布者的 URI,该发布者指定了要发布的令牌提供程序。此值可以为 null。(字符串,可选)
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.assignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', '[-LocalName tokenType1]')
- 使用 Jython 列表:
AdminTask.assignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType1'])
交互方式示例用法
- 使用 Jython:
AdminTask.assignSTSEndpointTokenType ('-interactive')
listSTSAssignedEndpoints
listSTSAssignedEndpoints 命令用来列出所分配端点的 URI。
目标对象
None
必需参数
None
可选参数
None
返回值
此命令将返回已指定的所有端点的 URI。
批处理方式示例用法
- 使用 Jython:
AdminTask.listSTSAssignedEndpoints()
交互方式示例用法
- 使用 Jython:
AdminTask.listSTSAssignedEndpoints ('-interactive')
listSTSEndpointTokenTypes
listSTSEndpointTokenTypes 命令用来查询为特定端点分配的令牌提供程序的信任服务。
目标对象
指定要查询的端点的 endpointURI 对象。如果指定的端点尚未指定令牌提供程序,那么将产生异常。
必需参数
None
可选参数
None
返回值
此命令将返回对指定端点分配的令牌提供程序的局部名。
批处理方式示例用法
- 使用 Jython:
AdminTask.listSTSEndpointTokenTypes()
交互方式示例用法
- 使用 Jython:
AdminTask.listSTSEndpointTokenTypes ('-interactive')
unassignSTSEndpointTokenType
unassignSTSEndpointTokenType 命令用来从端点的令牌提供程序中对此端点进行取消分配。
目标对象
指定要从给定的令牌提供程序中取消指定的端点的 endpointURI 对象。如果指定的端点尚未指定令牌提供程序,那么将产生异常。
必需参数
- -LocalName
- 指定要从指定端点中取消指定的令牌提供程序配置的局部名。(字符串,必需)
可选参数
- -issuer
- 指定要取消分配的令牌提供程序中的发布者的 URI。(字符串,可选)
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.unassignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/','[-LocalName tokenType2]')
- 使用 Jython 列表:
AdminTask.unassignSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType2'])
交互方式示例用法
- 使用 Jython:
AdminTask.unassignSTSEndpointTokenType ('-interactive')
updateSTSEndpointTokenType
updateSTSEndpointTokenType 命令用来对指定的端点分配另一个令牌提供程序。
目标对象
指定要更新的端点的 endpointURI 对象。如果指定的端点尚未指定令牌提供程序,那么将产生异常。
必需参数
- -LocalName
- 指定要对指定端点分配的令牌提供程序的局部名。如果令牌提供程序配置不存在,那么您将接收到错误消息。如果未指定此参数,那么将使用缺省令牌提供程序。(字符串,可选)
可选参数
None
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.updateSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', '[-LocalName tokenType2]')
- 使用 Jython 列表:
AdminTask.updateSTSEndpointTokenType('www.ibm.tokenservice/Ecommerce/', ['-LocalName', 'tokenType2'])
交互方式示例用法
- 使用 Jython:
AdminTask.updateSTSEndpointTokenType('-interactive')
addSTSProperty
addSTSProperty 命令为信任服务添加新属性。
目标对象
为新属性指定唯一名称(字符串,必需)。
必需参数
- -propertyValue
- 指定要添加的属性的值。(字符串,必需)
可选参数
None
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.addSTSProperty('pluginSCTVersion', '[-propertyValue 2.0]')
- 使用 Jython 列表:
AdminTask.addSTSProperty('pluginSCTVersion', ['-propertyValue', '2.0'])
交互方式示例用法
- 使用 Jython:
AdminTask.addSTSProperty('-interactive')
deleteSTSProperty
deleteSTSProperty 命令删除信任服务的现有属性。
目标对象
指定要删除的属性的名称。
必需参数
None
可选参数
None
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython:
AdminTask.deleteSTSProperty('pluginSCTVersion')
交互方式示例用法
- 使用 Jython:
AdminTask.deleteSTSProperty('-interactive')
editSTSProperty
editSTSProperty 命令修改信任服务的现有属性。
目标对象
指定要编辑的属性的名称。(字符串,必需)
必需参数
- -propertyValue
- 指定相关属性的新值。(字符串,必需)
可选参数
None
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython 字符串:
AdminTask.editSTSProperty('pluginSCTVersion', '[-propertyValue 2.1]')
- 使用 Jython 列表:
AdminTask.editSTSProperty('pluginSCTVersion', ['-propertyValue', '2.1'])
交互方式示例用法
- 使用 Jython:
AdminTask.editSTSProperty('-interactive')
listSTSProperties
listSTSProperties 命令列出信任服务的所有现有属性及其相应的值。
目标对象
None
必需参数
None
可选参数
None
返回值
此命令将返回 java.util.Properties 实例,此实例中包含属性的名称和值。
批处理方式示例用法
- 使用 Jython:
AdminTask.listSTSProperties()
交互方式示例用法
- 使用 Jython:
AdminTask.listSTSProperties('-interactive')
refreshSTS
refreshSTS 命令刷新信任服务配置更改,但不重新启动应用程序服务器。
目标对象
None
必需参数
None
可选参数
None
返回值
此命令将返回成功或失败消息。
批处理方式示例用法
- 使用 Jython:
AdminTask.refreshSTS()