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

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

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

SessionStateUtility.AddHttpSessionStateToContext メソッド

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

現在の要求のコンテキストにセッションデータを適用します。

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

Visual Basic (宣言)

Public Shared Sub AddHttpSessionStateToContext
 ( _
    context As HttpContext, _
    container As IHttpSessionState _
)

Visual Basic (使用法)

Dim context As HttpContext
Dim container As IHttpSessionState

SessionStateUtility.AddHttpSessionStateToContext(context, container)

public static void AddHttpSessionStateToContext
 (
    HttpContext context,
    IHttpSessionState container
)

C++

public:
static void AddHttpSessionStateToContext (
    HttpContext^ context, 
    IHttpSessionState^ container
)

public static void AddHttpSessionStateToContext
 (
    HttpContext context, 
    IHttpSessionState container
)

JScript

public static function AddHttpSessionStateToContext
 (
    context : HttpContext, 
    container : IHttpSessionState
)

パラメータ

context: HttpSessionState オブジェクトを追加する対象の HttpContext オブジェクト。

container: 指定された HTTP コンテキストに追加する IHttpSessionState の実装のインスタンス。

例外

例外の種類	条件
HttpException	現在のセッションの HttpSessionState オブジェクトは、指定された context に既に追加されています。

解説

AddHttpSessionStateToContext メソッドは、セッション状態モジュールがセッションデータを現在の要求に適用するために使用します。これは、要求の開始時の AcquireRequestState イベントで行います。現在の要求のセッションデータは、既存のセッションに対して取得するか、または新しいセッションに対して作成します。セッションデータは IHttpSessionState の実装のインスタンスにカプセル化され、現在の HttpContext と共に AddHttpSessionStateToContext メソッドに渡されます。このセッションデータは、現在のコンテキストの Session プロパティを使用してアプリケーションコードで使用可能になります。

使用例

カスタムのセッション状態モジュールの AcquireRequestState イベントのハンドラのコード例を次に示します。このカスタムモジュールは、既存のセッション情報を取得するか、または新しいセッションの情報を作成し、AddHttpSessionStateToContext メソッドを使用して現在の要求の HttpContext に追加します。このコード例は、SessionStateUtility クラスのトピックで取り上げているコード例の一部分です。

Visual Basic

'
' Event handler for HttpApplication.AcquireRequestState
'

Private Sub OnAcquireRequestState(source As
 Object, args As EventArgs)
  Dim app     As HttpApplication = CType(source,
 HttpApplication)
  Dim context As HttpContext     = app.Context
  Dim isNew   As Boolean
         = False

  pSessionData = Nothing

  pSessionID = pSessionIDManager.GetSessionID(context)
  
  If Not pSessionID Is Nothing
 Then      
    Try
      pHashtableLock.AcquireReaderLock(Int32.MaxValue)
      pSessionData = CType(pSessionItems(pSessionID), SessionItem)

      If Not pSessionData Is
 Nothing Then _
        pSessionData.Expires = DateTime.Now.AddMinutes(pTimeout)
    Finally
      pHashtableLock.ReleaseReaderLock()
    End Try
  Else
    Dim redirected, cookieAdded As Boolean

    pSessionID = pSessionIDManager.CreateSessionID(context)
    pSessionIDManager.SaveSessionID(context, pSessionID, redirected, cookieAdded)

    If redirected Then Return
  End If

  If pSessionData Is Nothing
 Then      
    ' Identify the session as a New session state instance. Create a
 New SessionItem
    ' and add it to the local Hashtable.

    isNew = True

    pSessionData = New SessionItem()

    pSessionData.Items         = New SessionStateItemCollection()
    pSessionData.StaticObjects = SessionStateUtility.GetSessionStaticObjects(context)
    pSessionData.Expires       = DateTime.Now.AddMinutes(pTimeout)

    Try
      pHashtableLock.AcquireWriterLock(Int32.MaxValue)
      pSessionItems(pSessionID) = pSessionData
    Finally
      pHashtableLock.ReleaseWriterLock()
    End Try
  End If
        
  ' Add the session data to the current HttpContext.
  SessionStateUtility.AddHttpSessionStateToContext(context, _
                   New HttpSessionStateContainer(pSessionID, _
                                                pSessionData.Items, _
                                                pSessionData.StaticObjects, _
                                                pTimeout, _
                                                isNew, _
                                                pCookieMode, _
                                                SessionStateMode.Custom, _
                                                False))

  ' Execute the Session_OnStart event for a New session.
  If isNew Then RaiseEvent
 Start(Me, EventArgs.Empty)
End Sub


'
' Event for Session_OnStart event in the Global.asax file.
'

Public Event Start As EventHandler

//
// Event handler for HttpApplication.AcquireRequestState
//

private void OnAcquireRequestState(object source,
 EventArgs args)
{
  HttpApplication app     = (HttpApplication)source;
  HttpContext     context = app.Context;
  bool            isNew   = false;

  pSessionData = null;

  pSessionID = pSessionIDManager.GetSessionID(context);
  
  if (pSessionID != null)
  {
    try
    {
      pHashtableLock.AcquireReaderLock(Int32.MaxValue);
      pSessionData = (SessionItem)pSessionItems[pSessionID];

      if (pSessionData != null)
        pSessionData.Expires = DateTime.Now.AddMinutes(pTimeout);
    }
    finally
    {
      pHashtableLock.ReleaseReaderLock();
    }
  }
  else
  {
    bool redirected, cookieAdded;

    pSessionID = pSessionIDManager.CreateSessionID(context);
    pSessionIDManager.SaveSessionID(context, pSessionID, out redirected, out cookieAdded);

    if (redirected)
      return;
  }

  if (pSessionData == null)
  {
    // Identify the session as a new session state instance. Create
 a new SessionItem
    // and add it to the local Hashtable.

    isNew = true;

    pSessionData = new SessionItem();

    pSessionData.Items         = new SessionStateItemCollection();
    pSessionData.StaticObjects = SessionStateUtility.GetSessionStaticObjects(context);
    pSessionData.Expires       = DateTime.Now.AddMinutes(pTimeout);

    try
    {
      pHashtableLock.AcquireWriterLock(Int32.MaxValue);
      pSessionItems[pSessionID] = pSessionData;
    }
    finally
    {
      pHashtableLock.ReleaseWriterLock();
    }
  }
        
  // Add the session data to the current HttpContext.
  SessionStateUtility.AddHttpSessionStateToContext(context,
                   new HttpSessionStateContainer(pSessionID,
                                                pSessionData.Items,
                                                pSessionData.StaticObjects,
                                                pTimeout,
                                                isNew,
                                                pCookieMode,
                                                SessionStateMode.Custom,
                                                false));

  // Execute the Session_OnStart event for a new session.
  if (isNew && Start != null)
  {
    Start(this, EventArgs.Empty);
  }
}

//
// Event for Session_OnStart event in the Global.asax file.
//

public event EventHandler Start;