-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
IAuthenticator.cs
61 lines (56 loc) · 2.32 KB
/
IAuthenticator.cs
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
/* Copyright 2013-present MongoDB Inc.
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
using System.Threading;
using System.Threading.Tasks;
using MongoDB.Bson;
using MongoDB.Driver.Core.Connections;
namespace MongoDB.Driver.Core.Authentication
{
/// <summary>
/// Represents a connection authenticator.
/// </summary>
public interface IAuthenticator
{
/// <summary>
/// Gets the name of the authenticator.
/// </summary>
/// <value>
/// The name.
/// </value>
string Name { get; }
/// <summary>
/// Authenticates the connection.
/// </summary>
/// <param name="connection">The connection.</param>
/// <param name="description">The connection description.</param>
/// <param name="cancellationToken">The cancellation token.</param>
void Authenticate(IConnection connection, ConnectionDescription description, CancellationToken cancellationToken);
/// <summary>
/// Authenticates the connection.
/// </summary>
/// <param name="connection">The connection.</param>
/// <param name="description">The connection description.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>A Task.</returns>
Task AuthenticateAsync(IConnection connection, ConnectionDescription description, CancellationToken cancellationToken);
/// <summary>
/// Optionally customizes hello or legacy hello command.
/// </summary>
/// <param name="helloCommand">Initial command.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>Optionally mutated command.</returns>
BsonDocument CustomizeInitialHelloCommand(BsonDocument helloCommand, CancellationToken cancellationToken);
}
}