SecureConversation command group for the AdminTask object (deprecated)

Use this topic as a reference for the commands for the SecureConversation group of the AdminTask object. Use these commands with your administrative scripts to query, update, and remove secure conversation client cache configuration data.

Deprecated feature: The commands in the SecureConversation command group are deprecated. Use the commands in the WSSCacheManagement command group to manage WS-Security distributed cache configurations.
Use the following commands in the SecureConversation group to manage your custom and non-custom secure conversation client cache configurations:

querySCClientCacheConfiguration command

The querySCClientCacheConfiguration command lists all non-custom client cache configuration data for WS-SecureConversation.

Target object

None

Required parameters

None.

Optional parameters

None.

Return value

This command returns a list of all non-custom client cache configuration data.

Batch mode example usage

  • Using Jython: 
    print AdminTask.querySCClientCacheConfiguration()

Interactive mode example usage

  • Using Jython:
    AdminTask.querySCClientCacheConfiguration('-interactive')

querySCClientCacheCustomConfiguration command

The querySCClientCacheCustomConfiguration command lists all custom client cache configuration data for WS-SecureConversation.

Target object

None.

Required parameters

None.

Optional parameters

None.

Return value

This command returns a list of all custom client cache configuration data.

Batch mode example usage

  • Using Jython: 
    print AdminTask.querySCClientCacheCustomConfiguration()

Interactive mode example usage

  • Using Jython:
    AdminTask.querySCClientCacheCustomConfiguration('-interactive')

updateSCClientCacheConfiguration command

The updateSCClientCacheConfiguration command sets the cache cushion time in minutes and enables or disables distributed cache.

Target object

None.

Required parameters

None.

Optional parameters

-distributedCache
Specifies whether distributed cache is enabled or disabled. If you 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
Specifies the 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
Specifies the 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

  • Using Jython string: 
    AdminTask.updateSCClientCacheConfiguration('-minutesInCacheAfterTimeout 100 -distributedCache
 true')
  • Using Jython list: 
    AdminTask.updateSCClientCacheConfiguration(['-minutesInCacheAfterTimeout', '100', '-distributedCache', 
'true'])

Interactive mode example usage

  • Using Jython:
    AdminTask.updateSCClientCacheConfiguration('-interactive')

updateSCClientCacheCustomConfiguration command

The updateSCClientCacheCustomConfiguration command updates custom properties for the secure conversation client cache configuration.

Target object

None.

Required parameters

None.

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

  • Using Jython string: 
    AdminTask.updateSCClientCacheCustomConfiguration('[-customProperties "[ [property2 value2] 
[property1 value1] ]"]')
  • Using Jython list: 
    AdminTask.updateSCClientCacheCustomConfiguration(['-customProperties', '[ [property2 value2] 
[property1 value1] ]'])

Interactive mode example usage

  • Using Jython:
    AdminTask.updateSCClientCacheCustomConfiguration('-interactive')

deleteSCClientCacheConfigurationCustomProperties command

The deleteSCClientCacheConfigurationCustomProperties command removes specific properties from a custom secure conversation client cache configuration.

Target object

None.

Required parameters

-propertyNames
The names of the properties to delete. (String, required).

Optional parameters

None.

Return value

This command returns a success or failure message.

Batch mode example usage

  • Using Jython string:
    AdminTask.deleteSCClientCacheConfigurationCustomProperties('[-propertyNames [property1,property2]]')
  • Using Jython list:
    AdminTask.deleteSCClientCacheConfigurationCustomProperties(['-propertyNames', '[property1,property2]'])

Interactive mode example usage

  • Using Jython:
    AdminTask.deleteSCClientCacheConfigurationCustomProperties('-interactive')