AdminTask オブジェクトの STSManagement コマンド・グループ

Jython または Jacl スクリプト言語を使用すると、wsadmin ツールでセキュリティーを構成することができます。STSManagement グループのコマンドおよびパラメーターは、トラスト・サービス・トークン・プロバイダー構成およびエンドポイント構成の管理と照会に使用できます。

STSManagement コマンド・グループに含まれるコマンドを使用すると、既存のトークン・プロバイダーの構成、トークン・プロバイダーのエンドポイントへの割り当て、および汎用トラスト・サービス構成データの変更が可能です。 このグループのコマンドで実行した構成変更をコミットするには、save コマンドを実行する必要があります。 コマンド実行時に例外が作成される場合、構成変更は行われません。

以下のコマンドを使用して、エンドポイント構成の割り当て、割り当て解除、および照会を行います。
以下のコマンドを使用して、トラスト・サービスのプロパティーの追加、編集、削除、およびリストを行います。
次のコマンドを使用すると、トラスト・サービスは、アプリケーション・サーバーを再始動せずに、変更された構成を再ロードします。

createSTSTokenTypeConfiguration

createSTSTokenTypeConfiguration コマンドは、トークン・プロバイダー構成の作成に使用します。

ターゲット・オブジェクト

さまざまな構成の ID として使用される 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 オブジェクトを指定します。

必須パラメーター

なし

オプション・パラメーター

-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 コマンドは、すべての構成済みトークン・プロバイダーのローカル名をリストするために使用します。

ターゲット・オブジェクト

なし

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、すべての構成済みトークン・プロバイダーのローカル名を戻します。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.listSTSConfiguredTokenTypes()

対話モードの使用例

  • Jython を使用:
    AdminTasklistSTSConfiguredTokenTypes('-interactive')

querySTSDefaultTokenType

querySTSDefaultTokenType コマンドは、デフォルト・トークン・プロバイダーのローカル名を判別するために使用します。

ターゲット・オブジェクト

なし

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、デフォルト・トークン・プロバイダーのローカル名を戻します。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.querySTSDefaultTokenType()

対話モードの使用例

  • Jython を使用:
    AdminTask.querySTSDefaultTokenType('-interactive')

querySTSTokenTypeConfigurationDefaultProperties

querySTSTokenTypeConfigurationDefaultProperties コマンドは、トークン・プロバイダーの非カスタム・プロパティーのトラスト・サービスを照会するために使用します。

ターゲット・オブジェクト

照会するトークン・プロバイダーの LocalName オブジェクトを指定します。

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、非カスタム・プロパティーの値を含む java.util.Properties インスタンスを戻します。 非カスタム・プロパティーには URI、HandlerFactory、lifetimeMinutes、distributedCache、postdatable、renewableAfterExpiration、および renewalWindowMinutes などがあります。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.querySTSTokenTypeConfigurationDefaultProperties('TokenType2')

対話モードの使用例

  • Jython を使用:
    AdminTask.querySTSTokenTypeConfigurationDefaultProperties('-interactive')

querySTSTokenTypeConfigurationCustomProperties

querySTSTokenTypeConfigurationCustomProperties は、トラスト・サービスの照会に使用するコマンドです。

ターゲット・オブジェクト

対象のトークン・プロバイダーの LocalName オブジェクトを指定します。

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、カスタム・プロパティーの値を含む java.util.Properties インスタンスを戻します。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.querySTSTokenTypeConfigurationCustomProperties('TokenType2')

対話モードの使用例

  • Jython を使用:
    AdminTask.querySTSTokenTypeConfigurationCustomProperties('-interactive')

setSTSDefaultTokenType

setSTSDefaultTokenType コマンドは、トラスト・サービスのデフォルト・トークン・プロバイダーを設定するために使用します。

ターゲット・オブジェクト

トークン・プロバイダーの LocalName オブジェクトをデフォルトで指定します。

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、成功または失敗メッセージを戻します。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.setSTSDefaultTokenType('TokenType2')

対話モードの使用例

  • Jython を使用:
    AdminTask.setSTSDefaultTokenType('-interactive')

updateSTSTokenTypeConfiguration

updateSTSTokenTypeConfiguration コマンドは、トークン・プロバイダーの構成データを更新するために使用します。 すべてのパラメーターはオプションです。 プロパティーが既存の場合、指定したパラメーターは構成内で更新されます。 このプロパティーは、既存でない場合は、構成に追加されます。 カスタム・プロパティーを除去するには、deleteSTSTokenTypeConfigurationCustomProperties コマンドを使用してください。

ターゲット・オブジェクト

対象のトークン・プロバイダーの LocalName オブジェクトを指定します。

必須パラメーター

なし

オプション・パラメーター

-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 オブジェクトを指定します。

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、成功または失敗メッセージを戻します。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.removeSTSTokenTypeConfiguration('myTokenType') 

対話モードの使用例

  • Jython を使用:
    AdminTask.removeSTSTokenTypeConfiguration ('-interactive')

assignSTSEndpointTokenType

assignSTSEndpointTokenType コマンドは、特定のエンドポイントがアクセスを受けたときにトークン・プロバイダーを割り当てるために使用します。

ターゲット・オブジェクト

所定のトークン・プロバイダーを割り当てるエンドポイントの endpointURI オブジェクトを指定します。 指定したエンドポイントに既にトークン・プロバイダーが割り当てられている場合は、エラー・メッセージが表示されます。

必須パラメーター

なし

オプション・パラメーター

-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 をリストするために使用します。

ターゲット・オブジェクト

なし

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、割り当てられたすべてのエンドポイントの URI を戻します。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.listSTSAssignedEndpoints()

対話モードの使用例

  • Jython を使用:
    AdminTask.listSTSAssignedEndpoints ('-interactive')

listSTSEndpointTokenTypes

listSTSEndpointTokenTypes コマンドは、特定のエンドポイントに割り当てられたトークン・プロバイダーのトラスト・サービスを照会するために使用します。

ターゲット・オブジェクト

照会するエンドポイントの endpointURI オブジェクトを指定します。 指定したエンドポイントにトークン・プロバイダーが割り当てられていない場合は、例外が発生します。

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、指定したエンドポイントに割り当てられるトークン・プロバイダーのローカル名を戻します。

バッチ・モードの使用例

  • 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
指定したエンドポイントに割り当てるトークン・プロバイダーのローカル名を指定します。 トークン・プロバイダー構成が存在しない場合は、エラー・メッセージが表示されます。 このパラメーターを指定しない場合、デフォルトのトークン・プロバイダーが使用されます。 (ストリング、オプション)

オプション・パラメーター

なし

戻り値

このコマンドは、成功または失敗メッセージを戻します。

バッチ・モードの使用例

  • 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
追加するプロパティーの値を指定します。 (ストリング、必須)

オプション・パラメーター

なし

戻り値

このコマンドは、成功または失敗メッセージを戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.addSTSProperty('pluginSCTVersion', '[-propertyValue 2.0]')
  • Jython リストを使用:
    AdminTask.addSTSProperty('pluginSCTVersion', ['-propertyValue', '2.0'])

対話モードの使用例

  • Jython を使用:
    AdminTask.addSTSProperty('-interactive')

deleteSTSProperty

deleteSTSProperty コマンドは、トラスト・サービスから既存プロパティーを削除します。

ターゲット・オブジェクト

削除するプロパティーの名前を指定します。

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、成功または失敗メッセージを戻します。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.deleteSTSProperty('pluginSCTVersion')

対話モードの使用例

  • Jython を使用:
    AdminTask.deleteSTSProperty('-interactive')

editSTSProperty

editSTSProperty コマンドは、トラスト・サービスの既存プロパティーを変更します。

ターゲット・オブジェクト

編集するプロパティーの名前を指定します。 (ストリング、必須)

必須パラメーター

-propertyValue
対象のプロパティーに新規の値を指定します。 (ストリング、必須)

オプション・パラメーター

なし

戻り値

このコマンドは、成功または失敗メッセージを戻します。

バッチ・モードの使用例

  • Jython ストリングを使用:
    AdminTask.editSTSProperty('pluginSCTVersion', '[-propertyValue 2.1]')
  • Jython リストを使用:
    AdminTask.editSTSProperty('pluginSCTVersion', ['-propertyValue', '2.1'])

対話モードの使用例

  • Jython を使用:
    AdminTask.editSTSProperty('-interactive')

listSTSProperties

listSTSProperties コマンドは、トラスト・サービスのすべての既存プロパティーと、各プロパティーに対応する値をリストします。

ターゲット・オブジェクト

なし

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、プロパティーの名前と値を含む java.util.Properties インスタンスを戻します。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.listSTSProperties()

対話モードの使用例

  • Jython を使用:
    AdminTask.listSTSProperties('-interactive')

refreshSTS

refreshSTS コマンドは、アプリケーション・サーバーを再始動せずにトラスト・サービスの構成変更をリフレッシュします。

ターゲット・オブジェクト

なし

必須パラメーター

なし

オプション・パラメーター

なし

戻り値

このコマンドは、成功または失敗メッセージを戻します。

バッチ・モードの使用例

  • Jython を使用:
    AdminTask.refreshSTS()

トピックのタイプを示すアイコン 参照トピック



タイム・スタンプ・アイコン 最終更新: last_date
http://www14.software.ibm.com/webapp/wsbroker/redirect?version=cord&product=was-nd-mp&topic=rxml_wsfpstsmanage
ファイル名:rxml_wsfpstsmanage.html