AuthenticationHandler<TOptions> Class
Base class for the per-request work performed by most authentication middleware.
Inheritance Hierarchy
System.Object
Microsoft.Owin.Security.Infrastructure.AuthenticationHandler
Microsoft.Owin.Security.Infrastructure.AuthenticationHandler<TOptions>
Namespace: Microsoft.Owin.Security.Infrastructure
Assembly: Microsoft.Owin.Security (in Microsoft.Owin.Security.dll)
Syntax
'Declaration
Public MustInherit Class AuthenticationHandler(Of TOptions As AuthenticationOptions) _
Inherits AuthenticationHandler
'Usage
Dim instance As AuthenticationHandler(Of TOptions)
public abstract class AuthenticationHandler<TOptions> : AuthenticationHandler
where TOptions : AuthenticationOptions
generic<typename TOptions>
where TOptions : AuthenticationOptions
public ref class AuthenticationHandler abstract : public AuthenticationHandler
[<AbstractClassAttribute>]
type AuthenticationHandler<'TOptions when 'TOptions : AuthenticationOptions> =
class
inherit AuthenticationHandler
end
JScript does not support generic types and methods.
Type Parameters
- TOptions
The type of options.
The AuthenticationHandler<TOptions> type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
.gif "Protected method") |
AuthenticationHandler<TOptions> | Initializes a new instance of the AuthenticationHandler<TOptions> class. |
Top
Properties
| Name | Description | |
|---|---|---|
.gif "Protected property") |
Context | (Inherited from AuthenticationHandler.) |
|
Helper | (Inherited from AuthenticationHandler.) |
|
Options | |
|
Request | (Inherited from AuthenticationHandler.) |
|
RequestPathBase | (Inherited from AuthenticationHandler.) |
|
Response | (Inherited from AuthenticationHandler.) |
Top
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.) |
.gif "Public method") |
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 | (Inherited from AuthenticationHandler.) |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
GenerateCorrelationId | (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 | (Inherited from AuthenticationHandler.) |
Top
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.