-
Notifications
You must be signed in to change notification settings - Fork 1.2k
/
CommandOperationBase.cs
270 lines (253 loc) · 9.58 KB
/
CommandOperationBase.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
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
/* 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.Bson.IO;
using MongoDB.Bson.Serialization;
using MongoDB.Driver.Core.Bindings;
using MongoDB.Driver.Core.Misc;
using MongoDB.Driver.Core.WireProtocol;
using MongoDB.Driver.Core.WireProtocol.Messages.Encoders;
namespace MongoDB.Driver.Core.Operations
{
/// <summary>
/// Represents the base class for a command operation.
/// </summary>
/// <typeparam name="TCommandResult">The type of the command result.</typeparam>
public abstract class CommandOperationBase<TCommandResult>
{
// fields
private BsonDocument _additionalOptions;
private BsonDocument _command;
private IElementNameValidator _commandValidator = NoOpElementNameValidator.Instance;
private string _comment;
private DatabaseNamespace _databaseNamespace;
private MessageEncoderSettings _messageEncoderSettings;
private IBsonSerializer<TCommandResult> _resultSerializer;
// constructors
/// <summary>
/// Initializes a new instance of the <see cref="CommandOperationBase{TCommandResult}"/> class.
/// </summary>
/// <param name="databaseNamespace">The database namespace.</param>
/// <param name="command">The command.</param>
/// <param name="resultSerializer">The result serializer.</param>
/// <param name="messageEncoderSettings">The message encoder settings.</param>
protected CommandOperationBase(
DatabaseNamespace databaseNamespace,
BsonDocument command,
IBsonSerializer<TCommandResult> resultSerializer,
MessageEncoderSettings messageEncoderSettings)
{
_databaseNamespace = Ensure.IsNotNull(databaseNamespace, nameof(databaseNamespace));
_command = Ensure.IsNotNull(command, nameof(command));
_resultSerializer = Ensure.IsNotNull(resultSerializer, nameof(resultSerializer));
_messageEncoderSettings = messageEncoderSettings;
}
// properties
/// <summary>
/// Gets or sets the additional options.
/// </summary>
/// <value>
/// The additional options.
/// </value>
public BsonDocument AdditionalOptions
{
get { return _additionalOptions; }
set { _additionalOptions = value; }
}
/// <summary>
/// Gets the command.
/// </summary>
/// <value>
/// The command.
/// </value>
public BsonDocument Command
{
get { return _command; }
}
/// <summary>
/// Gets or sets the command validator.
/// </summary>
/// <value>
/// The command validator.
/// </value>
public IElementNameValidator CommandValidator
{
get { return _commandValidator; }
set { _commandValidator = Ensure.IsNotNull(value, nameof(value)); }
}
/// <summary>
/// Gets or sets the comment.
/// </summary>
/// <value>
/// The comment.
/// </value>
public string Comment
{
get { return _comment; }
set { _comment = value; }
}
/// <summary>
/// Gets the database namespace.
/// </summary>
/// <value>
/// The database namespace.
/// </value>
public DatabaseNamespace DatabaseNamespace
{
get { return _databaseNamespace; }
}
/// <summary>
/// Gets the message encoder settings.
/// </summary>
/// <value>
/// The message encoder settings.
/// </value>
public MessageEncoderSettings MessageEncoderSettings
{
get { return _messageEncoderSettings; }
}
/// <summary>
/// Gets the result serializer.
/// </summary>
/// <value>
/// The result serializer.
/// </value>
public IBsonSerializer<TCommandResult> ResultSerializer
{
get { return _resultSerializer; }
}
// methods
/// <summary>
/// Executes the protocol.
/// </summary>
/// <param name="channel">The channel.</param>
/// <param name="session">The session.</param>
/// <param name="readPreference">The read preference.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// A Task whose result is the command result.
/// </returns>
protected TCommandResult ExecuteProtocol(IChannelHandle channel, ICoreSessionHandle session, ReadPreference readPreference, CancellationToken cancellationToken)
{
var additionalOptions = GetEffectiveAdditionalOptions();
return channel.Command(
session,
readPreference,
_databaseNamespace,
_command,
null, // commandPayloads
_commandValidator,
additionalOptions,
null, // postWriteAction,
CommandResponseHandling.Return,
_resultSerializer,
_messageEncoderSettings,
cancellationToken);
}
/// <summary>
/// Executes the protocol.
/// </summary>
/// <param name="channelSource">The channel source.</param>
/// <param name="session">The session.</param>
/// <param name="readPreference">The read preference.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// A Task whose result is the command result.
/// </returns>
protected TCommandResult ExecuteProtocol(
IChannelSource channelSource,
ICoreSessionHandle session,
ReadPreference readPreference,
CancellationToken cancellationToken)
{
using (var channel = channelSource.GetChannel(cancellationToken))
{
return ExecuteProtocol(channel, session, readPreference, cancellationToken);
}
}
/// <summary>
/// Executes the protocol.
/// </summary>
/// <param name="channel">The channel.</param>
/// <param name="session">The session.</param>
/// <param name="readPreference">The read preference.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// A Task whose result is the command result.
/// </returns>
protected Task<TCommandResult> ExecuteProtocolAsync(IChannelHandle channel, ICoreSessionHandle session, ReadPreference readPreference, CancellationToken cancellationToken)
{
var additionalOptions = GetEffectiveAdditionalOptions();
return channel.CommandAsync(
session,
readPreference,
_databaseNamespace,
_command,
null, // TODO: support commandPayloads
_commandValidator,
additionalOptions,
null, // postWriteAction,
CommandResponseHandling.Return,
_resultSerializer,
_messageEncoderSettings,
cancellationToken);
}
/// <summary>
/// Executes the protocol.
/// </summary>
/// <param name="channelSource">The channel source.</param>
/// <param name="session">The session.</param>
/// <param name="readPreference">The read preference.</param>
/// <param name="cancellationToken">The cancellation token.</param>
/// <returns>
/// A Task whose result is the command result.
/// </returns>
protected async Task<TCommandResult> ExecuteProtocolAsync(
IChannelSource channelSource,
ICoreSessionHandle session,
ReadPreference readPreference,
CancellationToken cancellationToken)
{
using (var channel = await channelSource.GetChannelAsync(cancellationToken).ConfigureAwait(false))
{
return await ExecuteProtocolAsync(channel, session, readPreference, cancellationToken).ConfigureAwait(false);
}
}
// private methods
private BsonDocument GetEffectiveAdditionalOptions()
{
if (_additionalOptions == null && _comment == null)
{
return null;
}
else if (_additionalOptions != null && _comment == null)
{
return _additionalOptions;
}
else if (_additionalOptions == null && _comment != null)
{
return new BsonDocument("$comment", _comment);
}
else
{
var additionalOptions = new BsonDocument("$comment", _comment);
additionalOptions.Merge(_additionalOptions, overwriteExistingElements: false);
return additionalOptions;
}
}
}
}