Documented all exception.

git-svn-id: https://svn.apache.org/repos/asf/incubator/qpid/branches/M2@540107 13f79535-47bb-0310-9956-ffa450edef68

11 files changed, 77 insertions, 28 deletions

diff --git a/java/client/src/main/java/org/apache/qpid/client/AMQAuthenticationException.java b/java/client/src/main/java/org/apache/qpid/client/AMQAuthenticationException.java
index 0bc474f6e6..b6fbb6c6bf 100644
--- a/java/client/src/main/java/org/apache/qpid/client/AMQAuthenticationException.java
+++ b/java/client/src/main/java/org/apache/qpid/client/AMQAuthenticationException.java
@@ -7,9 +7,9 @@
  * to you 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
@@ -23,10 +23,20 @@ package org.apache.qpid.client;
 import org.apache.qpid.AMQException;
 import org.apache.qpid.protocol.AMQConstant;
 
+/**
+ * AMQAuthenticationException represents all failures to authenticate access to a broker.
+ *
+ * <p/><table id="crc"><caption>CRC Card</caption>
+ * <tr><th> Responsibilities <th> Collaborations
+ * <tr><td> Represent failure to authenticate the client.
+ * </table>
+ *
+ * @todo Will this alwyas have the same status code, NOT_ALLOWED 530? Might set this up to always use that code.
+ */
 public class AMQAuthenticationException extends AMQException
 {
     public AMQAuthenticationException(AMQConstant error, String msg)
     {
-        super(error,msg);
+        super(error, msg);
     }
 }
diff --git a/java/client/src/main/java/org/apache/qpid/client/AMQNoConsumersException.java b/java/client/src/main/java/org/apache/qpid/client/AMQNoConsumersException.java
index bec2958cb9..54d5a0426f 100644
--- a/java/client/src/main/java/org/apache/qpid/client/AMQNoConsumersException.java
+++ b/java/client/src/main/java/org/apache/qpid/client/AMQNoConsumersException.java
@@ -7,9 +7,9 @@
  * to you 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
@@ -23,15 +23,18 @@ package org.apache.qpid.client;
 import org.apache.qpid.AMQUndeliveredException;
 import org.apache.qpid.protocol.AMQConstant;
 
-
+/**
+ * AMQNoConsumersException indicates failure to pass an immediate message to a consumer.
+ *
+ * <p/><table id="crc"><caption>CRC Card</caption>
+ * <tr><th> Responsibilities <th> Collaborations
+ * <tr><td> Represents failure to pass an immediate message to a consumer.
+ * <tr><td>
+ */
 public class AMQNoConsumersException extends AMQUndeliveredException
 {
     public AMQNoConsumersException(String msg, Object bounced)
     {
         super(AMQConstant.NO_CONSUMERS, msg, bounced);
     }
-
-
 }
-
-
diff --git a/java/client/src/main/java/org/apache/qpid/client/AMQNoRouteException.java b/java/client/src/main/java/org/apache/qpid/client/AMQNoRouteException.java
index 6ea8413446..a314101acf 100644
--- a/java/client/src/main/java/org/apache/qpid/client/AMQNoRouteException.java
+++ b/java/client/src/main/java/org/apache/qpid/client/AMQNoRouteException.java
@@ -7,9 +7,9 @@
  * to you 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
@@ -23,15 +23,18 @@ package org.apache.qpid.client;
 import org.apache.qpid.AMQUndeliveredException;
 import org.apache.qpid.protocol.AMQConstant;
 
-
+/**
+ * AMQNoRouteException indicates that a mandatory message could not be routed.
+ *
+ * <p/><table id="crc"><caption>CRC Card</caption>
+ * <tr><th> Responsibilities <th> Collaborations
+ * <tr><td> Represents failure to route a mandatory message.
+ * <tr><td>
+ */
 public class AMQNoRouteException extends AMQUndeliveredException
 {
     public AMQNoRouteException(String msg, Object bounced)
     {
         super(AMQConstant.NO_ROUTE, msg, bounced);
     }
-
-
 }
-
-
diff --git a/java/client/src/main/java/org/apache/qpid/client/message/UnexpectedBodyReceivedException.java b/java/client/src/main/java/org/apache/qpid/client/message/UnexpectedBodyReceivedException.java
index 54a8283763..1f61a661d4 100644
--- a/java/client/src/main/java/org/apache/qpid/client/message/UnexpectedBodyReceivedException.java
+++ b/java/client/src/main/java/org/apache/qpid/client/message/UnexpectedBodyReceivedException.java
@@ -23,6 +23,9 @@ package org.apache.qpid.client.message;
 import org.apache.qpid.AMQException;
 import org.apache.qpid.protocol.AMQConstant;
 
+/**
+ * @todo Not used! Delete!
+ */
 public class UnexpectedBodyReceivedException extends AMQException
 {
     public UnexpectedBodyReceivedException(String msg, Throwable t)
diff --git a/java/client/src/main/java/org/apache/qpid/client/message/UnprocessedMessage.java b/java/client/src/main/java/org/apache/qpid/client/message/UnprocessedMessage.java
index b176df87fe..5b199f2478 100644
--- a/java/client/src/main/java/org/apache/qpid/client/message/UnprocessedMessage.java
+++ b/java/client/src/main/java/org/apache/qpid/client/message/UnprocessedMessage.java
@@ -63,7 +63,7 @@ public class UnprocessedMessage
         _bounceBody = bounceBody;
     }
 
-    public void receiveBody(ContentBody body) throws UnexpectedBodyReceivedException
+    public void receiveBody(ContentBody body) //throws UnexpectedBodyReceivedException
     {
 
         if (body.payload != null)
diff --git a/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolSession.java b/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolSession.java
index a557fc8027..386aae4ad1 100644
--- a/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolSession.java
+++ b/java/client/src/main/java/org/apache/qpid/client/protocol/AMQProtocolSession.java
@@ -39,7 +39,7 @@ import org.apache.qpid.AMQException;
 import org.apache.qpid.client.AMQConnection;
 import org.apache.qpid.client.AMQSession;
 import org.apache.qpid.client.ConnectionTuneParameters;
-import org.apache.qpid.client.message.UnexpectedBodyReceivedException;
+// import org.apache.qpid.client.message.UnexpectedBodyReceivedException;
 import org.apache.qpid.client.message.UnprocessedMessage;
 import org.apache.qpid.client.state.AMQStateManager;
 import org.apache.qpid.framing.AMQDataBlock;
@@ -106,10 +106,9 @@ public class AMQProtocolSession implements AMQVersionAwareProtocolSession
 
     private final AMQConnection _connection;
 
-
     public AMQProtocolSession(AMQProtocolHandler protocolHandler, IoSession protocolSession, AMQConnection connection)
     {
-        this(protocolHandler,protocolSession,connection, new AMQStateManager());
+        this(protocolHandler, protocolSession, connection, new AMQStateManager());
 
     }
 
@@ -269,15 +268,15 @@ public class AMQProtocolSession implements AMQVersionAwareProtocolSession
             throw new AMQException("Error: received content body without having received a ContentHeader frame first");
         }
 
-        try
-        {
-            msg.receiveBody(contentBody);
-        }
+        /*try
+        {*/
+        msg.receiveBody(contentBody);
+        /*}
         catch (UnexpectedBodyReceivedException e)
         {
             _channelId2UnprocessedMsgMap.remove(channelId);
             throw e;
-        }
+        }*/
 
         if (msg.isAllBodyDataReceived())
         {
@@ -328,7 +327,6 @@ public class AMQProtocolSession implements AMQVersionAwareProtocolSession
         }
     }
 
-
     /**
      * Starts the process of closing a session
      *
diff --git a/java/client/src/main/java/org/apache/qpid/client/state/AMQStateManager.java b/java/client/src/main/java/org/apache/qpid/client/state/AMQStateManager.java
index 825baf95d1..0f43115841 100644
--- a/java/client/src/main/java/org/apache/qpid/client/state/AMQStateManager.java
+++ b/java/client/src/main/java/org/apache/qpid/client/state/AMQStateManager.java
@@ -186,7 +186,7 @@ public class AMQStateManager implements AMQMethodListener
 
     protected StateAwareMethodListener findStateTransitionHandler(AMQState currentState,
                                                                   AMQMethodBody frame)
-            throws IllegalStateTransitionException
+            // throws IllegalStateTransitionException
     {
         final Class clazz = frame.getClass();
         if (_logger.isDebugEnabled())
diff --git a/java/client/src/main/java/org/apache/qpid/client/state/IllegalStateTransitionException.java b/java/client/src/main/java/org/apache/qpid/client/state/IllegalStateTransitionException.java
index bd1145da9f..41fa1ba704 100644
--- a/java/client/src/main/java/org/apache/qpid/client/state/IllegalStateTransitionException.java
+++ b/java/client/src/main/java/org/apache/qpid/client/state/IllegalStateTransitionException.java
@@ -22,6 +22,11 @@ package org.apache.qpid.client.state;
 
 import org.apache.qpid.AMQException;
 
+/**
+ * @todo Not an AMQP exception as no status code.
+ *
+ * @todo Not used! Delete.
+ */
 public class IllegalStateTransitionException extends AMQException
 {
     private AMQState _originalState;
diff --git a/java/client/src/main/java/org/apache/qpid/client/transport/AMQNoTransportForProtocolException.java b/java/client/src/main/java/org/apache/qpid/client/transport/AMQNoTransportForProtocolException.java
index 1ec3adc2eb..da16baaad9 100644
--- a/java/client/src/main/java/org/apache/qpid/client/transport/AMQNoTransportForProtocolException.java
+++ b/java/client/src/main/java/org/apache/qpid/client/transport/AMQNoTransportForProtocolException.java
@@ -22,6 +22,16 @@ package org.apache.qpid.client.transport;
 
 import org.apache.qpid.jms.BrokerDetails;
 
+/**
+ * AMQNoTransportForProtocolException represents a connection failure where there is no transport medium to connect
+ * to the broker available.  This may be the case if their is a error in the connection url, or an unsupported transport
+ * type is specified.
+ *
+ * <p/><table id="crc"><caption>CRC Card</caption>
+ * <tr><th> Responsibilities <th> Collaborations
+ * <tr><td> Represent absence of a transport medium.
+ * </table>
+ */
 public class AMQNoTransportForProtocolException extends AMQTransportConnectionException
 {
     BrokerDetails _details;
diff --git a/java/client/src/main/java/org/apache/qpid/client/transport/AMQTransportConnectionException.java b/java/client/src/main/java/org/apache/qpid/client/transport/AMQTransportConnectionException.java
index fec7ff693c..24b4e03b39 100644
--- a/java/client/src/main/java/org/apache/qpid/client/transport/AMQTransportConnectionException.java
+++ b/java/client/src/main/java/org/apache/qpid/client/transport/AMQTransportConnectionException.java
@@ -23,6 +23,15 @@ package org.apache.qpid.client.transport;
 import org.apache.qpid.AMQException;
 import org.apache.qpid.protocol.AMQConstant;
 
+/**
+ * AMQTransportConnectionException indicates a failure to establish a connection through the transporting medium, to
+ * an AMQP broker.
+ *
+ * <p/><table id="crc"><caption>CRC Card</caption>
+ * <tr><th> Responsibilities <th> Collaborations
+ * <tr><td> Represent failure to connect through the transport medium.
+ * </table>
+ */
 public class AMQTransportConnectionException extends AMQException
 {
     public AMQTransportConnectionException(AMQConstant errorCode, String message, Throwable cause)
diff --git a/java/client/src/main/java/org/apache/qpid/client/vmbroker/AMQVMBrokerCreationException.java b/java/client/src/main/java/org/apache/qpid/client/vmbroker/AMQVMBrokerCreationException.java
index 4b2982fe9c..1791e7ede3 100644
--- a/java/client/src/main/java/org/apache/qpid/client/vmbroker/AMQVMBrokerCreationException.java
+++ b/java/client/src/main/java/org/apache/qpid/client/vmbroker/AMQVMBrokerCreationException.java
@@ -23,6 +23,14 @@ package org.apache.qpid.client.vmbroker;
 import org.apache.qpid.client.transport.AMQTransportConnectionException;
 import org.apache.qpid.protocol.AMQConstant;
 
+/**
+ * AMQVMBrokerCreationException represents failure to create an in VM broker on the vm transport medium.
+ *
+ * <p/><table id="crc"><caption>CRC Card</caption>
+ * <tr><th> Responsibilities <th> Collaborations
+ * <tr><td> Represent failure to create an in VM broker.
+ * </table>
+ */
 public class AMQVMBrokerCreationException extends AMQTransportConnectionException
 {
     private int _port;