Fix bug 23105: Modify Java client by adding new exceptions

ProtocolVersionMismatchException and PossibleAuthenticationFailureException
analogous to those that the .NET client grew in the fix for bug 21238.

Author: Jerry Kuch

src/com/rabbitmq/client/ConnectionFactory.java

@@ -375,7 +375,7 @@ public Connection newConnection(Address[] addrs)
             try {
                 FrameHandler frameHandler = createFrameHandler(addr);
                 AMQConnection conn = new AMQConnection(this,
-                                                     frameHandler);
+                                                       frameHandler);
                 conn.start();
                 return conn;
             } catch (IOException e) {
@@ -403,7 +403,7 @@ public Connection newConnection() throws IOException {
 
     @Override public ConnectionFactory clone(){
         try {
-            return (ConnectionFactory)super.clone(); 
+            return (ConnectionFactory)super.clone();
         } catch (CloneNotSupportedException e) {
             throw new Error(e);
         }

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

@@ -37,19 +37,17 @@
 import java.util.Map;
 import java.util.HashMap;
 import java.util.concurrent.TimeoutException;
-import java.util.concurrent.ScheduledExecutorService;
-import java.util.concurrent.Executors;
-import java.util.concurrent.TimeUnit;
 
 import com.rabbitmq.client.AMQP;
-import com.rabbitmq.client.Address;
 import com.rabbitmq.client.AlreadyClosedException;
 import com.rabbitmq.client.Channel;
 import com.rabbitmq.client.Command;
 import com.rabbitmq.client.Connection;
 import com.rabbitmq.client.ConnectionFactory;
 import com.rabbitmq.client.MissedHeartbeatException;
 import com.rabbitmq.client.ShutdownSignalException;
+import com.rabbitmq.client.impl.exceptions.PossibleAuthenticationFailureException;
+import com.rabbitmq.client.impl.exceptions.ProtocolVersionMismatchException;
 import com.rabbitmq.utility.BlockingCell;
 import com.rabbitmq.utility.Utility;
 
@@ -228,7 +226,10 @@ public AMQConnection(ConnectionFactory factory,
      * Connection.Start/.StartOk, Connection.Tune/.TuneOk, and then
      * calls Connection.Open and waits for the OpenOk. Sets heartbeat
      * and frame max values after tuning has taken place.
-     * @throws java.io.IOException if an error is encountered
+     * @throws java.io.IOException if an error is encountered; IOException
+     * subtypes ProtocolVersionMismatchException and
+     * PossibleAuthenticationFailureException will be thrown in the
+     * corresponding circumstances.
      */
     public void start()
         throws IOException
@@ -259,40 +260,39 @@ public void start()
                 (AMQP.Connection.Start) connStartBlocker.getReply().getMethod();
 
             _serverProperties = connStart.getServerProperties();
-        
+
             Version serverVersion =
                 new Version(connStart.getVersionMajor(),
                             connStart.getVersionMinor());
-        
+
             if (!Version.checkVersion(clientVersion, serverVersion)) {
                 _frameHandler.close(); //this will cause mainLoop to terminate
-                //TODO: throw a more specific exception
-                throw new IOException("protocol version mismatch: expected " +
-                                      clientVersion + ", got " + serverVersion);
+                throw new ProtocolVersionMismatchException(clientVersion,
+                                                           serverVersion);
             }
         } catch (ShutdownSignalException sse) {
             throw AMQChannel.wrap(sse);
         }
-        
+
         LongString saslResponse = LongStringHelper.asLongString("\0" + _username +
                                                                 "\0" + _password);
         AMQImpl.Connection.StartOk startOk =
             new AMQImpl.Connection.StartOk(_clientProperties, "PLAIN",
                                            saslResponse, "en_US");
-        
+
         AMQP.Connection.Tune connTune = null;
 
         try {
             connTune = (AMQP.Connection.Tune) _channel0.rpc(startOk).getMethod();
         } catch (ShutdownSignalException e) {
-            throw AMQChannel.wrap(e, "Possibly caused by authentication failure");
+            throw new PossibleAuthenticationFailureException(e);
         }
 
         int channelMax =
             negotiatedMaxValue(_factory.getRequestedChannelMax(),
                                connTune.getChannelMax());
         _channelManager = new ChannelManager(channelMax);
-        
+
         int frameMax =
             negotiatedMaxValue(_factory.getRequestedFrameMax(),
                                connTune.getFrameMax());
@@ -302,7 +302,7 @@ public void start()
             negotiatedMaxValue(_factory.getRequestedHeartbeat(),
                                connTune.getHeartbeat());
         setHeartbeat(heartbeat);
-        
+
         _channel0.transmit(new AMQImpl.Connection.TuneOk(channelMax,
                                                          frameMax,
                                                          heartbeat));
@@ -519,7 +519,7 @@ public boolean processControlCommand(Command c)
                 return false;
             } else {
                 // Quiescing.
-                if (method instanceof AMQP.Connection.CloseOk) {    
+                if (method instanceof AMQP.Connection.CloseOk) {
                     // It's our final "RPC". Time to shut down.
                     _running = false;
                     // If Close was sent from within the MainLoop we
@@ -548,14 +548,14 @@ public void handleConnectionClose(Command closeCommand) {
                     getHost() + ":" + getPort());
         scw.start();
     }
-    
+
     private class SocketCloseWait extends Thread {
         private ShutdownSignalException cause;
-        
+
         public SocketCloseWait(ShutdownSignalException sse) {
             cause = sse;
         }
-        
+
         @Override public void run() {
             try {
                 _appContinuation.uninterruptibleGet(CONNECTION_CLOSING_TIMEOUT);
@@ -574,7 +574,7 @@ public SocketCloseWait(ShutdownSignalException sse) {
      * Protected API - causes all attached channels to terminate with
      * a ShutdownSignal built from the argument, and stops this
      * connection from accepting further work from the application.
-     * 
+     *
      * @return a shutdown signal built using the given arguments
      */
     public ShutdownSignalException shutdown(Object reason,
@@ -656,7 +656,7 @@ public void abort(int closeCode, String closeMessage, int timeout)
         }
     }
 
-    /** 
+    /**
      * Protected API - Delegates to {@link
      * #close(int,String,boolean,Throwable,int,boolean) the
      * six-argument close method}, passing 0 for the timeout, and

src/com/rabbitmq/client/impl/exceptions/PossibleAuthenticationFailureException.java

@@ -0,0 +1,15 @@
+package com.rabbitmq.client.impl.exceptions;
+
+import java.io.IOException;
+
+/**
+ * Thrown when the likely cause is an authentication failure.
+ */
+public class PossibleAuthenticationFailureException extends IOException
+{
+    public PossibleAuthenticationFailureException(Throwable cause)
+    {
+        super("Possibly caused by authentication failure",
+              cause);
+    }
+}

src/com/rabbitmq/client/impl/exceptions/ProtocolVersionMismatchException.java

@@ -0,0 +1,61 @@
+package com.rabbitmq.client.impl.exceptions;
+
+import com.rabbitmq.client.impl.Version;
+
+import java.io.IOException;
+import java.net.ProtocolException;
+
+/**
+ * Thrown to indicate that the peer does not support the wire protocol version
+ * we requested immediately after opening the TCP socket.
+ */
+public class ProtocolVersionMismatchException extends ProtocolException
+{
+    private Version clientVersion;
+    private Version serverVersion;
+
+    public ProtocolVersionMismatchException(Version clientVersion,
+                                            Version serverVersion) {
+        super("Protocol version mismatch: expected "
+              + clientVersion + ", got " + serverVersion);
+
+        this.clientVersion = clientVersion;
+        this.serverVersion = serverVersion;
+    }
+
+    /** The client's AMQP specification version. */
+    public Version getClientVersion()
+    {
+        return clientVersion;
+    }
+
+    /** The peer's AMQP specification version. */
+    public Version getServerVersion()
+    {
+        return serverVersion;
+    }
+
+    /** The client's AMQP specification major version. */
+    public int getClientMajor()
+    {
+        return clientVersion.getMajor();
+    }
+
+    /** The client's AMQP specification minor version. */
+    public int getClientMinor()
+    {
+        return clientVersion.getMinor();
+    }
+
+    /** The peer's AMQP specification major version. */
+    public int getServerMajor()
+    {
+        return serverVersion.getMajor();
+    }
+
+    /** The server's AMQP specification minor version. */
+    public int getServerMinor()
+    {
+        return serverVersion.getMinor();
+    }
+}

test/src/com/rabbitmq/client/test/server/Permissions.java

@@ -31,6 +31,7 @@
 
 package com.rabbitmq.client.test.server;
 
+import com.rabbitmq.client.impl.exceptions.PossibleAuthenticationFailureException;
 import com.rabbitmq.client.test.BrokerTestCase;
 import java.io.IOException;
 import java.util.Map;
@@ -41,7 +42,6 @@
 import com.rabbitmq.client.Command;
 import com.rabbitmq.client.Connection;
 import com.rabbitmq.client.ConnectionFactory;
-import com.rabbitmq.client.Method;
 import com.rabbitmq.client.QueueingConsumer;
 import com.rabbitmq.client.ShutdownSignalException;
 import com.rabbitmq.client.impl.AMQChannel;
@@ -148,8 +148,10 @@ public void testAuth()
             unAuthFactory.newConnection();
             fail("Exception expected if password is wrong");
         } catch (IOException e) {
+            assertTrue(e instanceof PossibleAuthenticationFailureException);
             String msg = e.getMessage();
-            assertTrue("Exception message should contain auth", msg.toLowerCase().contains("auth"));
+            assertTrue("Exception message should contain 'auth'",
+                       msg.toLowerCase().contains("auth"));
         }
     }