DefaultHttpContext Class

Reference

Definition

Namespace:: Microsoft.AspNetCore.Http

Assembly:: Microsoft.AspNetCore.Http.dll

Package:: Microsoft.AspNetCore.Http v1.0.0

Package:: Microsoft.AspNetCore.Http v1.1.0

Package:: Microsoft.AspNetCore.Http v2.0.0

Package:: Microsoft.AspNetCore.Http v2.1.0

Package:: Microsoft.AspNetCore.Http v2.2.0

Package:: Microsoft.AspNetCore.App.Ref v3.0.1

Package:: Microsoft.AspNetCore.App.Ref v3.1.10

Package:: Microsoft.AspNetCore.App.Ref v5.0.0

Package:: Microsoft.AspNetCore.App.Ref v6.0.6

Package:: Microsoft.AspNetCore.App.Ref v7.0.5

Package:: Microsoft.AspNetCore.App.Ref v8.0.0

Source:: DefaultHttpContext.cs

Source:: DefaultHttpContext.cs

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

Represents an implementation of the HTTP Context class.

public ref class DefaultHttpContext : Microsoft::AspNetCore::Http::HttpContext

public ref class DefaultHttpContext sealed : Microsoft::AspNetCore::Http::HttpContext

public class DefaultHttpContext : Microsoft.AspNetCore.Http.HttpContext

public sealed class DefaultHttpContext : Microsoft.AspNetCore.Http.HttpContext

type DefaultHttpContext = class
    inherit HttpContext

Public Class DefaultHttpContext
Inherits HttpContext

Public NotInheritable Class DefaultHttpContext
Inherits HttpContext

Inheritance: Object

HttpContext
DefaultHttpContext

Constructors

DefaultHttpContext()	Initializes a new instance of the DefaultHttpContext class.
DefaultHttpContext(IFeatureCollection)	Initializes a new instance of the DefaultHttpContext class with provided features.

Properties

Authentication	Obsolete. This is obsolete and will be removed in a future version. The recommended alternative is to use Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions. See https://go.microsoft.com/fwlink/?linkid=845470.
Authentication	Obsolete. This is obsolete and will be removed in a future version. The recommended alternative is to use Microsoft.AspNetCore.Authentication.AuthenticationHttpContextExtensions. See https://go.microsoft.com/fwlink/?linkid=845470. (Inherited from HttpContext)
Connection	Gets information about the underlying connection for this request.
Features	Gets the collection of HTTP features provided by the server and middleware available on this request.
FormOptions	Gets or set the FormOptions for this instance.
HttpContext	This API is used by ASP.NET Core's infrastructure and should not be used by application code.
Items	Gets or sets a key/value collection that can be used to share data within the scope of this request.
Request	Gets the HttpRequest object for this request.
RequestAborted	Notifies when the connection underlying this request is aborted and thus request operations should be cancelled.
RequestServices	Gets or sets the IServiceProvider that provides access to the request's service container.
Response	Gets the HttpResponse object for this request.
ServiceScopeFactory	Gets or sets the IServiceScopeFactory for this instance.
Session	Gets or sets the object used to manage user session data for this request.
TraceIdentifier	Gets or sets a unique identifier to represent this request in trace logs.
User	Gets or sets the user for this request.
WebSockets	Gets an object that manages the establishment of WebSocket connections for this request.

Methods

Abort()	Aborts the connection underlying this request.
Initialize(IFeatureCollection)	Reinitialize the current instant of the class with features passed in.
InitializeAuthenticationManager()
InitializeConnectionInfo()
InitializeHttpRequest()
InitializeHttpResponse()
InitializeWebSocketManager()
Uninitialize()	Uninitialize all the features in the DefaultHttpContext.
UninitializeAuthenticationManager(AuthenticationManager)
UninitializeConnectionInfo(ConnectionInfo)
UninitializeHttpRequest(HttpRequest)
UninitializeHttpResponse(HttpResponse)
UninitializeWebSocketManager(WebSocketManager)

Extension Methods

AuthenticateAsync(HttpContext)	Authenticate the current request using the default authentication scheme. The default authentication scheme can be configured using DefaultAuthenticateScheme.
AuthenticateAsync(HttpContext, String)	Authenticate the current request using the specified scheme.
ChallengeAsync(HttpContext)	Challenge the current request using the default challenge scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication. The default challenge scheme can be configured using DefaultChallengeScheme.
ChallengeAsync(HttpContext, AuthenticationProperties)	Challenge the current request using the default challenge scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication. The default challenge scheme can be configured using DefaultChallengeScheme.
ChallengeAsync(HttpContext, String)	Challenge the current request using the specified scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.
ChallengeAsync(HttpContext, String, AuthenticationProperties)	Challenge the current request using the specified scheme. An authentication challenge can be issued when an unauthenticated user requests an endpoint that requires authentication.
ForbidAsync(HttpContext)	Forbid the current request using the default forbid scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access. The default forbid scheme can be configured using DefaultForbidScheme.
ForbidAsync(HttpContext, AuthenticationProperties)	Forbid the current request using the default forbid scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access. The default forbid scheme can be configured using DefaultForbidScheme.
ForbidAsync(HttpContext, String)	Forbid the current request using the specified scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.
ForbidAsync(HttpContext, String, AuthenticationProperties)	Forbid the current request using the specified scheme. Forbid is used when an authenticated user attempts to access a resource they are not permitted to access.
GetTokenAsync(HttpContext, String)	Authenticates the request using the default authentication scheme and returns the value for the token. The default authentication scheme can be configured using DefaultAuthenticateScheme.
GetTokenAsync(HttpContext, String, String)	Authenticates the request using the specified scheme and returns the value for the token.
SignInAsync(HttpContext, ClaimsPrincipal)	Sign in a principal for the default authentication scheme. The default scheme for signing in can be configured using DefaultSignInScheme.
SignInAsync(HttpContext, ClaimsPrincipal, AuthenticationProperties)	Sign in a principal for the default authentication scheme. The default scheme for signing in can be configured using DefaultSignInScheme.
SignInAsync(HttpContext, String, ClaimsPrincipal)	Sign in a principal for the specified scheme.
SignInAsync(HttpContext, String, ClaimsPrincipal, AuthenticationProperties)	Sign in a principal for the specified scheme.
SignOutAsync(HttpContext)	Sign out a principal for the default authentication scheme. The default scheme for signing out can be configured using DefaultSignOutScheme.
SignOutAsync(HttpContext, AuthenticationProperties)	Sign out a principal for the default authentication scheme. The default scheme for signing out can be configured using DefaultSignOutScheme.
SignOutAsync(HttpContext, String)	Sign out a principal for the specified scheme.
SignOutAsync(HttpContext, String, AuthenticationProperties)	Sign out a principal for the specified scheme.
GetEndpoint(HttpContext)	Extension method for getting the Endpoint for the current request.
SetEndpoint(HttpContext, Endpoint)	Extension method for setting the Endpoint for the current request.
GetServerVariable(HttpContext, String)	Gets the value of a server variable for the current request.
GetHttpRequestMessage(HttpContext)
GetRouteData(HttpContext)	Gets the RouteData associated with the provided `httpContext`.
GetRouteValue(HttpContext, String)	Gets a route value from Values associated with the provided `httpContext`.
GetIISServerVariable(HttpContext, String)	Obsolete. Gets the value of a server variable for the current request.

Applies to