Class MongoDBCRAuthenticator

Namespace

MongoDB.Driver.Core.Authentication

Assembly

MongoDB.Driver.Core.dll

A MONGODB-CR authenticator. This authenticator was replaced by ScramSha1Authenticator in MongoDB 3.0, and is now deprecated.

[Obsolete("This authenticator was replaced by ScramSha1Authenticator in MongoDB 3.0, and is now deprecated.")]
public sealed class MongoDBCRAuthenticator : IAuthenticator

Inheritance

object

MongoDBCRAuthenticator

Implements

IAuthenticator

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

MongoDBCRAuthenticator(UsernamePasswordCredential)

Initializes a new instance of the MongoDBCRAuthenticator class.

public MongoDBCRAuthenticator(UsernamePasswordCredential credential)

Parameters

credential UsernamePasswordCredential

The credential.

MongoDBCRAuthenticator(UsernamePasswordCredential, ServerApi)

Initializes a new instance of the MongoDBCRAuthenticator class.

public MongoDBCRAuthenticator(UsernamePasswordCredential credential, ServerApi serverApi)

Parameters

credential UsernamePasswordCredential

The credential.

serverApi ServerApi

The server API.

Properties

MechanismName

Gets the name of the mechanism.

public static string MechanismName { get; }

Property Value

string

The name of the mechanism.

Name

Gets the name of the authenticator.

public string Name { get; }

Property Value

string

The name.

Methods

Authenticate(IConnection, ConnectionDescription, CancellationToken)

Authenticates the connection.

public void Authenticate(IConnection connection, ConnectionDescription description, CancellationToken cancellationToken)

Parameters

connection IConnection

The connection.

description ConnectionDescription

The connection description.

cancellationToken CancellationToken

The cancellation token.

AuthenticateAsync(IConnection, ConnectionDescription, CancellationToken)

Authenticates the connection.

public Task AuthenticateAsync(IConnection connection, ConnectionDescription description, CancellationToken cancellationToken)

Parameters

connection IConnection

The connection.

description ConnectionDescription

The connection description.

cancellationToken CancellationToken

The cancellation token.

Returns

Task

A Task.

CustomizeInitialHelloCommand(BsonDocument)

Optionally customizes hello or legacy hello command.

public BsonDocument CustomizeInitialHelloCommand(BsonDocument helloCommand)

Parameters

helloCommand BsonDocument

Initial command.

Returns

BsonDocument

Optionally mutated command.