MessageCleanupException.java
01 /*
02  *
03  * Licensed to the Apache Software Foundation (ASF) under one
04  * or more contributor license agreements.  See the NOTICE file
05  * distributed with this work for additional information
06  * regarding copyright ownership.  The ASF licenses this file
07  * to you under the Apache License, Version 2.0 (the
08  * "License"); you may not use this file except in compliance
09  * with the License.  You may obtain a copy of the License at
10  *
11  *   http://www.apache.org/licenses/LICENSE-2.0
12  *
13  * Unless required by applicable law or agreed to in writing,
14  * software distributed under the License is distributed on an
15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
16  * KIND, either express or implied.  See the License for the
17  * specific language governing permissions and limitations
18  * under the License.
19  *
20  */
21 package org.apache.qpid.server.queue;
22 
23 import org.apache.qpid.AMQException;
24 
25 /**
26  * MessageCleanupException represents the failure to perform reference counting on messages correctly. This should not
27  * happen, but there may be programming errors giving race conditions that cause the reference counting to go wrong.
28  *
29  <p/><table id="crc"><caption>CRC Card</caption>
30  <tr><th> Responsibilities <th> Collaborations
31  <tr><td> Signals that the reference count of a message has gone below zero.
32  <tr><td> Indicates that a message store has lost a message which is still referenced.
33  </table>
34  *
35  * @todo Not an AMQP exception as no status code.
36  *
37  * @todo The race conditions leading to this error should be cleaned up, and a runtime exception used instead. If the
38  *       message store loses messages, then something is seriously wrong and it would be sensible to terminate the
39  *       broker. This may be disguising out of memory errors.
40  */
41 public class MessageCleanupException extends AMQException
42 {
43     public MessageCleanupException(long messageId, AMQException e)
44     {
45         super("Failed to cleanup message with id " + messageId, e);
46     }
47 
48     public MessageCleanupException(String message)
49     {
50         super(message);
51     }
52 }