セッション メソッド

目次
casso127jpjp
目次
AddParameter メソッド -- パラメータ リストにセッション変数名と値のペアを追加
AddParameter メソッドは、パラメータ リストにセッション変数名と値のペアを追加します。セッション変数には、ビジネス ロジック、証明書情報およびアフィリエイト アプリケーション用の SAML アサーションなどのクライアント アプリケーションに関するデータが含まれます。このデータはユーザ セッションにバインドされます。
構文
AddParameter メソッドの形式は以下のとおりです。
Netegrity::AgentSession->AddParameter(varName [,varValue][, varFlag])
[Parameters]
AddParameter メソッドは、以下のパラメータを受け入れます。
  1. varName
    (文字列)
    パラメータ リストに追加する変数の名前を指定します。
    制限:
    最大長は 255 文字です。
  2. varValue
    (文字列)
    (オプション)パラメータ リストに追加する変数の値を指定します。
    制限:
    最大長はターゲット データ ストアによって決定されます。
  3. varFlag
    (int)
    (オプション)以下のように、GetVariables メソッドでセッション ストアから変数名と値のペアを削除するかどうかを指定します。
    • 0(ゼロ)
      GetVariables でセッション ストアから変数名と値のペアを取得するがそれを削除しないことを指定します。
    • 1(one)
      GetVariables でセッション ストアから変数名と値のペアを取得してそれを削除することを指定します。
戻り値
AddParameter メソッドは、値を返しません。
注釈
以下のセッション変数メソッドをコールして、パラメータ リスト内の名前と値のペアを管理できます。
  • AgentSession->DelVariables
  • AgentSession->GetVariables
  • AgentSession->SetVariables
複数の変数を管理するには、変数ごとに AddParameter を 1 回コールしてから、AgentSession->DelVariables、AgentSession->GetVariables、および AgentSession->SetVariables メソッドをコールします。AddParameter は変数をパラメータ リストに追加しますが、AgentSession->DelVariables、AgentSession->GetVariables、および AgentSession->SetVariables は、パラメータ リストをクリアします。
セッション変数メソッドを使用するには、その前に以下の条件を満たしている必要があります。
  • 少なくとも 1 つのレルムで永続セッションを作成する必要があります。
  • CA Single Sign-on
    セッション ストアが有効化されている必要があります。
DelVariables メソッド -- セッション ストアからセッション変数を削除
DelVariables メソッドは、セッション ストアからパラメータ リスト内のセッション変数を削除します。最初に AgentSession->AddParameter をコールして、パラメータ リスト内の変数を指定します。
構文
DelVariables メソッドの形式は以下のとおりです。
Netegrity::AgentSession->DelVariables()
[Parameters]
DelVariables メソッドは、パラメータを受け入れません。
戻り値
DelVariables メソッドは、値を返しません。
注釈
DelVariables メソッドは、パラメータ リストをクリアします。
GetID メソッド -- セッション ID を取得
GetID メソッドは、セッション ID を取得します。
構文
GetID メソッドの形式は以下のとおりです。
Netegrity::AgentSession->GetID()
[Parameters]
GetID メソッドは、パラメータを受け入れません。
戻り値
GetID メソッドは、以下の値を返します。
  • session_ID(文字列)
GetReason メソッド -- セッションの理由 ID を取得
GetReason メソッドは、セッションの理由 ID を取得します。理由 ID は、失敗した認証または許可の理由を指定します。
構文
GetReason メソッドの形式は以下のとおりです。
Netegrity::AgentSession->GetReason()
[Parameters]
GetReason メソッドは、パラメータを受け入れません。
戻り値
GetReason メソッドは以下のいずれかの値(long 型)を返します。
  • Sm_Api_Reason_None(値 = 0)
  • Sm_Api_Reason_PwMustChange(値 = 1)
  • Sm_Api_Reason_InvalidSession(値 = 2)
  • Sm_Api_Reason_RevokedSession(値 = 3)
  • Sm_Api_Reason_ExpiredSession(値 = 4)
  • Sm_Api_Reason_AuthLevelTooLow(値 = 5)
  • Sm_Api_Reason_UnknownUser(値 = 6)
  • Sm_Api_Reason_UserDisabled(値 = 7)
  • Sm_Api_Reason_InvalidSessionId(値 = 8)
  • Sm_Api_Reason_InvalidSessionIp(値 = 9)
  • Sm_Api_Reason_CertificateRevoked(値 = 10)
  • Sm_Api_Reason_CRLOutOfDate(値 = 11)
  • Sm_Api_Reason_CertRevokedKeyCompromised(値 = 12)
  • Sm_Api_Reason_CertRevokedAffiliationChange(値 = 13)
  • Sm_Api_Reason_CertOnHold(値 = 14)
  • Sm_Api_Reason_TokenCardChallenge(値 = 15)
  • Sm_Api_Reason_ImpersonatedUserNotInDir(値 = 16)
  • Sm_Api_Reason_Anonymous(値 = 17)
  • Sm_Api_Reason_PwWillExpire(値 = 18)
  • Sm_Api_Reason_PwExpired(値 = 19)
  • Sm_Api_Reason_ImmedPWChangeRequired(値 = 20)
  • Sm_Api_Reason_PWChangeFailed(値 = 21)
  • Sm_Api_Reason_BadPWChange(値 = 22)
  • Sm_Api_Reason_PWChangeAccepted(値 = 23)
  • Sm_Api_Reason_ExcessiveFailedLoginAttempts(値 = 24)
  • Sm_Api_Reason_AccountInactivity(値 = 25)
  • Sm_Api_Reason_NoRedirectConfigured(値 = 26)
  • Sm_Api_Reason_ErrorMessageIsRedirect(値 = 27)
  • Sm_Api_Reason_Next_Tokencode(値 = 28)
  • Sm_Api_Reason_New_PIN_Select(値 = 29)
  • Sm_Api_Reason_New_PIN_Sys_Tokencode(値 = 30)
  • Sm_Api_Reason_New_User_PIN_Tokencode(値 = 31)
  • Sm_Api_Reason_New_PIN_Accepted(値 = 32)
  • Sm_Api_Reason_Guest(値 = 33)
  • Sm_Api_Reason_PWSelfChange(値 = 34)
  • Sm_Api_Reason_ServerException(値 = 35)
  • Sm_Api_Reason_UnknownScheme(値 = 36)
  • Sm_Api_Reason_UnsupportedScheme(値 = 37)
  • Sm_Api_Reason_Misconfigured(値 = 38)
  • Sm_Api_Reason_BufferOverflow(値 = 39)
  • Sm_Api_Reason_SetPersistentSessionFailed(値 = 40)
GetSpec メソッド -- 暗号化セッション指定情報を取得
GetSpec メソッドは、暗号化セッション指定情報を取得します。セッション指定情報には、セッション開始時刻、タイムアウト パラメータおよびユーザの識別名などのユーザ セッションに関する情報が含まれます。シングル サインオン アプリケーションの場合のように、複数の Web サイトにわたってセッションを識別するためにセッション指定情報を使用できます。
構文
GetSpec メソッドの形式は以下のとおりです。
Netegrity::AgentSession->GetSpec()
[Parameters]
GetSpec メソッドは、パラメータを受け入れません。
戻り値
GetSpec メソッドは、以下の値を返します。
  • encrypted_session_specification(文字列)
注釈
セッション指定情報が保存される場所は、以下のセッションのタイプによって異なります。
  • 非永続セッション
    セッション指定情報は Cookie に保存されます。
  • 永続セッション
    セッション指定情報は、セッション ストア データベースに保存されます。また、オプションでクライアントの Cookie に保存されます。
  • 注:
    セッション チケットは、Web エージェントのキャッシュに保存された実際のユーザ セッション データのインデックスとして使用されます。
GetVariables メソッド -- セッション ストアからセッション変数を取得
GetVariables メソッドは、セッション ストアからパラメータ リスト内のセッション変数を取得します。最初に AgentSession->AddParameter をコールして、パラメータ リスト内の変数を指定します。取得後に変数をセッション ストアから削除するには、
varFlag
を 1(one)に設定した状態で AgentSession->AddParameter をコールします。
構文
GetVariables メソッドの形式は以下のとおりです。
Netegrity::AgentSession->GetVariables()
[Parameters]
GetVariables メソッドは、パラメータを受け入れません。
戻り値
GetVariables メソッドは、以下の値を返します。
  • AgentResponseAttr (配列)
注:
一部のセッション変数は取得できません。この確認を行うには、AgentResponseAttr->GetFlags を関連付けられた AgentResponseAttr オブジェクトに対してコールし、以下の戻り値についてテストします。
SM_AGENTAPI_RESPATTR_FLAGS_UNRESOLVED(値 = 2)
注釈
GetVariables メソッドは、パラメータ リストをクリアします。
IdleTimeout メソッド -- セッションのアイドル タイムアウト値を取得
IdleTimeout メソッドは、秒単位のセッションのアイドル タイムアウト値を取得します。アイドル タイムアウト値はユーザ セッションを
非アクティブ
な状態にできる時間の最大長です。この時間を超過すると、セッションは有効ではなくなり、ユーザは再認証する必要があります。
構文
IdleTimeout メソッドの形式は以下のとおりです。
Netegrity::AgentSession->IdleTimeout()
[Parameters]
IdleTimeout メソッドは、パラメータを受け入れません。
戻り値
IdleTimeout メソッドは、以下の値を返します。
  • idle_timeout_value(long)
MaxTimeout メソッド -- セッションの最大タイムアウト値を取得
MaxTimeout メソッドは、秒単位のセッションの最大タイムアウト値を取得します。最大タイムアウト値はユーザ セッションを
アクティブ
な状態にできる時間の長さです。この時間を超過すると、ユーザは再認証する必要があります。
構文
MaxTimeout メソッドの形式は以下のとおりです。
Netegrity::AgentSession->MaxTimeout()
[Parameters]
MaxTimeout メソッドは、パラメータを受け入れません。
戻り値
MaxTimeout メソッドは、以下の値を返します。
  • maximum_timeout_value(long)
SetVariables メソッド -- セッション ストアにセッション変数を書き込み
SetVariables メソッドは、パラメータ リスト内のセッション変数をセッション ストアに書き込みます。最初に AgentSession->AddParameter をコールして、リスト内の変数を指定します。変数がセッション ストアに存在する場合、その値は新しい値に更新されます。変数が存在しない場合は、新しい変数が作成されます。
構文
SetVariables メソッドの形式は以下のとおりです。
Netegrity::AgentSession->SetVariables()
[Parameters]
SetVariables メソッドは、パラメータを受け入れません。
戻り値
SetVariables メソッドは、値を返しません。
注釈
SetVariables メソッドは、パラメータ リストをクリアします。