QPID-2659: Add AMQStoreException to message stores

This is a sub-class of AMQInternalException, which encapsulates error code 541,
or INTERNAL_ERROR.

git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@979315 13f79535-47bb-0310-9956-ffa450edef68

2 files changed, 97 insertions, 0 deletions

diff --git a/java/common/src/main/java/org/apache/qpid/AMQInternalException.java b/java/common/src/main/java/org/apache/qpid/AMQInternalException.java
new file mode 100644
index 0000000000..59dc800c0e
--- /dev/null
+++ b/java/common/src/main/java/org/apache/qpid/AMQInternalException.java
@@ -0,0 +1,49 @@
+/*
+ *
+ * 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;
+
+/**
+ * InternalException encapsulates error code 541, or {@link AMQConstant#INTERNAL_ERROR} exceptions relating to the
+ * AMQ protocol. It is used to report internal failures and errors that occur within the broker.
+ */
+public class AMQInternalException extends AMQException
+{
+    /** serialVersionUID */
+    private static final long serialVersionUID = 2544449432843381112L;
+
+    /**
+     * Creates an exception with an optional message and optional underlying cause.
+     *
+     * @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 AMQInternalException(String msg, Throwable cause)
+    {
+        super(AMQConstant.INTERNAL_ERROR, ((msg == null) ? "Internal error" : msg), cause);
+    }
+    
+    public AMQInternalException(String msg) 
+    {
+        this(msg, null);
+    }
+}
diff --git a/java/common/src/main/java/org/apache/qpid/AMQStoreException.java b/java/common/src/main/java/org/apache/qpid/AMQStoreException.java
new file mode 100644
index 0000000000..8389fe5efa
--- /dev/null
+++ b/java/common/src/main/java/org/apache/qpid/AMQStoreException.java
@@ -0,0 +1,48 @@
+/*
+ *
+ * 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 java.sql.SQLException;
+
+/**
+ * StoreException is a specific type of internal error relating to errors in the message store, such as {@link SQLException}.
+ */
+public class AMQStoreException extends AMQInternalException
+{
+    /** serialVersionUID */
+    private static final long serialVersionUID = 2859681947490637496L;
+
+    /**
+     * Creates an exception with an optional message and optional underlying cause.
+     *
+     * @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 AMQStoreException(String msg, Throwable cause)
+    {
+        super(((msg == null) ? "Store error" : msg), cause);
+    }
+    
+    public AMQStoreException(String msg) 
+    {
+        this(msg, null);
+    }
+}