CLI アフィリエイト オブジェクト メソッド
ここでは、Perl CLI アフィリエイト オブジェクト メソッドについて説明します。
casso1283
ここでは、Perl CLI アフィリエイト オブジェクト メソッドについて説明します。
AddAttribute メソッド - 新しいアフィリエイト属性を追加
AddAttribute メソッドは、アフィリエイト オブジェクトに新しいアフィリエイト属性を追加します。
構文
AddAttribute メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->AddAttribute(attrType, value)
[Parameters]
AddAttribute メソッドは、以下のパラメータを受け入れます。
- attrType(int)以下のいずれかのアフィリエイト属性タイプを指定します。
- AFFILIATE_HTTP_HEADER_VARIABLE(値=1)。アフィリエイト属性は HTTP ヘッダ変数として利用可能になります。
- AFFILIATE_HTTP_COOKIE_VARIABLE(値=2)。アフィリエイト属性は HTTP Cookie 変数として利用可能になります。
- value(int)アフィリエイト属性の値を指定します。この値指定は、[SiteMinderアフィリエイト]ダイアログ ボックスの[名前と値のペア]列に表示されます。値指定の形式は、以下のように追加するアフィリエイト属性のタイプによって異なります -- スタティック、ユーザ属性、または DN 属性。
- スタティック。リテラル属性値。スタティック アフィリエイト属性は、アフィリエイト サイトでユーザに関する特定の情報をアプリケーションへ渡すのに役立ちます。たとえば、アフィリエイト サイトでのユーザの信用限度などです。
- 形式: VariableName=valueVariableName は SAML アサーションでの属性を識別する名前です。また、値は属性値です。
- 例: climit=2000
- ユーザ属性。LDAP、WinNT または ODBC ユーザ ディレクトリ内のユーザのエントリに基づくユーザ プロファイル属性名。たとえば、ユーザの肩書きまたは電子メール アドレスの属性名などです。
- 形式: UserAttrVariableName=<%userattr="UserAttrName"%>UserAttrVariableName は SAML アサーションでの属性を識別する名前です。また、UserAttrName(引用符付き)は、ユーザ ディレクトリ内の属性の名前です。userattr= は、形式に含める必要があるスタティック テキストです。名前/値ペアの userattr= 部分は、次のようにパーセント記号と角かっこで囲む必要があります: <% . . . %>例: email_address=<%userattr="email"%>
- DN 属性。ユーザと関連付けられた LDAP または ODBC のディレクトリ オブジェクト内の属性の名前。ユーザが所属するグループ、ユーザ DN の一部をなす組織単位(ou)などは、属性を DN 属性として参照できるディレクトリ オブジェクトの例です。たとえば、DN 属性では、ユーザのメンバシップに基づいて、ユーザの部署を参照できます。
- 形式: DNVariableName=<#dn="DNSpec" attr="DNAttrName"#>DNVariableName は SAML アサーションでの属性を識別する名前です。DNSpec(引用符付き)は、ディレクトリ オブジェクトの DN です。また、DNAttrName(引用符付き)はディレクトリ オブジェクト属性の名前です。dn= と attr= は、形式に含める必要があるスタティック テキスト文字列です。名前/値ペアの dn= および attr= 部分は、次のようにポンド記号と角かっこで囲む必要があります: <# . . . #>例: GroupName=<#dn="ou=home,o=security.com" attr="cn"#>SiteMinderで、ネストされたグループから DN 属性を取得できるようにするには、DNSpec の最初に感嘆符(!)を付けます。たとえば、次のようにします。dn="!ou=home,o=security.com"
戻り値
AddAttribute メソッドは、以下の値を返します。
- PolicyMgtAffiliateAttr オブジェクト
- 失敗した場合は、undef
注釈
アフィリエイト属性は、
SiteMinder
が SAML アサーションでアフィリエイトに提供する名前/値ペアです。属性には、ユーザの資格(ユーザのアフィリエイト サイトでの信用限度など)およびユーザのプロファイル(肩書きまたは電子メール アドレスなど)からの情報が含まれます。アフィリエイト サイトでのアプリケーションは、アサーションからアフィリエイト属性を抽出すると、サイトでの他のアプリケーション用に HTTP ヘッダ変数または HTTP Cookie 変数として属性を利用可能にできます。
アフィリエイトに渡されるアサーションの合計サイズは、4K 以下にします。アフィリエイト オブジェクトに多くの属性が含まれる場合、この制限に違反する可能性があります。3K の最大のアサーション サイズが推奨されます。
AddUser メソッド - アフィリエイト オブジェクトに新しいユーザを追加
AddUser メソッドは、アフィリエイト オブジェクトに新しいユーザを追加します。
構文
AddUser メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->AddUser( user )
[Parameters]
AddUser メソッドは以下のパラメータを受け入れます。
- user(PolicyMgtUser)追加するユーザを指定します。
戻り値
AddUser メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- 失敗の場合は -1
AllowNotification メソッド - イベント通知プロパティを設定または取得
AllowNotification メソッドは、イベント通知プロパティを設定または取得します。イベント通知が有効な場合、アフィリエイトはアサーション プロデューサ サイト上の
SiteMinder
にユーザ アクティビティに関する通知を送信します。構文
AllowNotification メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->AllowNotification( [notificationFlag] )
[Parameters]
AllowNotification メソッドは以下のパラメータを受け入れます。
- notificationFlag(int)(オプション)イベント通知を有効にするかどうかを指定します。1 はイベント通知を有効にすることを表し、0 はイベント通知を無効にすることを表します。
戻り値
AllowNotification メソッドは以下のいずれかの値を返します。
- 新規または既存の通知フラグ設定
- 失敗した場合は、undef
AssertionPluginClass メソッド - アサーション生成プログラム プラグインの名前を設定または取得
AssertionPluginClass メソッドは、アサーション生成プログラム プラグインの完全修飾クラス名を設定または取得します。
構文
AssertionPluginClass メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->AssertionPluginClass( [className] )
[Parameters]
AssertionPluginClass メソッドは以下のパラメータを受け入れます。
- className(文字列)(オプション)たとえば、com.samlproducer.assertionplugin.partner1 などのカスタム アサーション生成プログラム プラグインの完全修飾クラス名を指定します。
戻り値
AssertionPluginClass メソッドは以下のいずれかの値を返します。
- 新規または既存のクラス名
- プラグインが定義されていない場合またはコールに失敗する場合は、undef
注釈
プラグインは、
SiteMinder
によって生成されたデフォルト SAML アサーションの内容を変更できるようにするカスタム Java クラスです。SAML アサーションはフェデレーション機能で利用可能です。アサーション生成プログラム プラグイン機能では、v6.0 SP 2 以上のポリシー管理 API セッション バージョンが必要です。アサーション生成プログラム プラグインにパラメータを渡すには、メソッド PolicyMgtAffiliate->AssertionPluginParameters を使用できます。
アサーション生成プログラム プラグインを作成するには、Java SDK 内の AssertionGeneratorPlugin インターフェースを実装します。
AssertionPluginParameters メソッド - パラメータ文字列を設定または取得
AssertionPluginParameters メソッドは、カスタム アサーション生成プログラム プラグインに渡すパラメータ文字列を設定または取得します。パラメータ文字列の構文はユーザ定義です。つまり、パラメータ文字列は、カスタム アサーション生成プログラムが必要とする規則に必ず従う必要があります。
構文
AssertionPluginParameters メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->AssertionPluginParameters( [parameter] )
[Parameters]
AssertionPluginParameters メソッドは以下のパラメータを受け入れます。
- parameters(文字列)(オプション)プラグインに渡すパラメータ文字列を指定します。
戻り値
AssertionPluginParameters メソッドは以下のいずれかの値を返します。
- 新規または既存のパラメータ文字列
- コールに失敗した場合は、undef
Audience メソッド - URI を設定または取得
Audience メソッドは、アサーション プロデューサ サイトとアフィリエイト間の許諾契約について説明するドキュメントの URI を設定または取得します。
この値はアフィリエイトに渡された SAML アサーションに含まれており、検証目的に使用できます。また、アフィリエイトは、関連情報を取得するためにオーディエンス ドキュメントを解析できます。オーディエンス値は、SAML アフィリエイト エージェント用の AffiliateConfig.xml 設定ファイル内の Assertion Audience 設定に一致する必要があります。
構文
Audience メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->Audience( [audience] )
[Parameters]
Audience メソッドは以下のパラメータを受け入れます。
- audience(文字列)(オプション)設定するオーディエンス URI を指定します。
戻り値
AudienceObjects メソッドは以下のいずれかの値を返します。
- 新規または既存の オーディエンス URI
- コールに失敗した場合は、undef
AuthURL メソッド - URL を設定または取得
AuthURL メソッドは、アフィリエイト ユーザの認証に使用する URL を設定または取得します。
構文
AuthURL メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->AuthURL( [AuthURL] )
[Parameters]
AuthURL メソッドは以下のパラメータを受け入れます。
- AuthURL(文字列)(オプション)設定する認証 URL を指定します。
戻り値
AuthURL メソッドは以下のいずれかの値を返します。
- 新規または既存の URL
- コールに失敗した場合は、undef
ConsumerURL メソッド - URI を設定または取得
ConsumerURL メソッドは、要求するユーザのブラウザで生成されたアサーションを POST 処理する必要がある URL を設定または取得します。
構文
ConsumerURL メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->ConsumerURL( [ConsumerURL] )
[Parameters]
ConsumerURL メソッドは以下のパラメータを受け入れます。
- ConsumerURL(文字列)(オプション)生成されたアサーションを送信する URL を指定します。
戻り値
ConsumerURL メソッドは以下のいずれかの値を返します。
- 生成されたアサーションを送信する新規または既存の URL
- コールに失敗した場合は、undef
CreateIPHostConfigName メソッド - 指定されたホスト名から IP 設定オブジェクトを作成
CreateIPHostConfigName メソッドは、指定されたホスト名から IP 設定オブジェクトを作成します。
構文
CreateIPHostConfigName メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->CreateIPConfigHostName( hostName )
[Parameters]
CreateIPHostConfigName メソッドは以下のパラメータを受け入れます。
- hostName(文字列)IP 設定オブジェクトのベースにするホスト名を指定します。
戻り値
CreateIPHostConfigName メソッドは以下のいずれかの値を返します。
- PolicyMgtIPConfig オブジェクト
- コールに失敗した場合は、undef
注釈
指定されたホストからアフィリエイト サイトにアクセスするユーザのみがアフィリエイト サイトで受け入れられます。
CreateIPConfigRange メソッド - IP 設定オブジェクトを作成
CreateIPConfigRange メソッドは、指定された IP アドレスの範囲から IP 設定オブジェクトを作成します。
構文
CreateIPConfigRange メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->CreateIPConfigRange( ipAddr1, ipAddr2 )
[Parameters]
CreateIPConfigRange メソッドは、以下のパラメータを受け入れます。
- ipAddr1(文字列)アフィリエイト サイトにアクセスするための有効な IP アドレス範囲内の最初の IP アドレスを指定します。
- ipAddr2(int)アフィリエイト サイトにアクセスするための有効な IP アドレス範囲内の最後の IP アドレスを指定します。
戻り値
CreateIPConfigRange メソッドは以下のいずれかの値を返します。
- PolicyMgtIPConfig オブジェクト
- コールに失敗した場合は、undef
注釈
指定された範囲内の IP アドレスからアフィリエイト サイトにアクセスするユーザのみがアフィリエイト サイトで受け入れられます。
CreateIPConfigSingleHost メソッド - 指定された IP アドレスから IP 設定オブジェクトを作成
CreateIPConfigSingleHost メソッドは、指定された IP アドレスから IP 設定オブジェクトを作成します。
構文
CreateIPConfigSingleHost メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->CreateIPConfigSingleHost( ipAddr )
[Parameters]
CreateIPConfigSingleHost メソッドは以下のパラメータを受け入れます。
- ipAddr(文字列)アフィリエイト サイトにアクセスする IP アドレスを指定します。
戻り値
CreateIPConfigSingleHost メソッドは以下のいずれかの値を返します。
- PolicyMgtIPConfig オブジェクト
- コールに失敗した場合は、undef
注釈
指定された IP アドレスからアフィリエイト サイトにアクセスするユーザのみがアフィリエイト サイトで受け入れられます。
CreateIPConfigSubnetMask メソッド - IP 設定オブジェクトを作成
CreateIPConfigSubnetMask メソッドは、指定された IP アドレスおよびサブネット マスクから IP 設定オブジェクトを作成します。
構文
CreateIPConfigSubnetMask メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->CreateIPConfigSubnetMask( ipAddr, subnetMask )
[Parameters]
CreateIPConfigSubnetMask メソッドは、以下のパラメータを受け入れます。
- ipAddr(文字列)サブネット アドレスを引き出すために使用する IP アドレスを指定します。
- subnetMask(署名なし long)サブネット アドレスを引き出すために使用するサブネット マスクを指定します。
戻り値
CreateIPConfigSubnetMask メソッドは以下のいずれかの値を返します。
- PolicyMgtIPConfig オブジェクト
- コールに失敗した場合は、undef
注釈
サブネット アドレスからアフィリエイト サイトにアクセスするユーザのみがアフィリエイト サイトで受け入れられます。サブネット アドレスは、渡された IP アドレスおよびサブネット マスクから引き出されます。
DeleteIPConfig メソッド - IP 設定 オブジェクトを削除
DeleteIPConfig メソッドは、指定された IP 設定オブジェクトを削除します。
構文
DeleteIPConfig メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->DeleteIPConfig( IPConfig )
[Parameters]
DeleteIPConfig メソッドは以下のパラメータを受け入れます。
- IPConfig(PolicyMgtIPConfig)削除する IP 設定オブジェクトを指定します。
戻り値
DeleteIPConfig メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- コールに失敗した場合は -1
Description メソッド - アフィリエイト オブジェクトの説明を設定または取得
Description メソッドは、アフィリエイト オブジェクトの説明を設定または取得します。
構文
Description メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->Description( [affDesc] )
[Parameters]
Description メソッドは以下のパラメータを受け入れます。
- affDesc(文字列)(オプション)設定する説明を指定します。
戻り値
Description メソッドは以下のいずれかの値を返します。
- アフィリエイト オブジェクトの新規または既存の説明。
- コールに失敗した場合は、undef
GetAllAttributes メソッド - アフィリエイト オブジェクトの属性を取得
GetAllAttributes メソッドは、アフィリエイト オブジェクトの既存のすべてのアフィリエイト属性を取得します。
構文
GetAllAttributes メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->GetAllAttributes( ) (returnCode)
[Parameters]
GetAllAttributes メソッドは、以下のパラメータを受け入れます。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllAttributes メソッドは以下の値を返します。
- PolicyMgtAffiliateAttr オブジェクトの配列
GetAllIPConfigs メソッド - アフィリエイトのすべての IP 設定オブジェクトを取得
GetAllIPConfigs メソッドは、アフィリエイト オブジェクトのすべての IP 設定オブジェクトを取得します。
構文
GetAllIPConfigs メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->GetAllIPConfigs( )
[Parameters]
GetAllIPConfigs メソッドは、パラメータを受け入れません。
戻り値
GetAllIPConfigs メソッドは以下のいずれかの値を返します。
- PolicyMgtIPConfg オブジェクトの配列
- IP 設定オブジェクトが見つからなかった場合は、undef
GetAllUsers メソッド - アフィリエイトと関連付けられたすべてのユーザを取得
GetAllUsers メソッドは、アフィリエイト オブジェクトと関連付けられたすべてのユーザを取得します。ユーザ ディレクトリが指定される場合、メソッドはアフィリエイトおよび特定のディレクトリと関連付けられたユーザのみを返します。
構文
GetAllUsers メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->GetAllUsers( [userDir] ) (returnCode)
[Parameters]
GetAllUsers メソッドは以下のパラメータを受け入れます。
- userDir(PolicyMgtUserDir)(オプション)アフィリエイト ユーザがメンバである必要があるユーザ ディレクトリを指定します。
- returnCode(int)関数コールの戻り時に取り込まれる出力変数。コールが成功した場合に取り込まれる値は 0 です。コールが失敗した場合に取り込まれる値は、ポリシー管理 API エラー コードに対応する負の数です。
戻り値
GetAllUsers メソッドは以下の値を返します。
- PolicyMgtUser オブジェクトの配列
IsEnabled メソッド - アフィリエイトの有効化フラグを設定または取得
IsEnabled メソッドは、アフィリエイト オブジェクトの有効化フラグを設定または取得します。
構文
IsEnabled メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->IsEnabled( [enableFlag] )
[Parameters]
IsEnabled メソッドは以下のパラメータを受け入れます。
- enableFlag(int)(オプション)以下のようにアフィリエイト オブジェクトを有効にするかどうかを指定します。
- 値 1 はアフィリエイトを有効にします。
- 値 0 はアフィリエイトを無効にします。
戻り値
IsEnabled メソッドは以下のいずれかの値を返します。
- アフィリエイト オブジェクトが有効な場合は、1
- アフィリエイト オブジェクトが無効な場合は、0
- コールに失敗した場合は、-1
Name メソッド - アフィリエイト名を設定または取得
Name メソッドは、アフィリエイト オブジェクトの名前を設定または取得します。
構文
Name メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->Name( [affName] )
[Parameters]
Name メソッドは以下のパラメータを受け入れます。
- affName(文字列)(オプション)設定する名前を指定します。
戻り値
Name メソッドは以下のいずれかの値を返します。
- 新規または既存のアフィリエイト オブジェクト名
- コールに失敗した場合は、undef
Password メソッド - アフィリエイトのパスワードを設定または取得
Password メソッドは、アフィリエイトで
SiteMinder
フェデレーション Web サービスにアクセスするために使用するパスワードを設定または取得します。構文
Password メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->Password( [affPassword] )
[Parameters]
Password メソッドは以下のパラメータを受け入れます。
- affPassword(文字列)(オプション)設定するパスワードを指定します。
戻り値
Password メソッドは以下のいずれかの値を返します。
- 新規または既存のパスワード
- コールに失敗した場合は、undef
RemoveAttribute メソッド - アフィリエイトから属性を削除
RemoveAttribute メソッドは、アフィリエイト オブジェクトから指定されたアフィリエイト属性を削除します。
構文
RemoveAttribute メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->RemoveAttribute( affiliateAttr )
[Parameters]
RemoveAttribute メソッドは以下のパラメータを受け入れます。
- affiliateAttr(PolicyMgtAffiliateAttr)削除するアフィリエイト属性を指定します。
戻り値
RemoveAttribute メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- 失敗の場合は -1
RemoveUser メソッド - アフィリエイトからユーザを削除
RemoveUser メソッドは、アフィリエイト オブジェクトから指定されたユーザを削除します。
構文
RemoveUser メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->RemoveUser( user )
[Parameters]
RemoveUser メソッドは以下のパラメータを受け入れます。
- user(タイプ)削除するユーザを指定します。
戻り値
RemoveUser メソッドは以下のいずれかの値を返します。
- 成功の場合は 0
- 失敗の場合は -1
SAMLProfile メソッド - SAML プロファイルのタイプを設定または取得
SAMLProfile メソッドは、アサーションの送信および受信に使用されるプロファイルのタイプを設定または取得します。
構文
SAMLProfile メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->SAMLProfile([SAMLProfile])
[Parameters]
SAMLProfile メソッドは、以下のパラメータを受け入れます。
- SAMLProfile(long)(オプション)以下のいずれかの有効な SAML プロファイルを指定します。
- AFFILIATE_SAML_PROFILE_ARTIFACT。SAML アサーションは、アサーション プロデューサと関連付けられた URL から取得されます。URL は SAML アーチファクト認証方式の設定時に指定されます。
- AFFILIATE_SAML_PROFILE_POST。生成された SAML アサーションは、PolicyMgtAffiliate->ConsumerURL メソッドで指定された URL に対して POST 処理されます。ポリシー管理 API のセッション バージョンが少なくとも v6.0 SP 2 である場合にのみ、このプロファイルがサポートされます。
戻り値
SAMLProfile メソッドは以下のいずれかの値を返します。
- 新規または既存の SAML プロファイル タイプ
- コールに失敗した場合は、undef
SAMLVersion メソッド - アフィリエイトの SAML バージョンを設定または取得
SAMLVersion メソッドは、アフィリエイトの SAML バージョンを設定または取得します。
構文
SAMLVersion メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->SAMLVersion( [SAMLVer] )
[Parameters]
SAMLVersion メソッドは以下のパラメータを受け入れます。
- SAMLVer(long)(オプション)設定する以下のいずれかの SAML バージョンを指定します。
- AFFILIATE_SAML_VER_1_0
- AFFILIATE_SAML_VER_1_1
戻り値
SAMLVersion メソッドは以下のいずれかの値を返します。
- 新規または既存の SAML バージョン
- コールに失敗した場合は、undef
注釈
SAML バージョンの指定は、ポリシー マネージャ API のセッション バージョンが少なくとも v6.0 SP 1 である場合にのみ有効です。
Save メソッド - ポリシー ストアにアフィリエイトを保存
Save メソッドは、ポリシー ストアにアフィリエイト オブジェクトを保存します。
構文
Save メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->Save( )
[Parameters]
Save メソッドは、パラメータを受け入れません。
戻り値
Save メソッドは以下のいずれかの値を返します。
- 成功の場合は 0。
- 失敗の場合は -1。
- 変更を保存するためのユーザの権限が十分でない場合は、-4。
- パスとクラスが空の場合は、-10。
注釈
アフィリエイト オブジェクトに対して必要なすべての変更を行った後にこのメソッドを 1 回コールします。変更を有効にするには、このメソッドをコールする必要があります。
SessionSyncInterval メソッド - セッション同期プロパティを設定または取得
SessionSyncInterval メソッドは、セッション同期間隔プロパティを設定または取得します。このプロパティは、アフィリエイトが共有セッションのステータスを検証するためにアサーション プロデューサ サイトにアクセスする頻度を秒単位で指定します。
構文
SessionSyncInterval メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->SessionSyncInterval( [SessionSyncInterval] )
[Parameters]
SessionSyncInterval メソッドは以下のパラメータを受け入れます。
- SessionSyncInterval(long)(オプション)設定するセッション同期間隔を指定します。
戻り値
SessionSyncInterval メソッドは以下のいずれかの値を返します。
- 新規または既存のセッション同期間隔
- コールに失敗した場合は、undef
SharedSessioning メソッドは、共有セッション プロパティを設定または取得します。共有セッションでは、一方のサイト上のセッションが終了すると、アサーション プロデューサ サイトおよびアフィリエイトの両方のセッションが終了します。
構文
SharedSessioning メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->ShareSessioning([shareFlag])
[Parameters]
SharedSessioning メソッドは以下のパラメータを受け入れます。
- shareFlag(int)(オプション)設定する共有セッション プロパティを指定します。
- アサーション プロデューサおよびアフィリエイトでセッション情報を共有できるようにするには、1
- プロデューサおよびアフィリエイトで個別のセッションを維持するには、0
戻り値
SharedSessioning メソッドは以下のいずれかの値を返します。
- 新規または既存の共有セッション プロパティ値
- コールに失敗した場合は、undef
SkewTime メソッド - スキュー時間プロパティを設定または取得
SkewTime メソッドは、スキュー時間プロパティを設定または取得します。スキュー時間は、アサーション プロデューサ サイトのシステム クロック時間とアフィリエイト サイトのシステム クロック時間の間の秒単位の違いです。時間は GMT が基準になります。
構文
SkewTime メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->SkewTime( [SkewTime] )
[Parameters]
SkewTime メソッドは以下のパラメータを受け入れます。
- skewTime(long)(オプション)設定するスキュー時間を指定します。
戻り値
SkewTime メソッドは以下のいずれかの値を返します。
- 新規または既存のスキュー時間
- コールに失敗した場合は、undef
ValidityDuration メソッド - SAML アサーションが有効な期間を設定または取得
ValidityDuration メソッドは、
SiteMinder
によって生成された SAML アサーションが有効な秒数を設定または取得します。アフィリエイトが指定された時間の後にアサーションを受信すると、アサーションが無効であると見なされます。構文
ValidityDuration メソッドの形式は以下のとおりです。
Netegrity::PolicyMgtAffiliate->ValidityDuration( [ValidityDuration] )
[Parameters]
ValidityDuration メソッドは以下のパラメータを受け入れます。
- validityDuration(long)(オプション)設定する有効期間を指定します。
戻り値
ValidityDuration メソッドは以下のいずれかの値を返します。
- 新規または既存の有効期間
- コールに失敗した場合は、undef