SecureConversation (Deprecated)
Use this topic as a reference for the commands for the SecureConversation group of AdminTask. Use these commands with the administrative scripts to query, update, and remove secure conversation client cache configuration data.
Deprecated feature: The commands in the SecureConversation command group are deprecated in WAS V7.0. Use the commands in the WSSCacheManagement command group to manage WS-Security distributed cache configurations.depfeat
Use the following commands in the SecureConversation group to manage the custom and non-custom secure conversation client cache configurations:
- querySCClientCacheConfiguration
- querySCClientCacheCustomConfiguration
- updateSCClientCacheConfiguration
- updateSCClientCacheCustomConfiguration
- deleteSCClientCacheConfigurationCustomProperties
querySCClientCacheConfiguration command
The querySCClientCacheConfiguration command lists all non-custom client cache configuration data for WS-SecureConversation.
Target object None
Required parameters: None.
Optional parametersNone.
Return value
This command returns a list of all non-custom client cache configuration data.
Batch mode example usage
- Jython...
print AdminTask.querySCClientCacheConfiguration()
Interactive mode example usage
- Jython...
AdminTask.querySCClientCacheConfiguration('-interactive')
querySCClientCacheCustomConfiguration command
The querySCClientCacheCustomConfiguration command lists all custom client cache configuration data for WS-SecureConversation.
Target objectNone.
Required parametersNone.
Optional parametersNone.
Return value
This command returns a list of all custom client cache configuration data.
Batch mode example usage
- Jython...
print AdminTask.querySCClientCacheCustomConfiguration()
Interactive mode example usage
- Jython...
AdminTask.querySCClientCacheCustomConfiguration('-interactive')
updateSCClientCacheConfiguration command
The updateSCClientCacheConfiguration command sets the cache cushion time in minutes and enables or disables distributed cache.
Target objectNone.
Required parametersNone.
Optional parameters
- -distributedCache
- Specifies whether distributed cache is enabled or disabled. If we set the -distributedCache parameter to true when you run the updateSCClientCacheConfiguration command, the system enables distributed cache for the WS-Security runtime. (Boolean, optional)
- -minutesInCacheAfterTimeout
- Amount of time, in minutes, that the token remains in the cache after it expires. The token is renewable for this amount of time. (Integer, optional)
- -renewIntervalBeforeTimeoutMinutes
- Amount of time, in minutes, that a renew request is allowed before the token expires. (Integer, optional)
Return value
This command returns a success or failure message.
Batch mode example usage
- Use Jython string:
AdminTask.updateSCClientCacheConfiguration('-minutesInCacheAfterTimeout 100 -distributedCache true')- Use Jython list:
AdminTask.updateSCClientCacheConfiguration(['-minutesInCacheAfterTimeout', '100', '-distributedCache', 'true'])
Interactive mode example usage
- Jython...
AdminTask.updateSCClientCacheConfiguration('-interactive')
updateSCClientCacheCustomConfiguration command
The updateSCClientCacheCustomConfiguration command updates custom properties for the secure conversation client cache configuration.
Target objectNone.
Required parametersNone.
Optional parameters
- -customProperties
- The custom properties for the secure conversation client cache configuration. (Properties, optional)
Return value
This command returns a success or failure message.
Batch mode example usage
- Use Jython string:
AdminTask.updateSCClientCacheCustomConfiguration('[-customProperties "[ [property2 value2] [property1 value1] ]"]')- Use Jython list:
AdminTask.updateSCClientCacheCustomConfiguration(['-customProperties', '[ [property2 value2] [property1 value1] ]'])
Interactive mode example usage
- Jython...
AdminTask.updateSCClientCacheCustomConfiguration('-interactive')
deleteSCClientCacheConfigurationCustomProperties command
The deleteSCClientCacheConfigurationCustomProperties command removes specific properties from a custom secure conversation client cache configuration.
Target objectNone.
Required parameters
- -propertyNames
- The names of the properties to delete. (String, required).
Optional parametersNone.
Return value
This command returns a success or failure message.
Batch mode example usage
- Use Jython string:
AdminTask.deleteSCClientCacheConfigurationCustomProperties('[-propertyNames [property1,property2]]')- Use Jython list:
AdminTask.deleteSCClientCacheConfigurationCustomProperties(['-propertyNames', '[property1,property2]'])
Interactive mode example usage
- Jython...
AdminTask.deleteSCClientCacheConfigurationCustomProperties('-interactive')
Related tasks
Use AdminTask for scripted administration
Manage WS-Security distributed cache configurations using wsadmin
Set the WS-Security distributed cache
Secure conversation client cache and trust service configuration