WindowsAuthenticationEventArgsとは何？わかりやすく解説 Weblio辞書

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

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

WindowsAuthenticationEventArgs クラス

WindowsAuthentication_OnAuthenticate イベントのデータを提供します。このクラスは継承できません。

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

Visual Basic (宣言)

Public NotInheritable Class
 WindowsAuthenticationEventArgs
    Inherits EventArgs

Visual Basic (使用法)

Dim instance As WindowsAuthenticationEventArgs

public sealed class WindowsAuthenticationEventArgs
 : EventArgs

C++

public ref class WindowsAuthenticationEventArgs
 sealed : public EventArgs

public final class WindowsAuthenticationEventArgs
 extends EventArgs

JScript

public final class WindowsAuthenticationEventArgs
 extends EventArgs

解説

WindowsAuthenticationEventArgs クラスは WindowsAuthentication_OnAuthenticate イベントにイベント値を指定し、現在の要求に対するカスタムの Windows ID を指定できるようにするために使用されます。

WindowsAuthenticationModule は、IIS によって提供された Windows ID と現在の HttpContext を使用して WindowsAuthenticationEventArgs オブジェクトを構築し、それを WindowsAuthentication_OnAuthenticate イベントに渡します。

WindowsAuthentication_OnAuthenticate イベントに渡した WindowsAuthenticationEventArgs オブジェクトの User プロパティを使用して、現在の HttpContext の User プロパティにカスタムの IPrincipal オブジェクトを設定できます。WindowsAuthentication_OnAuthenticate イベント中に User プロパティ値が指定されない場合、IIS によって提供される Windows ID が現在の要求に対する ID として使用されます。IIS が匿名認証を使用する場合、Identity プロパティには、GetAnonymous メソッドによって返される ID が設定されます。

WindowsAuthentication_OnAuthenticate イベントは、認証 Mode が Windows に設定され、WindowsAuthenticationModule がアプリケーションのアクティブ HTTP モジュールである場合にのみ生成されます。

使用例

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

Visual Basic

Public Sub WindowsAuthentication_OnAuthenticate(sender
 As Object, args As WindowsAuthenticationEventArgs)
  If Not args.Identity.IsAnonymous Then
    args.User = New Samples.AspNet.Security.MyPrincipal(args.Identity)
  End If
End Sub

public void WindowsAuthentication_OnAuthenticate(object
 sender, WindowsAuthenticationEventArgs args)
{
  if (!args.Identity.IsAnonymous)
  {
    args.User = new Samples.AspNet.Security.MyPrincipal(args.Identity);
  }
}

.NET Framework のセキュリティ

AspNetHostingPermission (ホスト環境で WindowsAuthenticationEventArgs クラスを使用するために必要なアクセス許可)要求値 : LinkDemand。アクセス許可値 : Minimal。

継承階層

System.Object
System.EventArgs
System.Web.Security.WindowsAuthenticationEventArgs

スレッドセーフ

この型の public static (Visual Basic では Shared) メンバはすべて、スレッドセーフです。インスタンスメンバの場合は、スレッドセーフであるとは限りません。

プラットフォーム

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

参照

関連項目
WindowsAuthenticationEventArgs メンバ
System.Web.Security 名前空間
その他の技術情報
Windows 認証プロバイダ

WindowsAuthenticationEventArgs コンストラクタ

WindowsAuthenticationEventArgs クラスの新しく作成されたインスタンスを初期化します。

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

Visual Basic (宣言)

Public Sub New ( _
    identity As WindowsIdentity, _
    context As HttpContext _
)

Visual Basic (使用法)

Dim identity As WindowsIdentity
Dim context As HttpContext

Dim instance As New WindowsAuthenticationEventArgs(identity,
 context)

public WindowsAuthenticationEventArgs (
    WindowsIdentity identity,
    HttpContext context
)

C++

public:
WindowsAuthenticationEventArgs (
    WindowsIdentity^ identity, 
    HttpContext^ context
)

public WindowsAuthenticationEventArgs (
    WindowsIdentity identity, 
    HttpContext context
)

JScript

public function WindowsAuthenticationEventArgs
 (
    identity : WindowsIdentity, 
    context : HttpContext
)

パラメータ

identity: Windows の ID オブジェクト。

context: イベントのコンテキスト。

解説

プラットフォーム

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
サポート対象 : 2.0、1.1、1.0

参照

関連項目
WindowsAuthenticationEventArgs クラス
WindowsAuthenticationEventArgs メンバ
System.Web.Security 名前空間
その他の技術情報
Windows 認証プロバイダ

WindowsAuthenticationEventArgs プロパティ

パブリックプロパティパブリックプロパティ

	名前	説明
	Context	現在の HTTP 要求に対する HttpContext オブジェクトを取得します。
	Identity	WindowsAuthenticationEventArgs コンストラクタに渡される Windows ID を取得します。
	User	現在の要求に関連付ける IPrincipal オブジェクトを取得または設定します。

参照

その他の技術情報

Windows 認証プロバイダ

WindowsAuthenticationEventArgs メソッド

パブリックメソッドパブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 ( Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 ( Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 ( Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 ( Object から継承されます。)
	ToString	現在の Object を表す String を返します。 ( Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 ( Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 ( Object から継承されます。)

参照

その他の技術情報

Windows 認証プロバイダ

WindowsAuthenticationEventArgs メンバ

WindowsAuthentication_OnAuthenticate イベントのデータを提供します。このクラスは継承できません。

WindowsAuthenticationEventArgs データ型で公開されるメンバを以下の表に示します。

パブリックコンストラクタ

	名前	説明
	WindowsAuthenticationEventArgs	WindowsAuthenticationEventArgs クラスの新しく作成されたインスタンスを初期化します。

パブリックプロパティ

	名前	説明
	Context	現在の HTTP 要求に対する HttpContext オブジェクトを取得します。
	Identity	WindowsAuthenticationEventArgs コンストラクタに渡される Windows ID を取得します。
	User	現在の要求に関連付ける IPrincipal オブジェクトを取得または設定します。

パブリックメソッド

( プロテクトメソッドも参照)

	名前	説明
	Equals	オーバーロードされます。 2 つの Object インスタンスが等しいかどうかを判断します。 (Object から継承されます。)
	GetHashCode	特定の型のハッシュ関数として機能します。GetHashCode は、ハッシュアルゴリズムや、ハッシュテーブルのようなデータ構造での使用に適しています。 (Object から継承されます。)
	GetType	現在のインスタンスの Type を取得します。 (Object から継承されます。)
	ReferenceEquals	指定した複数の Object インスタンスが同一かどうかを判断します。 (Object から継承されます。)
	ToString	現在の Object を表す String を返します。 (Object から継承されます。)

プロテクトメソッド

	名前	説明
	Finalize	Object がガベージコレクションにより収集される前に、その Object がリソースを解放し、その他のクリーンアップ操作を実行できるようにします。 (Object から継承されます。)
	MemberwiseClone	現在の Object の簡易コピーを作成します。 (Object から継承されます。)