Issue 369: Change default behavior of an HTTP request

Src/GoogleApis/Apis/Services/BaseClientService.cs

 /*
 Copyright 2013 Google 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
@@ skipping 36 matching lines @@
 /// handler list.
 /// </summary>
 public abstract class BaseClientService : IClientService
 {
 /// <summary> The class logger. </summary>
 private static readonly ILogger Logger = ApplicationContext.Logger.ForTy
pe<BaseClientService>();
 
 #region Initializer
 
 /// <summary>·
- /// Indicates if exponential back-off is used automatically on exception
  in a service request and\or when 5xx·
+ /// Indicates if exponential back-off is used automatically on exception
  in a service request and\or when 503·
 /// response is returned form the server.
 /// </summary>
 [Flags]
 public enum ExponentialBackOffPolicy
 {
 None = 0,
 Exception = 1,
- UnsuccessfulResponse5xx = 2
+ UnsuccessfulResponse503 = 2
 }
 
 /// <summary> An initializer class for the client service. </summary>
 public class Initializer
 {
 /// <summary>·
 /// Gets or sets the factory for creating <see cref="System.Net.Http
.HttpClient"/> instance. If this·
 /// property is not set the service uses a new <see cref="Google.Api
s.Http.HttpClientFactory"/> instance.
 /// </summary>
 public IHttpClientFactory HttpClientFactory { get; set; }
 
 /// <summary>
 /// Gets or sets an Http client initializer which is able to customi
ze properties on·
 /// <see cref="Google.Apis.Http.ConfigurableHttpClient"/> and·
 /// <see cref="Google.Apis.Http.ConfigurableMessageHandler"/>.
 /// </summary>
 public IConfigurableHttpClientInitializer HttpClientInitializer { ge
t; set; }
 
 /// <summary>
- /// Gets or sets the exponential back-off policy used by the service
 . Default value is <c>Exception</c> |
- /// <c>UnsuccessfulResponse5xx</c>, which means that exponential bac
 k-off is used on any 5xx abnormal Http
- /// response and on any exception whose thrown when sending a reques
 t (except task canceled exception).
+ /// Get or sets the exponential back-off policy used by the service.
  Default value is·
+ /// <c>UnsuccessfulResponse503</c>, which means that exponential bac
 k-off is used on 503 abnormal HTTP
+ /// response.
 /// If the value is set to <c>None</c>, no exponential back-off poli
cy is used, and it's up to user to
 /// configure the <seealso cref="Google.Apis.Http.ConfigurableMessag
eHandler"/> in an
 /// <seealso cref="Google.Apis.Http.IConfigurableHttpClientInitializ
er"/> to set a specific back-off
 /// implementation (using <seealso cref="Google.Api.Http.BackOffHand
ler"/>).
 /// </summary>
 public ExponentialBackOffPolicy DefaultExponentialBackOffPolicy { ge
t; set; }
 
 /// <summary> Gets or sets whether this service supports GZip. Defau
lt value is <c>true</c>. </summary>
 public bool GZipEnabled { get; set; }
 
@@ skipping 15 matching lines @@
 /// Gets or sets Application name to be used in the User-Agent heade
r. Default value is <c>null</c>.·
 /// </summary>
 public string ApplicationName { get; set; }
 
 /// <summary> Constructs a new initializer with default values. </su
mmary>
 public Initializer()
 {
 GZipEnabled = true;
 Serializer = new NewtonsoftJsonSerializer();
 Authenticator = NullAuthenticator.Instance;
- DefaultExponentialBackOffPolicy = ExponentialBackOffPolicy.Excep
 tion |
- ExponentialBackOffPolicy.UnsuccessfulResponse5xx;
+ DefaultExponentialBackOffPolicy = ExponentialBackOffPolicy.Unsuc
 cessfulResponse503;
 }
 }
 
 /// <summary>
 /// An initializer which adds exponential back-off as exception handler
and\or unsuccessful response handler by
 /// the given <seealso cref="BaseClientService.ExponentialBackOffPolicy"
/>.
 /// </summary>
 private class ExponentialBackOffInitializer : IConfigurableHttpClientIni
tializer
 {
 private ExponentialBackOffPolicy Policy { get; set; }
@@ skipping 11 matching lines @@
 public void Initialize(ConfigurableHttpClient httpClient)
 {
 var backOff = CreateBackOff();
 
 // add exception handler and\or unsuccessful response handler
 if ((Policy & ExponentialBackOffPolicy.Exception) == Exponential
BackOffPolicy.Exception)
 {
 httpClient.MessageHandler.ExceptionHandlers.Add(backOff);
 }
 
- if ((Policy & ExponentialBackOffPolicy.UnsuccessfulResponse5xx) 
 ==
- ExponentialBackOffPolicy.UnsuccessfulResponse5xx)
+ if ((Policy & ExponentialBackOffPolicy.UnsuccessfulResponse503) 
 ==
+ ExponentialBackOffPolicy.UnsuccessfulResponse503)
 {
 httpClient.MessageHandler.UnsuccessfulResponseHandlers.Add(b
ackOff);
 }
 }
 }
 
 #endregion
 
 /// <summary> Constructs a new base client with the specified initialize
r. </summary>
 protected BaseClientService(Initializer initializer)
 {
 // sets the right properties by the initializer's properties
 GZipEnabled = initializer.GZipEnabled;
 Serializer = initializer.Serializer;
 ApiKey = initializer.ApiKey;
 Authenticator = initializer.Authenticator;
 ApplicationName = initializer.ApplicationName;
 if (ApplicationName == null)
 {
 Logger.Warning("Application name is not set. Please set Initiali
zer.ApplicationName property");
 }
 HttpClientInitializer = initializer.HttpClientInitializer;
 
 // create an Http client for this service
 HttpClient = CreateHttpClient(initializer);
 }
 
- /// <summary>
- /// Return true if this service contains the specified feature.
- /// </summary>
+ /// <summary> Return <c>true</c> if this service contains the specified 
 feature. </summary>
 private bool HasFeature(Features feature)
 {
 return Features.Contains(feature.GetStringValue());
 }
 
 private ConfigurableHttpClient CreateHttpClient(Initializer initializer)
 {
 // if factory wasn't set use the default Http client factory
 var factory = initializer.HttpClientFactory ?? new HttpClientFactory
();
 var args = new CreateHttpClientArgs
@@ skipping 212 matching lines @@
 
 public virtual void Dispose()
 {
 if (HttpClient != null)
 {
 HttpClient.Dispose();
 }
 }
 }
 }