AdminTask オブジェクトの WSSCacheManagement コマンド・グループ
このトピックは、AdminTask オブジェクトの WSSCacheManagement グループのコマンド・リファレンスとして使用します。 これらのコマンドを管理スクリプトで使用して、分散キャッシュ構成データを照会、更新、および除去します。
deleteWSSDistributedCacheConfigCustomProperties コマンド
deleteWSSDistributedCacheConfigCustomProperties コマンドは、WS-Security 分散キャッシュ・カスタム・プロパティーを除去します。
ターゲット・オブジェクト
なし必須パラメーター
- -propertyNames
- 分散キャッシュ構成から削除するカスタム・プロパティーの名前を指定します。 (String[])
オプション・パラメーター
なし。戻り値
このコマンドは、コマンドの成功または失敗を示すメッセージを戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.deleteWSSDistributedCacheConfigCustomProperties('[-propertyNames [prop1,prop2,prop3]]')
- Jython リストを使用:
AdminTask.deleteWSSDistributedCacheConfigCustomProperties([',-'propertyNames', '[prop1,prop2,prop3]'])
対話モードの使用例
- Jython の使用:
AdminTask.deleteWSSDistributedCacheConfigCustomProperties('-interactive')
queryWSSDistributedCacheConfig コマンド
queryWSSDistributedCacheConfig コマンドは、WS-Security 分散キャッシュ構成の非カスタム・プロパティーをリストします。
ターゲット・オブジェクト
なし。必須パラメーター
なし。オプション・パラメーター
なし。戻り値
プロパティー | 説明 |
---|---|
tokenRecovery | トークン・リカバリーを有効にするのか無効にするのかを指定します。tokenRecovery プロパティーを true に設定した場合、Datasource プロパティーで、分散キャッシュに割り当てられる共有データ・ソースを指定します。 |
distributedCache | 分散キャッシングを使用可能または使用不可のどちらにするかを指定します。 |
Datasource | トークン・リカバリーが有効な場合、分散キャッシュに割り当てられる共有データ・ソースの名前を指定します。 |
renewIntervalBeforeTimeoutMinutes | クライアントがトークンの更新を試みるまで待つ期間を分単位で指定します。 |
synchronousClusterUpdate | クラスター・メンバーに対して分散キャッシュの同期更新を実行するかどうかを指定します。デフォルトでは、同期クラスター更新は有効になっています。 |
minutesInCacheAfterTimeout | トークンがタイムアウトになった後で、トークンがキャッシュ内に残留する時間を指定します。 |
バッチ・モードの使用例
- Jython を使用:
print AdminTask.queryWSSDistributedCacheConfig()
対話モードの使用例
- Jython の使用:
AdminTask.queryWSSDistributedCacheConfig('-interactive')
queryWSSDistributedCacheCustomConfig コマンド
queryWSSDistributedCacheCustomConfig コマンドは、WS-Security 分散キャッシュ構成のカスタム・プロパティーをリストします。
ターゲット・オブジェクト
なし。必須パラメーター
なし。オプション・パラメーター
なし。戻り値
このコマンドは、各カスタム・プロパティーに対応する名前と値の組を含むプロパティー・オブジェクトを戻します。
バッチ・モードの使用例
- Jython を使用:
AdminTask.queryWSSDistributedCacheCustomConfig()
対話モードの使用例
- Jython の使用:
AdminTask.queryWSSDistributedCacheCustomConfig('-interactive')
updateWSSDistributedCacheConfig コマンド
updateWSSDistributedCacheConfig コマンドは、WS-Security 分散キャッシュ構成の非カスタム・プロパティーを更新します。
ターゲット・オブジェクト
なし。必須パラメーター
なし。オプション・パラメーター
- -renewIntervalBeforeTimeoutMinutes
- トークンの有効期限が切れるまでの間で、更新要求を許可する時間 (分単位) を指定します。 (整数)
- -minutesInCacheAfterTimeout
- キャッシュの有効期限が切れて以降、トークンがキャッシュ内に残留する時間 (分単位) を指定します。 この時間内であれば、トークンを更新可能です。 (整数)
- -distributedCache
- 配布されるキャッシュを使用可能または使用不可に指定します。 (ブール値)
- -synchronousClusterUpdate
- システムがクラスター・メンバー上の分散キャッシュの同期更新を行うかどうかを指定します。 デフォルトでは、同期クラスター更新は有効になっています。同期クラスター更新を無効にする場合は false を指定します。(ブール値)
- -tokenRecovery
- トークン・リカバリーを有効にするのか無効にするのかを指定します。tokenRecovery プロパティーを true に設定する場合には、-Datasource パラメーターを使用して、分散キャッシュに割り当てる共有データ・ソースを指定してください。(ブール値)
- -Datasource
- トークン・リカバリーが有効な場合、分散キャッシュに割り当てられる共有データ・ソースの名前を指定します。 (ストリング)
戻り値
このコマンドは、成功または失敗メッセージを戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.updateWSSDistributedCacheConfig('[-customProperties "[ [property2 value2] [property1 value1] ]"]')
- Jython リストを使用:
AdminTask.updateWSSDistributedCacheConfig(['-customProperties', '[ [property2 value2] [property1 value1] ]'])
対話モードの使用例
- Jython の使用:
AdminTask.updateWSSDistributedCacheConfig('-interactive')
updateWSSDistributedCacheCustomConfig コマンド
updateWSSDistributedCacheCustomConfig コマンドは、WS-Security 分散キャッシュ構成のカスタム・プロパティーを更新します。
ターゲット・オブジェクト
なし。必須パラメーター
- -customProperties
- WS-Security 分散キャッシュ構成で追加または更新する各カスタム・プロパティーの名前と値を指定します。 (java.util.Properties)
オプション・パラメーター
なし。戻り値
このコマンドは、成功または失敗メッセージを戻します。
バッチ・モードの使用例
- Jython ストリングを使用:
AdminTask.updateWSSDistributedCacheCustomConfig('[-customProperties [[property1 value1][property2 value2]]]')
- Jython リストを使用:
AdminTask.updateWSSDistributedCacheCustomConfig(['-customProperties', '[[property1 value1][property2 value2]]'])
対話モードの使用例
- Jython の使用:
AdminTask.updateWSSDistributedCacheCustomConfig('-interactive')