/
BaseRestService.cs
579 lines (520 loc) · 25.4 KB
/
BaseRestService.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
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
using System.Threading;
using System.Threading.Tasks;
using Windows.Storage.Streams;
using Windows.Web.Http;
using Windows.Web.Http.Filters;
using JetBrains.Annotations;
using Kulman.WPA81.BaseRestService.Services.Exceptions;
using Newtonsoft.Json;
using Newtonsoft.Json.Converters;
using Newtonsoft.Json.Serialization;
namespace Kulman.WPA81.BaseRestService.Services.Abstract
{
/// <summary>
/// Base class for JSON based REST services
/// </summary>
public abstract class BaseRestService
{
/// <summary>
/// Http filter
/// </summary>
[NotNull]
private readonly HttpBaseProtocolFilter _filter;
/// <summary>
/// Cookie manager
/// </summary>
[NotNull]
protected HttpCookieManager CookieManager => _filter.CookieManager;
/// <summary>
/// Logger
/// </summary>
[CanBeNull]
protected ILogger Logger;
/// <summary>
/// Ctor, creates Http filter
/// </summary>
protected BaseRestService()
{
_filter = CreateHttpFilter();
}
/// <summary>
/// Must be overridden to set the Base URL
/// </summary>
/// <returns>Base URL</returns>
protected abstract string GetBaseUrl();
/// <summary>
/// Executed before every request
/// </summary>
/// <param name="url">Url</param>
/// <param name="token">Cancellation token</param>
/// <returns>Task</returns>
protected virtual Task OnBeforeRequest([NotNull] string url, CancellationToken token)
{
return Task.FromResult(1);
}
/// <summary>
/// Can be overriden to set the default request headers
/// </summary>
/// <returns>Dictionary containing default request headers</returns>
protected virtual Dictionary<string, string> GetRequestHeaders([NotNull] string requestUrl)
{
return new Dictionary<string, string>();
}
#region HTTP GET
/// <summary>
/// REST Get
/// </summary>
/// <param name="url">Url</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Get<T>([NotNull] string url)
{
return GetResponse<T>(url, HttpMethod.Get, null, CancellationToken.None);
}
/// <summary>
/// REST Get
/// </summary>
/// <param name="url">Url</param>
/// <param name="token">Cancellation token</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Get<T>([NotNull] string url, CancellationToken token)
{
return GetResponse<T>(url, HttpMethod.Get, null, token);
}
/// <summary>
/// REST Get (RAW)
/// </summary>
/// <param name="url">Url</param>
/// <returns>HttpResponseMessage</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
protected Task<HttpResponseMessage> Get([NotNull] string url)
{
return GetRawResponse(url, HttpMethod.Get, null, CancellationToken.None);
}
/// <summary>
/// REST Get (RAW)
/// </summary>
/// <param name="url">Url</param>
/// <param name="token">Cancellation token</param>
/// <returns>HttpResponseMessage</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
protected Task<HttpResponseMessage> Get([NotNull] string url, CancellationToken token)
{
return GetRawResponse(url, HttpMethod.Get, null, token);
}
#endregion
#region HTTP DELETE
/// <summary>
/// REST Delete
/// </summary>
/// <param name="url">Url</param>
/// <returns>Task</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
protected Task Delete([NotNull] string url)
{
return GetResponse(url, HttpMethod.Delete, null, CancellationToken.None);
}
/// <summary>
/// REST Delete
/// </summary>
/// <param name="url">Url</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Delete<T>([NotNull] string url)
{
return GetResponse<T>(url, HttpMethod.Delete, null, CancellationToken.None);
}
/// <summary>
/// REST Delete
/// </summary>
/// <param name="url">Url</param>
/// <param name="token">Cancellation token</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Delete<T>([NotNull] string url, CancellationToken token)
{
return GetResponse<T>(url, HttpMethod.Delete, null, token);
}
/// <summary>
/// REST Delete
/// </summary>
/// <param name="url">Url</param>
/// <param name="token">Cancellation token</param>
/// <returns>Task</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
protected Task Delete([NotNull] string url, CancellationToken token)
{
return GetResponse(url, HttpMethod.Delete, null, token);
}
#endregion
#region HTTP PUT
/// <summary>
/// REST Put
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Put<T>([NotNull] string url, [CanBeNull] object request)
{
return GetResponse<T>(url, HttpMethod.Put, request, CancellationToken.None);
}
/// <summary>
/// REST Put
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <param name="token">Cancellation token</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Put<T>([NotNull] string url, [CanBeNull] object request, CancellationToken token)
{
return GetResponse<T>(url, HttpMethod.Put, request, token);
}
/// <summary>
/// REST Put (RAW)
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <returns>HttpResponseMessage</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
protected Task<HttpResponseMessage> Put([NotNull] string url, [CanBeNull] object request)
{
return GetRawResponse(url, HttpMethod.Put, request, CancellationToken.None);
}
/// <summary>
/// REST Put (RAW)
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <param name="token">Cancellation token</param>
/// <returns>HttpResponseMessage</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
protected Task<HttpResponseMessage> Put([NotNull] string url, [CanBeNull] object request, CancellationToken token)
{
return GetRawResponse(url, HttpMethod.Put, request, CancellationToken.None);
}
#endregion
#region HTTP POST
/// <summary>
/// REST Post
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <param name="token">Cancellation token</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Post<T>([NotNull] string url, [CanBeNull] object request, CancellationToken token)
{
return GetResponse<T>(url, HttpMethod.Post, request, token);
}
/// <summary>
/// REST Post
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Post<T>([NotNull] string url, [CanBeNull] object request)
{
return GetResponse<T>(url, HttpMethod.Post, request, CancellationToken.None);
}
/// <summary>
/// REST Post (RAW)
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <returns>HttpResponseMessage</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
protected Task<HttpResponseMessage> Post([NotNull] string url, [CanBeNull] object request)
{
return GetRawResponse(url, HttpMethod.Post, request, CancellationToken.None);
}
/// <summary>
/// REST Post (RAW)
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <param name="token">Cancellation token</param>
/// <returns>HttpResponseMessage</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
protected Task<HttpResponseMessage> Post([NotNull] string url, [CanBeNull] object request, CancellationToken token)
{
return GetRawResponse(url, HttpMethod.Post, request, token);
}
#endregion
#region HTTP PATCH
/// <summary>
/// REST Patch
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Patch<T>([NotNull] string url, [CanBeNull] object request)
{
return GetResponse<T>(url, new HttpMethod("PATCH"), request, CancellationToken.None);
}
/// <summary>
/// REST Patch
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <param name="token">Cancellation token</param>
/// <returns>Deserialized data of type T</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
protected Task<T> Patch<T>([NotNull] string url, [CanBeNull] object request, CancellationToken token)
{
return GetResponse<T>(url, new HttpMethod("PATCH"), request, token);
}
/// <summary>
/// REST Patch (RAW)
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <returns>HttpResponseMessage</returns>
protected Task<HttpResponseMessage> Patch([NotNull] string url, [CanBeNull] object request)
{
return GetRawResponse(url, new HttpMethod("PATCH"), request, CancellationToken.None);
}
/// <summary>
/// REST Patch (RAW)
/// </summary>
/// <param name="url">Url</param>
/// <param name="request">Request object (will be serialized to JSON if not string)</param>
/// <param name="token">Cancellation token</param>
/// <returns>HttpResponseMessage</returns>
protected Task<HttpResponseMessage> Patch([NotNull] string url, [CanBeNull] object request, CancellationToken token)
{
return GetRawResponse(url, new HttpMethod("PATCH"), request, CancellationToken.None);
}
#endregion
/// <summary>
/// Override if you need custom HttpClientHandler
/// </summary>
/// <returns>HttpClientHandler</returns>
protected virtual HttpBaseProtocolFilter CreateHttpFilter()
{
var handler = new HttpBaseProtocolFilter { AutomaticDecompression = true };
return handler;
}
/// <summary>
/// Creates a HTTP Client instance
/// </summary>
/// <param name="requestUrl">Request Url</param>
/// <returns>HttpClient</returns>
protected HttpClient CreateHttpClient([NotNull] string requestUrl)
{
var client = new HttpClient(_filter);
var headers = GetRequestHeaders(requestUrl);
foreach (var key in headers.Keys)
{
client.DefaultRequestHeaders.TryAppendWithoutValidation(key, headers[key]);
}
return client;
}
/// <summary>
/// Creates JSON serializer settings. Can be overridden.
/// </summary>
/// <returns>JSON serializer settings</returns>
protected virtual JsonSerializerSettings CreateJsonSerializerSettings()
{
var settings = new JsonSerializerSettings()
{
ContractResolver = new CamelCasePropertyNamesContractResolver(),
};
settings.Converters.Add(new StringEnumConverter());
return settings;
}
/// <summary>
/// Gets HTTP response
/// </summary>
/// <param name="url">Url</param>
/// <param name="method">HTTP Method</param>
/// <param name="request">HTTP request</param>
/// <param name="token">Cancellation token</param>
/// <returns>Task</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
private Task GetResponse([NotNull] string url, [NotNull] HttpMethod method, [CanBeNull] object request, CancellationToken token)
{
return GetResponse<Object>(url, method, request, token, true);
}
/// <summary>
/// Gets raw HTTP response
/// </summary>
/// <param name="url">Url</param>
/// <param name="method">HTTP Method</param>
/// <param name="request">HTTP request</param>
/// <param name="noOutput">Output will not be proceed when true, method return default(T)</param>
/// <param name="token">Cancellation token</param>
/// <returns>Task</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
private async Task<HttpResponseMessage> GetRawResponse([NotNull] string url, [NotNull] HttpMethod method, [CanBeNull] object request, CancellationToken token, bool noOutput = false)
{
await OnBeforeRequest(url, token).ConfigureAwait(false);
HttpResponseMessage data = null;
HttpStringContent requestcontent = null;
string requestBody = null;
var content = request as string;
if (content != null)
{
requestcontent = new HttpStringContent(content);
}
else if (request != null)
{
requestBody = JsonConvert.SerializeObject(request, CreateJsonSerializerSettings());
requestcontent = new HttpStringContent(requestBody, UnicodeEncoding.Utf8, "application/json");
}
try
{
var fullUrl = (new[] { "http://", "https://" }).Any(url.StartsWith) ? url : GetBaseUrl() + url;
var client = CreateHttpClient(fullUrl);
var requestMessage = new HttpRequestMessage
{
Method = method,
RequestUri = new Uri(fullUrl),
Content = requestcontent,
};
Logger?.Info($"{method} {fullUrl}"+ (requestBody != null ? "\r\n"+ requestBody : ""));
data = token == CancellationToken.None ? await client.SendRequestAsync(requestMessage, HttpCompletionOption.ResponseHeadersRead) : await client.SendRequestAsync(requestMessage, HttpCompletionOption.ResponseHeadersRead).AsTask(token);
return data;
}
catch (TaskCanceledException)
{
Logger?.Error("Requesting {url} cancelled");
throw;
}
catch (Exception ex)
{
Logger?.Error($"Error communicating with the server for {url}", ex);
throw new ConnectionException("Error communicating with the server. See the inner exception for details.", ex, data?.StatusCode ?? HttpStatusCode.ExpectationFailed, null);
}
}
/// <summary>
/// Gets HTTP response
/// </summary>
/// <param name="url">Url</param>
/// <param name="method">HTTP Method</param>
/// <param name="request">HTTP request</param>
/// <param name="token">Cancellation token</param>
/// <param name="noOutput">Output will not be proceed when true, method return default(T)</param>
/// <returns>Task</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
/// <exception cref="DeserializationException">When JSON parser cannot process the server response data</exception>
private async Task<T> GetResponse<T>([NotNull] string url, [NotNull] HttpMethod method, [CanBeNull] object request, CancellationToken token, bool noOutput = false)
{
T result;
var data = await GetRawResponse(url, method, request, token, noOutput);
try
{
data.EnsureSuccessStatusCode();
}
catch (Exception ex)
{
var content = await data.Content.ReadAsStringAsync();
data.Content?.Dispose();
Logger?.Error($"Error communicating with the server for {url}", ex);
throw new ConnectionException("Error communicating with the server. See the inner exception for details.", ex, data.StatusCode, content);
}
if (token != CancellationToken.None && token.IsCancellationRequested)
{
token.ThrowIfCancellationRequested();
}
var json = await data.Content.ReadAsStringAsync();
try
{
result = JsonConvert.DeserializeObject<T>(json);
}
catch (Exception ex)
{
Logger?.Error($"Error while processing response for {url}.", ex);
throw new DeserializationException("Error while processing response. See the inner exception for details.", ex, json);
}
if (token != CancellationToken.None && token.IsCancellationRequested)
{
token.ThrowIfCancellationRequested();
}
return result;
}
/// <summary>
/// REST Head
/// </summary>
/// <param name="url">Url</param>
/// <returns>Dictionary with headers</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
public Task<Dictionary<string, string>> Head([NotNull] string url)
{
return Head(url, CancellationToken.None);
}
/// <summary>
/// REST Head
/// </summary>
/// <param name="url">Url</param>
/// <param name="token">Cancellation token</param>
/// <returns>Dictionary with headers</returns>
/// <exception cref="TaskCanceledException">When operation cancelled</exception>
/// <exception cref="ConnectionException">When response from server does not indicate success</exception>
public async Task<Dictionary<string, string>> Head([NotNull] string url, CancellationToken token)
{
await OnBeforeRequest(url, token).ConfigureAwait(false);
try
{
Logger?.Info($"HEAD {GetBaseUrl() + url}");
var client = CreateHttpClient(GetBaseUrl() + url);
var request = new HttpRequestMessage(HttpMethod.Head, new Uri(GetBaseUrl() + url));
var response = await client.SendRequestAsync(request, HttpCompletionOption.ResponseHeadersRead);
if (token != CancellationToken.None && token.IsCancellationRequested)
{
token.ThrowIfCancellationRequested();
}
return response.Headers.ToDictionary(headerItem => headerItem.Key, headerItem => headerItem.Value);
}
catch (TaskCanceledException)
{
throw;
}
catch (Exception ex)
{
Logger?.Error($"Getting head for {url} failed", ex);
throw new ConnectionException("Error communicating with the server. See the inner exception for details.", ex, HttpStatusCode.ExpectationFailed, null);
}
}
}
}