DefaultAuthenticationEventHandler デリゲート

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

DefaultAuthenticationEventHandler デリゲート

DefaultAuthenticationModule の DefaultAuthentication_OnAuthenticate イベントを処理するメソッドを表します。

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

Visual Basic (宣言)

Public Delegate Sub DefaultAuthenticationEventHandler
 ( _
    sender As Object, _
    e As DefaultAuthenticationEventArgs _
)

Visual Basic (使用法)

Dim instance As New DefaultAuthenticationEventHandler(AddressOf
 HandlerMethod)

C#

public delegate void DefaultAuthenticationEventHandler
 (
    Object sender,
    DefaultAuthenticationEventArgs e
)

C++

public delegate void DefaultAuthenticationEventHandler
 (
    Object^ sender, 
    DefaultAuthenticationEventArgs^ e
)

J#

/** @delegate */
public delegate void DefaultAuthenticationEventHandler
 (
    Object sender, 
    DefaultAuthenticationEventArgs e
)

JScript

JScript では、デリゲートは使用できますが、新規に宣言することはできません。

パラメータ

sender

イベントのソース。

e

イベント データを格納している DefaultAuthenticationEventArgs。

解説

DefaultAuthenticationEventHandler デリゲートは、DefaultAuthenticationModule クラスの Authenticate イベントに対して定義されています。DefaultAuthenticationModule クラスの Authenticate イベントには、ASP.NET アプリケーションの Global.asax ファイルに、DefaultAuthentication_OnAuthenticate というサブルーチンを指定することによってアクセスできます。Authenticate イベントは、AuthenticateRequest イベントの後に発生し、現在の HttpContext の User プロパティに必ず IPrincipal オブジェクトが格納されるようにします。

DefaultAuthentication_OnAuthenticate イベントに渡した DefaultAuthenticationEventArgs オブジェクトの Context プロパティを使用して、現在の HttpContext の User プロパティにカスタムの IPrincipal オブジェクトを設定できます。DefaultAuthentication_OnAuthenticate イベント中に渡される HttpContext の User プロパティに対して値を指定しない場合、DefaultAuthenticationModule は、HttpContext の User プロパティに、ユーザー情報が含まれない GenericPrincipal オブジェクトを設定します。

DefaultAuthentication_OnAuthenticate イベントは、AuthenticateRequest イベントの後と AuthorizeRequest イベントの前に発生します。authorization セクションにより、アプリケーションへのアクセスの許可または拒否をユーザー名に依存している場合、現在の HttpContext の User プロパティを変更することによりアプリケーションの動作に影響を与えることがあります。構成ファイルの authorization セクションを指定するときには、必ず、DefaultAuthentication_OnAuthenticate イベントで設定されるユーザー名を考慮するようにしてください。

使用例

DefaultAuthentication_OnAuthenticate イベントを使用して、現在の HttpContext の User プロパティが null 参照 (Visual Basic では Nothing) かどうかをテストするコード例を次に示します。このプロパティが null 参照 (Visual Basic では Nothing) の場合、サンプル コードでは、現在の HttpContext の User プロパティに GenericPrincipal オブジェクトが設定され、このとき、GenericPrincipal オブジェクトの Identity は Name 値が "default" の GenericIdentity になります。

メモ
DefaultAuthentication_OnAuthenticate イベントは、AuthorizeRequest イベントの前に発生します。結果、現在の HttpContext の User プロパティにカスタム ID を設定すると、アプリケーションの動作に影響を与える場合があります。たとえば、FormsAuthentication クラスを使用して、認証されたユーザーしかサイトにアクセスできないように authorization セクションに <deny users="?" /> と指定している場合、このサンプル コードでは、ユーザーは "default" という名前を持つため deny 要素が無視されます。この場合、<deny users="default" /> と指定すると、認証されたユーザーのみがサイトにアクセスできるようになります。

Visual Basic

Public Sub DefaultAuthentication_OnAuthenticate(sender
 As Object, _
                                                args As DefaultAuthenticationEventArgs)
  If args.Context.User Is Nothing
 Then
    args.Context.User = _
      new System.Security.Principal.GenericPrincipal( _
        new System.Security.Principal.GenericIdentity("default"),
 _
        new String(0) {})
  End If
End Sub

C#

public void DefaultAuthentication_OnAuthenticate(object
 sender,
                                                 DefaultAuthenticationEventArgs args)
{
  if (args.Context.User == null)
    args.Context.User = 
      new System.Security.Principal.GenericPrincipal(
        new System.Security.Principal.GenericIdentity("default")
,
        new String[0]);
}

プラットフォーム

Windows 98, Windows 2000 SP4, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

開発プラットフォームの中には、.NET Framework によってサポートされていないバージョンがあります。サポートされているバージョンについては、「システム要件」を参照してください。

バージョン情報

.NET Framework
サポート対象 : 2.0、1.1、1.0

参照

関連項目
System.Web.Security 名前空間