AuthenticationHandler<TOptions> Class

Article
10/27/2015

Base class for the per-request work performed by most authentication middleware.

Namespace: Microsoft.Owin.Security.Infrastructure
Assembly: Microsoft.Owin.Security (in Microsoft.Owin.Security.dll)

Inheritance Hierarchy

System.Object
Microsoft.Owin.Security.Infrastructure.AuthenticationHandler
Microsoft.Owin.Security.Infrastructure.AuthenticationHandler<TOptions>
Microsoft.Owin.Security.OpenIdConnect.OpenIdConnectAuthenticationHandler
Microsoft.Owin.Security.WsFederation.WsFederationAuthenticationHandler

Syntax

public abstract class AuthenticationHandler<TOptions> : AuthenticationHandler
where TOptions : AuthenticationOptions

generic<typename TOptions>
where TOptions : AuthenticationOptions
public ref class AuthenticationHandler abstract : AuthenticationHandler

[<AbstractClass>]
type AuthenticationHandler<'TOptions when 'TOptions : AuthenticationOptions> = 
    class
        inherit AuthenticationHandler
    end

Public MustInherit Class AuthenticationHandler(Of TOptions As AuthenticationOptions)
    Inherits AuthenticationHandler

Type Parameters

TOptions
Specifies which type for of AuthenticationOptions property

Constructors

	Name	Description
	AuthenticationHandler<TOptions>()	Initializes a new instance of the AuthenticationHandler<TOptions> class.

Properties

	Name	Description
	Context	(Inherited from AuthenticationHandler.)
	Faulted	(Inherited from AuthenticationHandler.)
	Helper	(Inherited from AuthenticationHandler.)
	Options
	Request	(Inherited from AuthenticationHandler.)
	RequestPathBase	(Inherited from AuthenticationHandler.)
	Response	(Inherited from AuthenticationHandler.)

Methods

	Name	Description
	ApplyResponseChallengeAsync()	Override this method to dela with 401 challenge concerns, if an authentication scheme in question deals an authentication interaction as part of it's request flow. (like adding a response header, or changing the 401 result to 302 of a login page or external sign-in location.)(Inherited from AuthenticationHandler.)
	ApplyResponseCoreAsync()	Core method that may be overridden by handler. The default behavior is to call two common response activities, one that deals with sign-in/sign-out concerns, and a second to deal with 401 challenges.(Inherited from AuthenticationHandler.)
	ApplyResponseGrantAsync()	Override this method to dela with sign-in/sign-out concerns, if an authentication scheme in question deals with grant/revoke as part of it's request flow. (like setting/deleting cookies)(Inherited from AuthenticationHandler.)
	AuthenticateAsync()	Causes the authentication logic in AuthenticateCore to be performed for the current request at most once and returns the results. Calling Authenticate more than once will always return the original value. This method should always be called instead of calling AuthenticateCore directly.(Inherited from AuthenticationHandler.)
	AuthenticateCoreAsync()	The core authentication logic which must be provided by the handler. Will be invoked at most once per request. Do not call directly, call the wrapping Authenticate method instead.(Inherited from AuthenticationHandler.)
	BaseInitializeAsync(AuthenticationOptions, IOwinContext)	(Inherited from AuthenticationHandler.)
	Equals(Object)	(Inherited from Object.)
	Finalize()	(Inherited from Object.)
	GenerateCorrelationId(AuthenticationProperties)	(Inherited from AuthenticationHandler.)
	GetHashCode()	(Inherited from Object.)
	GetType()	(Inherited from Object.)
	InitializeCoreAsync()	(Inherited from AuthenticationHandler.)
	InvokeAsync()	Called once by common code after initialization. If an authentication middleware responds directly to specifically known paths it must override this virtual, compare the request path to it's known paths, provide any response information as appropriate, and true to stop further processing.(Inherited from AuthenticationHandler.)
	MemberwiseClone()	(Inherited from Object.)
	TeardownCoreAsync()	(Inherited from AuthenticationHandler.)
	ToString()	(Inherited from Object.)
	ValidateCorrelationId(AuthenticationProperties, ILogger)	(Inherited from AuthenticationHandler.)

Thread Safety

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Share via