Make auth failure an IO exception to avoid incompatibility

Author: Emile Joubert

src/com/rabbitmq/client/AuthenticationFailureException.java

@@ -20,7 +20,7 @@
  * Thrown when the broker refuses access due to an authentication failure.
  */
 
-public class AuthenticationFailureException extends Exception
+public class AuthenticationFailureException extends PossibleAuthenticationFailureException
 {
     public AuthenticationFailureException(String reason) {
         super(reason);

src/com/rabbitmq/client/ConnectionFactory.java

@@ -484,7 +484,7 @@ protected void configureSocket(Socket socket) throws IOException{
      * @return an interface to the connection
      * @throws IOException if it encounters a problem
      */
-    public Connection newConnection(Address[] addrs) throws IOException, AuthenticationFailureException {
+    public Connection newConnection(Address[] addrs) throws IOException {
         return newConnection(null, addrs);
     }
 
@@ -494,10 +494,10 @@ public Connection newConnection(Address[] addrs) throws IOException, Authenticat
      * @param addrs an array of known broker addresses (hostname/port pairs) to try in order
      * @return an interface to the connection
      * @throws IOException if it encounters a problem
-     * @throws AuthenticationFailureException if the login fails
      */
     public Connection newConnection(ExecutorService executor, Address[] addrs)
-            throws IOException, AuthenticationFailureException {
+        throws IOException
+    {
         IOException lastException = null;
         for (Address addr : addrs) {
             try {
@@ -528,9 +528,8 @@ public Connection newConnection(ExecutorService executor, Address[] addrs)
      * Create a new broker connection
      * @return an interface to the connection
      * @throws IOException if it encounters a problem
-     * @throws AuthenticationFailureException if the login fails
      */
-    public Connection newConnection() throws IOException, AuthenticationFailureException {
+    public Connection newConnection() throws IOException {
         return newConnection(null,
                              new Address[] {new Address(getHost(), getPort())}
                             );
@@ -541,9 +540,8 @@ public Connection newConnection() throws IOException, AuthenticationFailureExcep
      * @param executor thread execution service for consumers on the connection
      * @return an interface to the connection
      * @throws IOException if it encounters a problem
-     * @throws AuthenticationFailureException if the login fails
      */
-    public Connection newConnection(ExecutorService executor) throws IOException, AuthenticationFailureException {
+    public Connection newConnection(ExecutorService executor) throws IOException {
         return newConnection(executor,
                              new Address[] {new Address(getHost(), getPort())}
                             );

src/com/rabbitmq/client/PossibleAuthenticationFailureException.java

@@ -19,8 +19,7 @@
 import java.io.IOException;
 
 /**
- * Thrown when the likely cause is an authentication failure and the broker
- * communicates this by closing the connection.
+ * Thrown when the likely cause is an authentication failure.
  */
 public class PossibleAuthenticationFailureException extends IOException
 {
@@ -32,4 +31,9 @@ public PossibleAuthenticationFailureException(Throwable cause)
         super("Possibly caused by authentication failure");
         super.initCause(cause);
     }
+
+    public PossibleAuthenticationFailureException(String reason)
+    {
+        super(reason);
+    }
 }

src/com/rabbitmq/client/impl/AMQConnection.java

@@ -279,16 +279,16 @@ public AMQConnection(String username,
      * and frame max values after tuning has taken place.
      * @throws IOException if an error is encountered
      * either before, or during, protocol negotiation;
-     * @throws AuthenticationFailureException if the broker closes the
-     * connection with ACCESS_REFUSED.
      * sub-classes {@link ProtocolVersionMismatchException} and
      * {@link PossibleAuthenticationFailureException} will be thrown in the
-     * corresponding circumstances. If an exception is thrown, connection
-     * resources allocated can all be garbage collected when the connection
-     * object is no longer referenced.
+     * corresponding circumstances. {@link AuthenticationFailureException}
+     * will be thrown if the broker closes the connection with ACCESS_REFUSED.
+     * If an exception is thrown, connection resources allocated can all be
+     * garbage collected when the connection object is no longer referenced.
      */
     public void start()
-            throws IOException, AuthenticationFailureException {
+        throws IOException
+    {
         this._running = true;
         // Make sure that the first thing we do is to send the header,
         // which should cause any socket errors to show up for us, rather

test/src/com/rabbitmq/client/test/AMQConnectionTest.java

@@ -28,7 +28,6 @@
 import junit.framework.TestCase;
 import junit.framework.TestSuite;
 
-import com.rabbitmq.client.AuthenticationFailureException;
 import com.rabbitmq.client.Channel;
 import com.rabbitmq.client.Connection;
 import com.rabbitmq.client.ConnectionFactory;
@@ -82,7 +81,7 @@ public static TestSuite suite() {
     /** Check the AMQConnection does send exactly 1 initial header, and deal correctly with
      * the frame handler throwing an exception when we try to read data
      */
-    public void testConnectionSendsSingleHeaderAndTimesOut() throws AuthenticationFailureException {
+    public void testConnectionSendsSingleHeaderAndTimesOut() {
         IOException exception = new SocketTimeoutException();
         _mockFrameHandler.setExceptionOnReadingFrames(exception);
         MyExceptionHandler handler = new MyExceptionHandler();
@@ -125,7 +124,7 @@ public void testConnectionSendsSingleHeaderAndTimesOut() throws AuthenticationFa
     /**
      * Test that we catch timeout between connect and negotiation of the connection being finished.
      */
-    public void testConnectionHangInNegotiation() throws AuthenticationFailureException {
+    public void testConnectionHangInNegotiation() {
         this._mockFrameHandler.setTimeoutCount(10); // to limit hang
         MyExceptionHandler handler = new MyExceptionHandler();
         assertEquals(0, this._mockFrameHandler.countHeadersSent());

test/src/com/rabbitmq/client/test/BrokerTestCase.java

@@ -30,7 +30,6 @@
 import com.rabbitmq.client.Method;
 import com.rabbitmq.client.ShutdownSignalException;
 import com.rabbitmq.client.AlreadyClosedException;
-import com.rabbitmq.client.AuthenticationFailureException;
 import com.rabbitmq.client.impl.ShutdownNotifierComponent;
 import com.rabbitmq.client.AMQP;
 import com.rabbitmq.tools.Host;
@@ -82,7 +81,7 @@ protected void releaseResources()
     }
 
     protected void restart()
-            throws IOException, AuthenticationFailureException {
+            throws IOException {
         tearDown();
         bareRestart();
         setUp();
@@ -96,11 +95,7 @@ protected void bareRestart()
     public void openConnection()
             throws IOException {
         if (connection == null) {
-            try {
-                connection = connectionFactory.newConnection();
-            } catch (AuthenticationFailureException afe) {
-                fail("Unexpected authentication failure");
-            }
+            connection = connectionFactory.newConnection();
         }
     }
 

test/src/com/rabbitmq/client/test/functional/ClusteredTestBase.java

@@ -17,7 +17,6 @@
 package com.rabbitmq.client.test.functional;
 
 import com.rabbitmq.client.AMQP;
-import com.rabbitmq.client.AuthenticationFailureException;
 import com.rabbitmq.client.Channel;
 import com.rabbitmq.client.Connection;
 import com.rabbitmq.client.ConnectionFactory;
@@ -64,9 +63,6 @@ public void openConnection() throws IOException {
             catch (IOException e) {
                 // Must be no secondary node
             }
-            catch (AuthenticationFailureException afe)  {
-                fail("Unexpected authentication failure");
-            }
         }
 
         if (clusteredConnection != null &&

test/src/com/rabbitmq/client/test/functional/ConnectionOpen.java

@@ -22,7 +22,6 @@
 import java.net.Socket;
 
 import com.rabbitmq.client.AMQP;
-import com.rabbitmq.client.AuthenticationFailureException;
 import com.rabbitmq.client.MalformedFrameException;
 import com.rabbitmq.client.Method;
 import com.rabbitmq.client.impl.SocketFrameHandler;
@@ -86,7 +85,7 @@ public void testCrazyProtocolHeader() throws IOException {
         }
     }
 
-    public void testFrameMaxLessThanFrameMinSize() throws IOException, AuthenticationFailureException {
+    public void testFrameMaxLessThanFrameMinSize() throws IOException {
         ConnectionFactory factory = new ConnectionFactory();
         factory.setRequestedFrameMax(100);
         try {

test/src/com/rabbitmq/client/test/functional/FrameMax.java

@@ -24,7 +24,6 @@
 import java.util.concurrent.ExecutorService;
 
 import com.rabbitmq.client.Address;
-import com.rabbitmq.client.AuthenticationFailureException;
 import com.rabbitmq.client.AMQP;
 import com.rabbitmq.client.Connection;
 import com.rabbitmq.client.ConnectionFactory;
@@ -72,7 +71,7 @@ public void testFrameSizes()
     /* server should reject frames larger than AMQP.FRAME_MIN_SIZE
      * during connection negotiation */
     public void testRejectLargeFramesDuringConnectionNegotiation()
-        throws IOException, AuthenticationFailureException
+        throws IOException
     {
         ConnectionFactory cf = new ConnectionFactory();
         cf.getClientProperties().put("too_long", LongStringHelper.asLongString(new byte[AMQP.FRAME_MIN_SIZE]));
@@ -86,7 +85,7 @@ public void testRejectLargeFramesDuringConnectionNegotiation()
     /* server should reject frames larger than the negotiated frame
      * size */
     public void testRejectExceedingFrameMax()
-        throws IOException, AuthenticationFailureException
+        throws IOException
     {
         closeChannel();
         closeConnection();
@@ -162,7 +161,7 @@ public GenerousAMQConnection(ConnectionFactory factory,
     private static class GenerousConnectionFactory extends ConnectionFactory {
 
         @Override public Connection newConnection(ExecutorService executor, Address[] addrs)
-            throws IOException, AuthenticationFailureException
+            throws IOException
         {
             IOException lastException = null;
             for (Address addr : addrs) {

test/src/com/rabbitmq/client/test/functional/QueueExclusivity.java

@@ -21,7 +21,6 @@
 import java.util.HashMap;
 
 import com.rabbitmq.client.AMQP;
-import com.rabbitmq.client.AuthenticationFailureException;
 import com.rabbitmq.client.Channel;
 import com.rabbitmq.client.Connection;
 import com.rabbitmq.client.QueueingConsumer;
@@ -37,11 +36,7 @@ public class QueueExclusivity extends BrokerTestCase {
     String q = "exclusiveQ";
 
     protected void createResources() throws IOException {
-        try {
-            altConnection = connectionFactory.newConnection();
-        } catch (AuthenticationFailureException afe) {
-            fail("Unexpected authentication failure");
-        }
+        altConnection = connectionFactory.newConnection();
         altChannel = altConnection.createChannel();
         altChannel.queueDeclare(q,
         // not durable, exclusive, not auto-delete