Improved Exception inheritance chain and consistency

Redth · Redth · commit 8af0cc5bd512 · 2016-03-16T12:20:04.000-04:00
diff --git a/PushSharp.Amazon/AdmConnection.cs b/PushSharp.Amazon/AdmConnection.cs
@@ -95,7 +95,7 @@ public async Task Send (AdmNotification notification)
                 case HttpStatusCode.BadGateway: //400
                 case HttpStatusCode.BadRequest: //
                     if ("InvalidRegistrationId".Equals (reason, StringComparison.InvariantCultureIgnoreCase)) {
-                        throw new DeviceSubscriptonExpiredException {
+                        throw new DeviceSubscriptonExpiredException (notification) {
                             OldSubscriptionId = regId,
                             ExpiredAt = DateTime.UtcNow
                         };
diff --git a/PushSharp.Amazon/Exceptions.cs b/PushSharp.Amazon/Exceptions.cs
@@ -5,21 +5,25 @@ namespace PushSharp.Amazon
 {
     public class AdmRateLimitExceededException : NotificationException
     {
-        public AdmRateLimitExceededException (string reason, INotification notification) 
+        public AdmRateLimitExceededException (string reason, AdmNotification notification) 
             : base ("Rate Limit Exceeded (" + reason + ")", notification)
         {
+            Notification = notification;
             Reason = reason;
         }
 
+        public new AdmNotification Notification { get; set; }
         public string Reason { get; private set; }
     }
 
     public class AdmMessageTooLargeException : NotificationException 
     {
-        public AdmMessageTooLargeException (INotification notification) 
+        public AdmMessageTooLargeException (AdmNotification notification) 
             : base ("ADM Message too Large, must be <= 6kb", notification)
         {
+            Notification = notification;
         }
+
+        public new AdmNotification Notification { get; set; }
     }
 }
-
diff --git a/PushSharp.Apple/ApnsConfiguration.cs b/PushSharp.Apple/ApnsConfiguration.cs
@@ -108,19 +108,19 @@ void CheckIsApnsCertificate ()
                 var commonName = Certificate.SubjectName.Name;
 
                 if (!issuerName.Contains ("Apple"))
-                    throw new ApnsConnectionException ("Your Certificate does not appear to be issued by Apple!  Please check to ensure you have the correct certificate!");
+                    throw new ArgumentOutOfRangeException ("Your Certificate does not appear to be issued by Apple!  Please check to ensure you have the correct certificate!");
 
                 if (!Regex.IsMatch (commonName, "Apple.*?Push Services")
                     && !commonName.Contains ("Website Push ID:"))
-                    throw new ApnsConnectionException ("Your Certificate is not a valid certificate for connecting to Apple's APNS servers");
+                    throw new ArgumentOutOfRangeException ("Your Certificate is not a valid certificate for connecting to Apple's APNS servers");
 
                 if (commonName.Contains ("Development") && ServerEnvironment != ApnsServerEnvironment.Sandbox)
-                    throw new ApnsConnectionException ("You are using a certificate created for connecting only to the Sandbox APNS server but have selected a different server environment to connect to.");
+                    throw new ArgumentOutOfRangeException ("You are using a certificate created for connecting only to the Sandbox APNS server but have selected a different server environment to connect to.");
 
                 if (commonName.Contains ("Production") && ServerEnvironment != ApnsServerEnvironment.Production)
-                    throw new ApnsConnectionException ("You are using a certificate created for connecting only to the Production APNS server but have selected a different server environment to connect to.");
+                    throw new ArgumentOutOfRangeException ("You are using a certificate created for connecting only to the Production APNS server but have selected a different server environment to connect to.");
             } else {
-                throw new ApnsConnectionException ("You must provide a Certificate to connect to APNS with!");
+                throw new ArgumentOutOfRangeException ("You must provide a Certificate to connect to APNS with!");
             }
         }
 
diff --git a/PushSharp.Apple/ApnsConnection.cs b/PushSharp.Apple/ApnsConnection.cs
@@ -160,7 +160,7 @@ async Task SendBatch ()
             } catch (Exception ex) {
                 Log.Error ("APNS-CLIENT[{0}]: Send Batch Error: Batch ID={1}, Error={2}", id, batchId, ex);
                 foreach (var n in toSend)
-                    n.CompleteFailed (ex);
+                    n.CompleteFailed (new ApnsNotificationException (ApnsNotificationErrorStatusCode.ConnectionError, n.Notification, ex));
             }
 
             Log.Info ("APNS-Client[{0}]: Sent Batch, waiting for possible response...", id);
diff --git a/PushSharp.Apple/Exceptions.cs b/PushSharp.Apple/Exceptions.cs
@@ -1,4 +1,5 @@
 ﻿using System;
+using PushSharp.Core;
 
 namespace PushSharp.Apple
 {
@@ -14,24 +15,31 @@ public enum ApnsNotificationErrorStatusCode
         InvalidPayloadSize = 7,
         InvalidToken = 8,
         Shutdown = 10,
+        ConnectionError = 254,
         Unknown = 255
     }
 
-    public class ApnsNotificationException : Exception
+    public class ApnsNotificationException : NotificationException
     {
         public ApnsNotificationException(byte errorStatusCode, ApnsNotification notification)
             : this(ToErrorStatusCode(errorStatusCode), notification)
         { }
 
         public ApnsNotificationException (ApnsNotificationErrorStatusCode errorStatusCode, ApnsNotification notification)
-            : base ("Apns notification error: '" + errorStatusCode + "'")
+            : base ("Apns notification error: '" + errorStatusCode + "'", notification)
         {
             Notification = notification;
             ErrorStatusCode = errorStatusCode;
         }
 
-        public ApnsNotification Notification { get; set; }
+        public ApnsNotificationException (ApnsNotificationErrorStatusCode errorStatusCode, ApnsNotification notification, Exception innerException)
+            : base ("Apns notification error: '" + errorStatusCode + "'", notification, innerException)
+        {
+            Notification = notification;
+            ErrorStatusCode = errorStatusCode;
+        }
 
+        public new ApnsNotification Notification { get; set; }
         public ApnsNotificationErrorStatusCode ErrorStatusCode { get; private set; }
         
         private static ApnsNotificationErrorStatusCode ToErrorStatusCode(byte errorStatusCode)
diff --git a/PushSharp.Blackberry/BlackberryConnection.cs b/PushSharp.Blackberry/BlackberryConnection.cs
@@ -72,7 +72,7 @@ public async Task Send (BlackberryNotification notification)
             status.NotificationStatus = notStatus;
 
             if (status.NotificationStatus == BlackberryNotificationStatus.NoAppReceivePush)
-                throw new DeviceSubscriptonExpiredException ();
+                throw new DeviceSubscriptonExpiredException (notification);
 
             if (status.HttpStatus == HttpStatusCode.OK
                 && status.NotificationStatus == BlackberryNotificationStatus.RequestAcceptedForProcessing)
diff --git a/PushSharp.Blackberry/Exceptions.cs b/PushSharp.Blackberry/Exceptions.cs
@@ -9,9 +9,12 @@ public class BlackberryNotificationException : NotificationException
         public BlackberryNotificationException (BlackberryMessageStatus msgStatus, string desc, BlackberryNotification notification) 
             :base (desc + " - " + msgStatus, notification)
         {
+            Notification = notification;
             MessageStatus = msgStatus;
         }
 
+        public new BlackberryNotification Notification { get; set; }
+
         public BlackberryMessageStatus MessageStatus { get; private set; }
     }
 }
diff --git a/PushSharp.Core/Exceptions.cs b/PushSharp.Core/Exceptions.cs
@@ -1,10 +1,11 @@
 ﻿using System;
+using System.Collections.Generic;
 
 namespace PushSharp.Core
 {
-    public class DeviceSubscriptonExpiredException : Exception
+    public class DeviceSubscriptonExpiredException : NotificationException
     {
-        public DeviceSubscriptonExpiredException () : base ("Device Subscription has Expired")
+        public DeviceSubscriptonExpiredException (INotification notification) : base ("Device Subscription has Expired", notification)
         {
             ExpiredAt = DateTime.UtcNow;
         }
@@ -30,9 +31,9 @@ public NotificationException (string message, INotification notification, Except
         public INotification Notification { get; set; }
     }
 
-    public class RetryAfterException : Exception
+    public class RetryAfterException : NotificationException
     {
-        public RetryAfterException (string message, DateTime retryAfterUtc) : base (message)
+        public RetryAfterException (INotification notification, string message, DateTime retryAfterUtc) : base (message, notification)
         {
             RetryAfterUtc = retryAfterUtc;
         }
diff --git a/PushSharp.Firefox/Exceptions.cs b/PushSharp.Firefox/Exceptions.cs
@@ -0,0 +1,16 @@
+﻿using System;
+using PushSharp.Core;
+
+namespace PushSharp.Firefox
+{
+    public class FirefoxNotificationException : NotificationException
+    {
+        public FirefoxNotificationException (FirefoxNotification notification, string msg)
+            : base (msg, notification)
+        {
+            Notification = notification;
+        }
+
+        public new FirefoxNotification Notification { get; private set; }
+    }
+}
diff --git a/PushSharp.Firefox/FirefoxConnection.cs b/PushSharp.Firefox/FirefoxConnection.cs
@@ -43,7 +43,7 @@ public async Task Send (FirefoxNotification notification)
             var result = await http.PutAsync (notification.EndPointUrl, new StringContent (data));
 
             if (result.StatusCode != HttpStatusCode.OK && result.StatusCode != HttpStatusCode.NoContent) {
-                throw new NotificationException ("Notification Failed", notification);
+                throw new FirefoxNotificationException (notification, "HTTP Status: " + result.StatusCode);
             }
         }
     }
diff --git a/PushSharp.Firefox/PushSharp.Firefox.csproj b/PushSharp.Firefox/PushSharp.Firefox.csproj
@@ -38,6 +38,7 @@
     <Compile Include="FirefoxNotification.cs" />
     <Compile Include="FirefoxConnection.cs" />
     <Compile Include="FirefoxConfiguration.cs" />
+    <Compile Include="Exceptions.cs" />
   </ItemGroup>
   <Import Project="$(MSBuildBinPath)\Microsoft.CSharp.targets" />
   <ItemGroup>
diff --git a/PushSharp.Google/Exceptions.cs b/PushSharp.Google/Exceptions.cs
@@ -1,19 +1,23 @@
 ﻿using System;
 using System.Collections.Generic;
+using PushSharp.Core;
 
 namespace PushSharp.Google
 {
-    public class GcmConnectionException : Exception
+    public class GcmNotificationException : NotificationException
     {
-        public GcmConnectionException (string msg) : base (msg)
+        public GcmNotificationException (GcmNotification notification, string msg) : base (msg, notification)
         {
+            Notification = notification;
         }
 
-        public GcmConnectionException (string msg, string description) : base (msg)
+        public GcmNotificationException (GcmNotification notification, string msg, string description) : base (msg, notification)
         {
+            Notification = notification;
             Description = description;
         }
 
+        public new GcmNotification Notification { get; private set; }
         public string Description { get; private set; }
     }
 
diff --git a/PushSharp.Google/GcmServiceConnection.cs b/PushSharp.Google/GcmServiceConnection.cs
@@ -126,12 +126,13 @@ async Task processResponseOk (HttpResponseMessage httpResponse, GcmNotification
                         oldRegistrationId = singleResultNotification.To;
                     }
 
-                    multicastResult.Failed.Add (singleResultNotification, new DeviceSubscriptonExpiredException {
-                        OldSubscriptionId = oldRegistrationId,
-                        NewSubscriptionId = newRegistrationId
-                    });
+                    multicastResult.Failed.Add (singleResultNotification, 
+                        new DeviceSubscriptonExpiredException (singleResultNotification) {
+                            OldSubscriptionId = oldRegistrationId,
+                            NewSubscriptionId = newRegistrationId
+                        });
                 } else if (r.ResponseStatus == GcmResponseStatus.Unavailable) { // Unavailable
-                    multicastResult.Failed.Add (singleResultNotification, new GcmConnectionException ("Unavailable Response Status"));
+                    multicastResult.Failed.Add (singleResultNotification, new GcmNotificationException (singleResultNotification, "Unavailable Response Status"));
                 } else if (r.ResponseStatus == GcmResponseStatus.NotRegistered) { //Bad registration Id
                     var oldRegistrationId = string.Empty;
 
@@ -144,9 +145,11 @@ async Task processResponseOk (HttpResponseMessage httpResponse, GcmNotification
                         oldRegistrationId = singleResultNotification.To;
                     }   
 
-                    multicastResult.Failed.Add (singleResultNotification, new DeviceSubscriptonExpiredException { OldSubscriptionId = oldRegistrationId });
+                    multicastResult.Failed.Add (singleResultNotification, 
+                                                new DeviceSubscriptonExpiredException (singleResultNotification) { 
+                                                    OldSubscriptionId = oldRegistrationId });
                 } else {
-                    multicastResult.Failed.Add (singleResultNotification, new GcmConnectionException ("Unknown Failure: " + r.ResponseStatus));
+                    multicastResult.Failed.Add (singleResultNotification, new GcmNotificationException (singleResultNotification, "Unknown Failure: " + r.ResponseStatus));
                 }
 
                 index++;
@@ -180,19 +183,19 @@ async Task processResponseError (HttpResponseMessage httpResponse, GcmNotificati
                 throw new UnauthorizedAccessException ("GCM Authorization Failed");
 
             if (httpResponse.StatusCode == HttpStatusCode.BadRequest)
-                throw new GcmConnectionException ("HTTP 400 Bad Request", responseBody);
+                throw new GcmNotificationException (notification, "HTTP 400 Bad Request", responseBody);
 
             if ((int)httpResponse.StatusCode >= 500 && (int)httpResponse.StatusCode < 600) {
                 //First try grabbing the retry-after header and parsing it.
                 var retryAfterHeader = httpResponse.Headers.RetryAfter;
 
                 if (retryAfterHeader != null && retryAfterHeader.Delta.HasValue) {
                     var retryAfter = retryAfterHeader.Delta.Value;
-                    throw new RetryAfterException ("GCM Requested Backoff", DateTime.UtcNow + retryAfter);
+                    throw new RetryAfterException (notification, "GCM Requested Backoff", DateTime.UtcNow + retryAfter);
                 }                  
             }
 
-            throw new GcmConnectionException ("GCM HTTP Error: " + httpResponse.StatusCode, responseBody);           
+            throw new GcmNotificationException (notification, "GCM HTTP Error: " + httpResponse.StatusCode, responseBody);           
         }
 
         static GcmResponseStatus GetGcmResponseStatus (string str)
diff --git a/PushSharp.Windows/Exceptions.cs b/PushSharp.Windows/Exceptions.cs
@@ -1,8 +1,9 @@
 ﻿using System;
+using PushSharp.Core;
 
 namespace PushSharp.Windows
 {
-    public class WnsNotificationException : PushSharp.Core.NotificationException
+    public class WnsNotificationException : NotificationException
     {
         public WnsNotificationException (WnsNotificationStatus status) : base (status.ErrorDescription, status.Notification) 
         {
diff --git a/PushSharp.Windows/WnsConnection.cs b/PushSharp.Windows/WnsConnection.cs
@@ -134,12 +134,12 @@ public async Task Send (WnsNotification notification)
             //401
             if (status.HttpStatus == HttpStatusCode.Unauthorized) {
                 AccessTokenManager.InvalidateAccessToken (accessToken);
-                throw new RetryAfterException ("Access token expired", DateTime.UtcNow.AddSeconds (5));
+                throw new RetryAfterException (notification, "Access token expired", DateTime.UtcNow.AddSeconds (5));
             }
 
             //404 or 410
             if (status.HttpStatus == HttpStatusCode.NotFound || status.HttpStatus == HttpStatusCode.Gone) { 
-                throw new DeviceSubscriptonExpiredException {
+                throw new DeviceSubscriptonExpiredException (notification) {
                     OldSubscriptionId = notification.ChannelUri,
                     ExpiredAt = DateTime.UtcNow
                 };

Original file line number	Diff line number	Diff line change
`@@ -5,21 +5,25 @@ namespace PushSharp.Amazon`
`5`	`5`	`{`
`6`	`6`	`public class AdmRateLimitExceededException : NotificationException`
`7`	`7`	`{`
`8`		`- public AdmRateLimitExceededException (string reason, INotification notification)`
	`8`	`+ public AdmRateLimitExceededException (string reason, AdmNotification notification)`
`9`	`9`	`: base ("Rate Limit Exceeded (" + reason + ")", notification)`
`10`	`10`	`{`
	`11`	`+ Notification = notification;`
`11`	`12`	`Reason = reason;`
`12`	`13`	`}`
`13`	`14`
	`15`	`+ public new AdmNotification Notification { get; set; }`
`14`	`16`	`public string Reason { get; private set; }`
`15`	`17`	`}`
`16`	`18`
`17`	`19`	`public class AdmMessageTooLargeException : NotificationException`
`18`	`20`	`{`
`19`		`- public AdmMessageTooLargeException (INotification notification)`
	`21`	`+ public AdmMessageTooLargeException (AdmNotification notification)`
`20`	`22`	`: base ("ADM Message too Large, must be <= 6kb", notification)`
`21`	`23`	`{`
	`24`	`+ Notification = notification;`
`22`	`25`	`}`
	`26`	`+`
	`27`	`+ public new AdmNotification Notification { get; set; }`
`23`	`28`	`}`
`24`	`29`	`}`
`25`		`-`
Original file line number	Diff line number	Diff line change
`@@ -160,7 +160,7 @@ async Task SendBatch ()`
`160`	`160`	`} catch (Exception ex) {`
`161`	`161`	`Log.Error ("APNS-CLIENT[{0}]: Send Batch Error: Batch ID={1}, Error={2}", id, batchId, ex);`
`162`	`162`	`foreach (var n in toSend)`
`163`		`- n.CompleteFailed (ex);`
	`163`	`+ n.CompleteFailed (new ApnsNotificationException (ApnsNotificationErrorStatusCode.ConnectionError, n.Notification, ex));`
`164`	`164`	`}`
`165`	`165`
`166`	`166`	`Log.Info ("APNS-Client[{0}]: Sent Batch, waiting for possible response...", id);`
Original file line number	Diff line number	Diff line change
`@@ -9,9 +9,12 @@ public class BlackberryNotificationException : NotificationException`
`9`	`9`	`public BlackberryNotificationException (BlackberryMessageStatus msgStatus, string desc, BlackberryNotification notification)`
`10`	`10`	`:base (desc + " - " + msgStatus, notification)`
`11`	`11`	`{`
	`12`	`+ Notification = notification;`
`12`	`13`	`MessageStatus = msgStatus;`
`13`	`14`	`}`
`14`	`15`
	`16`	`+ public new BlackberryNotification Notification { get; set; }`
	`17`	`+`
`15`	`18`	`public BlackberryMessageStatus MessageStatus { get; private set; }`
`16`	`19`	`}`
`17`	`20`	`}`
Original file line number	Diff line number	Diff line change
`@@ -1,10 +1,11 @@`
`1`	`1`	`using System;`
	`2`	`+using System.Collections.Generic;`
`2`	`3`
`3`	`4`	`namespace PushSharp.Core`
`4`	`5`	`{`
`5`		`- public class DeviceSubscriptonExpiredException : Exception`
	`6`	`+ public class DeviceSubscriptonExpiredException : NotificationException`
`6`	`7`	`{`
`7`		`- public DeviceSubscriptonExpiredException () : base ("Device Subscription has Expired")`
	`8`	`+ public DeviceSubscriptonExpiredException (INotification notification) : base ("Device Subscription has Expired", notification)`
`8`	`9`	`{`
`9`	`10`	`ExpiredAt = DateTime.UtcNow;`
`10`	`11`	`}`
`@@ -30,9 +31,9 @@ public NotificationException (string message, INotification notification, Except`
`30`	`31`	`public INotification Notification { get; set; }`
`31`	`32`	`}`
`32`	`33`
`33`		`- public class RetryAfterException : Exception`
	`34`	`+ public class RetryAfterException : NotificationException`
`34`	`35`	`{`
`35`		`- public RetryAfterException (string message, DateTime retryAfterUtc) : base (message)`
	`36`	`+ public RetryAfterException (INotification notification, string message, DateTime retryAfterUtc) : base (message, notification)`
`36`	`37`	`{`
`37`	`38`	`RetryAfterUtc = retryAfterUtc;`
`38`	`39`	`}`
Original file line number	Diff line number	Diff line change
`@@ -43,7 +43,7 @@ public async Task Send (FirefoxNotification notification)`
`43`	`43`	`var result = await http.PutAsync (notification.EndPointUrl, new StringContent (data));`
`44`	`44`
`45`	`45`	`if (result.StatusCode != HttpStatusCode.OK && result.StatusCode != HttpStatusCode.NoContent) {`
`46`		`- throw new NotificationException ("Notification Failed", notification);`
	`46`	`+ throw new FirefoxNotificationException (notification, "HTTP Status: " + result.StatusCode);`
`47`	`47`	`}`
`48`	`48`	`}`
`49`	`49`	`}`