FormsAuthenticationEventArgs.User プロパティとは何？わかりやすく解説 Weblio辞書

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

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

FormsAuthenticationEventArgs.User プロパティ

現在の要求に関連付ける IPrincipal オブジェクトを取得または設定します。

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

Visual Basic (宣言)

Public Property User As
 IPrincipal

Visual Basic (使用法)

Dim instance As FormsAuthenticationEventArgs
Dim value As IPrincipal

value = instance.User

instance.User = value

public IPrincipal User { get; set;
 }

C++

public:
property IPrincipal^ User {
    IPrincipal^ get ();
    void set (IPrincipal^ value);
}

/** @property */
public IPrincipal get_User ()

/** @property */
public void set_User (IPrincipal value)

JScript

public function get User
 () : IPrincipal

public function set User
 (value : IPrincipal)

プロパティ値
現在の要求に関連付ける IPrincipal オブジェクト。

解説

User プロパティを使用して、現在の HttpContext の User プロパティを、カスタムの IPrincipal オブジェクトに設定できます。

FormsAuthentication_OnAuthenticate イベント中に User プロパティ値を指定しない場合、フォーム認証チケットによって提供される Cookie または URL 内の ID が使用されます。

使用例

FormsAuthentication_OnAuthenticate イベントを使用して、現在の HttpContext の User プロパティに、カスタム Identity を持つ GenericPrincipal オブジェクトを設定するコード例を次に示します。

Visual Basic

Public Sub FormsAuthentication_OnAuthenticate(sender
 As Object, _
                                              args As FormsAuthenticationEventArgs)
  If FormsAuthentication.CookiesSupported Then
    If Not Request.Cookies(FormsAuthentication.FormsCookieName)
 Is Nothing Then
      Try
        Dim ticket As FormsAuthenticationTicket
 = FormsAuthentication.Decrypt( _
          Request.Cookies(FormsAuthentication.FormsCookieName).Value)
        
        args.User = New System.Security.Principal.GenericPrincipal(
 _
          New Samples.AspNet.Security.MyFormsIdentity(ticket),
 _
          New String(0) {})
      Catch e As HttpException
        ' Decrypt method failed.
      End Try
    End If
  Else
      Throw New Exception("Cookieless
 Forms Authentication is not " & _
                            "supported for this application.")
  End If
End Sub

public void FormsAuthentication_OnAuthenticate(object
 sender, FormsAuthenticationEventArgs args)
{
  if (FormsAuthentication.CookiesSupported)
  {
    if (Request.Cookies[FormsAuthentication.FormsCookieName] !=
 null)
    {
      try
      {
        FormsAuthenticationTicket ticket = FormsAuthentication.Decrypt(
          Request.Cookies[FormsAuthentication.FormsCookieName].Value);
        
        args.User = new System.Security.Principal.GenericPrincipal(
          new Samples.AspNet.Security.MyFormsIdentity(ticket)
,
          new string[0]);
      }
      catch (Exception e)
      {
        // Decrypt method failed.
      }
    }
  }
  else
  {
    throw new HttpException("Cookieless Forms Authentication
 is not " +
                            "supported for this
 application.");
  }
}