• Share
    • Twitter
    • LinkedIn
    • Facebook
    • Email
  • Feedback
  • Improve this Doc

Class BasicAuthMessageHandler

Basic authentication message handler.

Inheritance
System.Object
AuthMessageHandlerBase
BasicAuthMessageHandler
Inherited Members
AuthMessageHandlerBase.BypassAntiForgeryToken
AuthMessageHandlerBase.DefaultInclude
AuthMessageHandlerBase.ForceSsl
AuthMessageHandlerBase.IsXmlHttpRequest(HttpRequestMessage)
AuthMessageHandlerBase.SetCurrentPrincipal(IPrincipal, HttpRequestMessage)
AuthMessageHandlerBase.SendAsync(HttpRequestMessage, CancellationToken)
AuthMessageHandlerBase.NeedsAuthentication(HttpRequestMessage)
Namespace: DotNetNuke.Web.Api.Auth
Assembly: DotNetNuke.Web.dll
Syntax
public class BasicAuthMessageHandler : AuthMessageHandlerBase

Constructors

| Improve this Doc View Source

BasicAuthMessageHandler(Boolean, Boolean)

Initializes a new instance of the BasicAuthMessageHandler class.

Declaration
public BasicAuthMessageHandler(bool includeByDefault, bool forceSsl)
Parameters
Type Name Description
System.Boolean includeByDefault

Should this handler be included by default on all routes.

System.Boolean forceSsl

Should this handler enforce SSL usage.

Properties

| Improve this Doc View Source

AuthScheme

Gets the name of the authentication scheme.

Declaration
public override string AuthScheme { get; }
Property Value
Type Description
System.String
Overrides
AuthMessageHandlerBase.AuthScheme

Methods

| Improve this Doc View Source

OnInboundRequest(HttpRequestMessage, CancellationToken)

A chance to process inbound requests.

Declaration
public override HttpResponseMessage OnInboundRequest(HttpRequestMessage request, CancellationToken cancellationToken)
Parameters
Type Name Description
HttpRequestMessage request

The request message.

CancellationToken cancellationToken

A cancellationtoken.

Returns
Type Description
HttpResponseMessage

null normally, if a response is returned all inbound processing is terminated and the resposne is returned.

Overrides
AuthMessageHandlerBase.OnInboundRequest(HttpRequestMessage, CancellationToken)
| Improve this Doc View Source

OnOutboundResponse(HttpResponseMessage, CancellationToken)

A change to process outbound responses.

Declaration
public override HttpResponseMessage OnOutboundResponse(HttpResponseMessage response, CancellationToken cancellationToken)
Parameters
Type Name Description
HttpResponseMessage response

The response message.

CancellationToken cancellationToken

A cancellationtoken.

Returns
Type Description
HttpResponseMessage

The responsemessage.

Overrides
AuthMessageHandlerBase.OnOutboundResponse(HttpResponseMessage, CancellationToken)

Extension Methods

JsonExtensionsWeb.ToJson(Object)
  • View Source
Back to top by the community, for the community... #DNNCMS