1 files changed, 124 insertions, 0 deletions
diff --git a/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java b/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java
new file mode 100644
index 0000000000..b0c6fccc9e
--- /dev/null
+++ b/qpid/java/common/src/main/java/org/apache/qpid/AMQException.java
@@ -0,0 +1,124 @@
+/*
+ *
+ * Licensed to the Apache Software Foundation (ASF) under one
+ * or more contributor license agreements.  See the NOTICE file
+ * distributed with this work for additional information
+ * regarding copyright ownership.  The ASF licenses this file
+ * 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
+ * KIND, either express or implied.  See the License for the
+ * specific language governing permissions and limitations
+ * under the License.
+ *
+ */
+package org.apache.qpid;
+
+import org.apache.qpid.protocol.AMQConstant;
+
+/**
+ * AMQException forms the root exception of all exceptions relating to the AMQ protocol. It provides space to associate
+ * a required AMQ error code with the exception, which is a numeric value, with a meaning defined by the protocol.
+ *
+ * <p/><table id="crc"><caption>CRC Card</caption>
+ * <tr><th> Responsibilities <th> Collaborations
+ * <tr><td> Represents an exception condition associated with an AMQ protocol status code.
+ * </table>
+ *
+ * @todo This exception class is also used as a generic exception throughout Qpid code. This usage may not be strictly
+ *       correct if this is to signify a protocol exception. Should review.
+ */
+public class AMQException extends Exception
+{
+    /** Holds the AMQ error code constant associated with this exception. */
+    private AMQConstant _errorCode;
+   
+    /**
+     * Creates an exception with an optional error code, optional message and optional underlying cause.
+     *
+     * @param errorCode The error code. May be null if not to be set.
+     * @param msg       The exception message. May be null if not to be set.
+     * @param cause         The underlying cause of the exception. May be null if not to be set.
+     */
+    public AMQException(AMQConstant errorCode, String msg, Throwable cause)
+    {
+        super(((msg == null) ? "" : msg), cause);
+        _errorCode = errorCode;
+    }
+
+    /*
+     * Deprecated constructors brought from M2.1
+     */
+    @Deprecated
+    public AMQException(String msg) 
+    {
+        this(null, (msg == null) ? "" : msg);
+    }
+    
+    @Deprecated 
+    public AMQException(AMQConstant errorCode, String msg) 
+    {
+        this(errorCode, (msg == null) ? "" : msg, null);
+    }
+
+    @Deprecated
+    public AMQException(String msg, Throwable cause)
+    {
+        this(null, msg, cause);
+    }
+
+    @Override
+    public String toString()
+    {
+        return getClass().getName() + ": " + getMessage() + (_errorCode == null ? "" : " [error code " + _errorCode + "]");
+    }
+    
+    /**
+     * Gets the AMQ protocol exception code associated with this exception.
+     *
+     * @return The AMQ protocol exception code associated with this exception.
+     */
+    public AMQConstant getErrorCode()
+    {
+        return _errorCode;
+    }
+
+    public boolean isHardError()
+    {
+        return true;
+    }
+
+    /**
+     * Rethrown this exception as a new exception.
+     *
+     * Attempt to create a new exception of the same class if they have the default constructor of:
+     * {AMQConstant.class, String.class, Throwable.class}
+     * <p>
+     * Individual subclasses may override as requried to create a new instance.
+     */
+    public AMQException cloneForCurrentThread()
+    {
+        Class amqeClass = this.getClass();
+        Class<?>[] paramClasses = {AMQConstant.class, String.class, Throwable.class};
+        Object[] params = {getErrorCode(), getMessage(), this};
+
+        AMQException newAMQE;
+
+        try
+        {
+            newAMQE = (AMQException) amqeClass.getConstructor(paramClasses).newInstance(params);
+        }
+        catch (Exception creationException)
+        {
+            newAMQE = new AMQException(getErrorCode(), getMessage(), this);
+        }
+
+        return newAMQE;
+    }
+}