Merge pull request #404 from paulomorgado/base-exception

Intorduced RabbitMQClientException as base classe for exceptions.

Author: michaelklishin

projects/client/RabbitMQ.Client/src/client/api/TopologyRecoveryException.cs

@@ -39,10 +39,11 @@
 //---------------------------------------------------------------------------
 
 using System;
+using RabbitMQ.Client.Exceptions;
 
 namespace RabbitMQ.Client
 {
-    public class TopologyRecoveryException : Exception
+    public class TopologyRecoveryException : RabbitMQClientException
     {
         public TopologyRecoveryException(string message, Exception cause) : base(message, cause)
         {

projects/client/RabbitMQ.Client/src/client/exceptions/ChannelAllocationException.cs

@@ -61,15 +61,15 @@ public ChannelAllocationException()
         /// </summary>
         /// <param name="channel">The requested channel number</param>
         public ChannelAllocationException(int channel)
-            : base(string.Format("The Requested Channel ({0}) is already in use.", channel))
+            : base($"The Requested Channel ({channel}) is already in use.")
         {
             Channel = channel;
         }
 
         ///<summary>Retrieves the channel number concerned; will
         ///return -1 in the case where "no more free channels" is
-        ///being signalled, or a non-negative integer when "channel is
-        ///in use" is being signalled.</summary>
+        ///being signaled, or a non-negative integer when "channel is
+        ///in use" is being signaled.</summary>
         public int Channel { get; private set; }
     }
 }

projects/client/RabbitMQ.Client/src/client/exceptions/OperationInterruptedException.cs

@@ -51,24 +51,22 @@ namespace RabbitMQ.Client.Exceptions
     /// </summary>
     public class OperationInterruptedException
         // TODO: inherit from OperationCanceledException
-        : Exception
+        : RabbitMQClientException
     {
         ///<summary>Construct an OperationInterruptedException with
         ///the passed-in explanation, if any.</summary>
         public OperationInterruptedException(ShutdownEventArgs reason)
             : base(reason == null ? "The AMQP operation was interrupted" :
-                string.Format("The AMQP operation was interrupted: {0}",
-                    reason))
+                $"The AMQP operation was interrupted: {reason}")
         {
             ShutdownReason = reason;
         }
 
         ///<summary>Construct an OperationInterruptedException with
         ///the passed-in explanation and prefix, if any.</summary>
         public OperationInterruptedException(ShutdownEventArgs reason, String prefix)
-            : base(reason == null ? (prefix + ": The AMQP operation was interrupted") :
-                string.Format("{0}: The AMQP operation was interrupted: {1}",
-                    prefix, reason))
+            : base(reason == null ? ($"{prefix}: The AMQP operation was interrupted") :
+                $"{prefix}: The AMQP operation was interrupted: {reason}")
         {
             ShutdownReason = reason;
         }

projects/client/RabbitMQ.Client/src/client/exceptions/PacketNotRecognizedException.cs

@@ -51,15 +51,14 @@ namespace RabbitMQ.Client.Exceptions
     ///The peer's {'A','M','Q','P',txHi,txLo,major,minor} packet is
     ///decoded into instances of this class.
     ///</remarks>
-    public class PacketNotRecognizedException : Exception
+    public class PacketNotRecognizedException : RabbitMQClientException
     {
         ///<summary>Fills the new instance's properties with the values passed in.</summary>
         public PacketNotRecognizedException(int transportHigh,
             int transportLow,
             int serverMajor,
             int serverMinor)
-            : base("AMQP server protocol version " + serverMajor + "-" + serverMinor +
-                   ", transport parameters " + transportHigh + ":" + transportLow)
+            : base($"AMQP server protocol version {serverMajor}-{serverMinor}, transport parameters {transportHigh}:{transportLow}")
         {
             TransportHigh = transportHigh;
             TransportLow = transportLow;

projects/client/RabbitMQ.Client/src/client/exceptions/PossibleAuthenticationFailureException.cs

@@ -44,7 +44,7 @@ namespace RabbitMQ.Client.Exceptions
 {
     /// <summary> Thrown when the likely cause is  an
     /// authentication failure. </summary>
-    public class PossibleAuthenticationFailureException : Exception
+    public class PossibleAuthenticationFailureException : RabbitMQClientException
     {
         public PossibleAuthenticationFailureException(String msg, Exception inner) : base(msg, inner)
         {

projects/client/RabbitMQ.Client/src/client/exceptions/ProtocolVersionMismatchException.cs

@@ -53,9 +53,7 @@ public ProtocolVersionMismatchException(int clientMajor,
             int clientMinor,
             int serverMajor,
             int serverMinor)
-            : base("AMQP server protocol negotiation failure: server version " +
-                   positiveOrUnknown(serverMajor) + "-" + positiveOrUnknown(serverMinor) +
-                   ", client version " + positiveOrUnknown(clientMajor) + "-" + positiveOrUnknown(clientMinor))
+            : base($"AMQP server protocol negotiation failure: server version {positiveOrUnknown(serverMajor)}-{positiveOrUnknown(serverMinor)}, client version {positiveOrUnknown(clientMajor)}-{positiveOrUnknown(clientMinor)}")
         {
             ClientMajor = clientMajor;
             ClientMinor = clientMinor;

projects/client/RabbitMQ.Client/src/client/exceptions/ProtocolViolationException.cs

@@ -38,14 +38,17 @@
 //  Copyright (c) 2007-2016 Pivotal Software, Inc.  All rights reserved.
 //---------------------------------------------------------------------------
 
+using System;
+using RabbitMQ.Client.Exceptions;
+
 namespace RabbitMQ.Client
 {
-    public class ProtocolViolationException : System.Exception
+    public class ProtocolViolationException : RabbitMQClientException
     {
         public ProtocolViolationException(string message) : base(message)
         {
         }
-        public ProtocolViolationException(string message, System.Exception inner) : base(message, inner)
+        public ProtocolViolationException(string message, Exception inner) : base(message, inner)
         {
         }
         public ProtocolViolationException() 

projects/client/RabbitMQ.Client/src/client/exceptions/RabbitMQClientException.cs

@@ -0,0 +1,83 @@
+// This source code is dual-licensed under the Apache License, version
+// 2.0, and the Mozilla Public License, version 1.1.
+//
+// The APL v2.0:
+//
+//---------------------------------------------------------------------------
+//   Copyright (c) 2007-2016 Pivotal Software, 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.
+//---------------------------------------------------------------------------
+//
+// The MPL v1.1:
+//
+//---------------------------------------------------------------------------
+//  The contents of this file are subject to the Mozilla Public License
+//  Version 1.1 (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.mozilla.org/MPL/
+//
+//  Software distributed under the License is distributed on an "AS IS"
+//  basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See
+//  the License for the specific language governing rights and
+//  limitations under the License.
+//
+//  The Original Code is RabbitMQ.
+//
+//  The Initial Developer of the Original Code is Pivotal Software, Inc.
+//  Copyright (c) 2007-2016 Pivotal Software, Inc.  All rights reserved.
+//---------------------------------------------------------------------------
+
+using System;
+
+namespace RabbitMQ.Client.Exceptions
+{
+    public abstract class RabbitMQClientException : Exception
+    {
+        /// <summary>Initializes a new instance of the <see cref="RabbitMQClientException" /> class.</summary>
+        protected RabbitMQClientException()
+        {
+
+        }
+
+        /// <summary>Initializes a new instance of the <see cref="RabbitMQClientException" /> class with a specified error message.</summary>
+        /// <param name="message">The message that describes the error. </param>
+        protected RabbitMQClientException(string message) : base(message)
+        {
+
+        }
+
+        /// <summary>Initializes a new instance of the <see cref="RabbitMQClientException" /> class with a specified error message and a reference to the inner exception that is the cause of this exception.</summary>
+        /// <param name="message">The error message that explains the reason for the exception. </param>
+        /// <param name="innerException">The exception that is the cause of the current exception, or a null reference (Nothing in Visual Basic) if no inner exception is specified. </param>
+        protected RabbitMQClientException(string message, Exception innerException) : base(message, innerException)
+        {
+
+        }
+
+/*
+#if !(NETFX_CORE)
+        /// <summary>Initializes a new instance of the <see cref="RabbitMQClientException" /> class with serialized data.</summary>
+        /// <param name="info">The <see cref="System.Runtime.Serialization.SerializationInfo" /> that holds the serialized object data about the exception being thrown. </param>
+        /// <param name="context">The <see cref="System.Runtime.Serialization.StreamingContext" /> that contains contextual information about the source or destination. </param>
+        /// <exception cref="System.ArgumentNullException">The <paramref name="info" /> parameter is null. </exception>
+        /// <exception cref="System.Runtime.Serialization.SerializationException">The class name is null or <see cref="System.Exception.HResult" /> is zero (0). </exception>
+        [System.Security.SecuritySafeCritical]
+        protected RabbitMQClientException(System.Runtime.Serialization.SerializationInfo info, System.Runtime.Serialization.StreamingContext context) : base(info, context)
+        {
+
+        }
+#endif
+*/
+    }
+}

projects/client/RabbitMQ.Client/src/client/impl/ChannelErrorException.cs

@@ -49,7 +49,7 @@ namespace RabbitMQ.Client.Impl
     public class ChannelErrorException : HardProtocolException
     {
         public ChannelErrorException(int channel)
-            : base(string.Format("Frame received for invalid channel {0}", channel))
+            : base($"Frame received for invalid channel {channel}")
         {
             Channel = channel;
         }

projects/client/RabbitMQ.Client/src/client/impl/ProtocolException.cs

@@ -40,14 +40,15 @@
 
 using System;
 using System.Net;
+using RabbitMQ.Client.Exceptions;
 
 namespace RabbitMQ.Client.Impl
 {
     /// <summary> Instances of subclasses of subclasses
     /// HardProtocolException and SoftProtocolException are thrown in
     /// situations when we detect a problem with the connection-,
     /// channel- or wire-level parts of the AMQP protocol. </summary>
-    public abstract class ProtocolException : Exception
+    public abstract class ProtocolException : RabbitMQClientException
     {
         protected ProtocolException(string message) : base(message)
         {