ISessionIDManager.GetSessionID メソッドとは何？わかりやすく解説 Weblio辞書

.NET Framework クラスライブラリリファレンス

索引トップ用語の索引ランキング

ISessionIDManager.GetSessionID メソッド

メモ : このメソッドは、.NET Framework version 2.0 で新しく追加されたものです。

現在の HTTP 要求のコンテキストからセッション識別子を取得します。

名前空間: System.Web.SessionState
アセンブリ: System.Web (system.web.dll 内)
構文

Visual Basic (宣言)

Function GetSessionID ( _
    context As HttpContext _
) As String

Visual Basic (使用法)

Dim instance As ISessionIDManager
Dim context As HttpContext
Dim returnValue As String

returnValue = instance.GetSessionID(context)

string GetSessionID (
    HttpContext context
)

C++

String^ GetSessionID (
    HttpContext^ context
)

String GetSessionID (
    HttpContext context
)

JScript

function GetSessionID (
    context : HttpContext
) : String

パラメータ

context: Request プロパティ、Response プロパティなどの HTTP 要求を処理するためのサーバーオブジェクトを参照する現在の HttpContext オブジェクト。

戻り値
HTTP 要求と共に送信される現在のセッション識別子。

解説

HttpApplication.AcquireRequestState イベントと HttpApplication.EndRequest イベントの発生中に、SessionStateModule によって GetSessionID メソッドが呼び出されます。HTTP 要求から有効なセッション識別子を取得できない場合は、null 参照 (Visual Basic では Nothing) を返します。GetSessionID メソッドから null 参照 (Visual Basic では Nothing) を受け取ると、SessionStateModule は CreateSessionID メソッドを呼び出して新しいセッションのセッション識別子を取得します。

CreateSessionID の実装が返す値に HTTP 応答または要求で無効な文字が含まれる場合、UrlEncode メソッドを使用して、SaveSessionID メソッドの実装のセッション識別子値をエンコードし、UrlDecode メソッドを使用して、GetSessionID メソッドの実装のセッション識別子値をデコードする必要があります。

使用例

GetSessionID メソッドの部分的な実装のコード例を次に示します。カスタムのセッション ID マネージャが Cookie なしのセッション識別子をサポートする場合、ISAPI フィルタなどのセッション識別子を URL に含めてやり取りするソリューションを実装する必要があります。

Visual Basic

Public Function GetSessionID(context As
 HttpContext) As String _
  Implements ISessionIDManager.GetSessionID

  Dim id As String = Nothing

  If pConfig.Cookieless = HttpCookieMode.UseUri Then
    ' Retrieve the SessionID from the URI.
  Else
    id = context.Request.Cookies(pConfig.CookieName).Value
  End If    

  ' Verify that the retrieved SessionID is valid. If not, return Nothing.

  If Not Validate(id) Then
 _
    id = Nothing

  Return id
End Function

public string GetSessionID(HttpContext context)
{
  string id = null;

  if (pConfig.Cookieless == HttpCookieMode.UseUri)
  {
    // Retrieve the SessionID from the URI.
  }
  else
  {
    id = context.Request.Cookies[pConfig.CookieName].Value;
  }      

  // Verify that the retrieved SessionID is valid. If not, return null.

  if (!Validate(id))
    id = null;

  return id;
}