1 files changed, 275 insertions, 0 deletions
diff --git a/qpid/java/broker/src/main/java/org/apache/qpid/server/queue/AMQQueue.java b/qpid/java/broker/src/main/java/org/apache/qpid/server/queue/AMQQueue.java
new file mode 100644
index 0000000000..9b9de8333b
--- /dev/null
+++ b/qpid/java/broker/src/main/java/org/apache/qpid/server/queue/AMQQueue.java
@@ -0,0 +1,275 @@
+/*
+ *
+ * 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.server.queue;
+
+import org.apache.qpid.AMQException;
+import org.apache.qpid.framing.AMQShortString;
+import org.apache.qpid.server.AMQChannel;
+import org.apache.qpid.server.configuration.plugins.ConfigurationPlugin;
+import org.apache.qpid.server.logging.LogSubject;
+import org.apache.qpid.server.protocol.AMQSessionModel;
+import org.apache.qpid.server.binding.Binding;
+import org.apache.qpid.server.configuration.QueueConfig;
+import org.apache.qpid.server.exchange.Exchange;
+import org.apache.qpid.server.exchange.ExchangeReferrer;
+import org.apache.qpid.server.management.Managable;
+import org.apache.qpid.server.management.ManagedObject;
+import org.apache.qpid.server.security.PrincipalHolder;
+import org.apache.qpid.server.store.TransactionLogResource;
+import org.apache.qpid.server.subscription.Subscription;
+import org.apache.qpid.server.txn.ServerTransaction;
+import org.apache.qpid.server.virtualhost.VirtualHost;
+
+import java.util.List;
+import java.util.Map;
+import java.util.Set;
+
+public interface AMQQueue extends Managable, Comparable<AMQQueue>, ExchangeReferrer, TransactionLogResource, BaseQueue,
+                                  QueueConfig
+{
+    boolean getDeleteOnNoConsumers();
+
+    void setDeleteOnNoConsumers(boolean b);
+
+    void addBinding(Binding binding);
+
+    void removeBinding(Binding binding);
+
+    List<Binding> getBindings();
+
+    int getBindingCount();
+
+    LogSubject getLogSubject();
+
+    public interface Context
+    {
+        QueueEntry getLastSeenEntry();
+    }
+
+    void setNoLocal(boolean b);
+
+    boolean isAutoDelete();
+
+    AMQShortString getOwner();
+    PrincipalHolder getPrincipalHolder();
+    void setPrincipalHolder(PrincipalHolder principalHolder);
+
+    void setExclusiveOwningSession(AMQSessionModel owner);
+    AMQSessionModel getExclusiveOwningSession();
+
+    VirtualHost getVirtualHost();
+
+    void registerSubscription(final Subscription subscription, final boolean exclusive) throws AMQException;
+
+    void unregisterSubscription(final Subscription subscription) throws AMQException;
+
+
+    int getConsumerCount();
+
+    int getActiveConsumerCount();
+
+    boolean hasExclusiveSubscriber();
+
+    boolean isUnused();
+
+    boolean isEmpty();
+
+    int getMessageCount();
+
+    int getUndeliveredMessageCount();
+
+
+    long getQueueDepth();
+
+    long getReceivedMessageCount();
+
+    long getOldestMessageArrivalTime();
+
+    boolean isDeleted();
+
+    int delete() throws AMQException;
+
+    void requeue(QueueEntry entry);
+
+    void dequeue(QueueEntry entry, Subscription sub);
+
+    void decrementUnackedMsgCount();
+
+    boolean resend(final QueueEntry entry, final Subscription subscription) throws AMQException;
+
+    void addQueueDeleteTask(final Task task);
+    void removeQueueDeleteTask(final Task task);
+
+
+
+    List<QueueEntry> getMessagesOnTheQueue();
+
+    List<QueueEntry> getMessagesOnTheQueue(long fromMessageId, long toMessageId);
+
+    List<Long> getMessagesOnTheQueue(int num);
+
+    List<Long> getMessagesOnTheQueue(int num, int offest);
+
+    QueueEntry getMessageOnTheQueue(long messageId);
+
+    /**
+     * Returns a list of QueEntries from a given range of queue positions, eg messages 5 to 10 on the queue.
+     *
+     * The 'queue position' index starts from 1. Using 0 in 'from' will be ignored and continue from 1.
+     * Using 0 in the 'to' field will return an empty list regardless of the 'from' value.
+     * @param fromPosition
+     * @param toPosition
+     * @return
+     */
+    public List<QueueEntry> getMessagesRangeOnTheQueue(final long fromPosition, final long toPosition);
+
+
+    void moveMessagesToAnotherQueue(long fromMessageId, long toMessageId, String queueName,
+                                                        ServerTransaction transaction);
+
+    void copyMessagesToAnotherQueue(long fromMessageId, long toMessageId, String queueName, ServerTransaction transaction);
+
+    void removeMessagesFromQueue(long fromMessageId, long toMessageId);
+
+
+
+    long getMaximumMessageSize();
+
+    void setMaximumMessageSize(long value);
+
+
+    long getMaximumMessageCount();
+
+    void setMaximumMessageCount(long value);
+
+
+    long getMaximumQueueDepth();
+
+    void setMaximumQueueDepth(long value);
+
+
+    long getMaximumMessageAge();
+
+    void setMaximumMessageAge(final long maximumMessageAge);
+
+
+    long getMinimumAlertRepeatGap();
+
+    void setMinimumAlertRepeatGap(long value);
+
+
+    long getCapacity();
+
+    void setCapacity(long capacity);
+
+
+    long getFlowResumeCapacity();
+
+    void setFlowResumeCapacity(long flowResumeCapacity);
+
+    boolean isOverfull();
+
+    void deleteMessageFromTop();
+
+    long clearQueue() throws AMQException;
+
+    /**
+     * Checks the status of messages on the queue, purging expired ones, firing age related alerts etc.
+     * @throws AMQException
+     */
+    void checkMessageStatus() throws AMQException;
+
+    Set<NotificationCheck> getNotificationChecks();
+
+    void flushSubscription(final Subscription sub) throws AMQException;
+
+    void deliverAsync(final Subscription sub);
+
+    void deliverAsync();
+
+    void stop();
+
+    boolean isExclusive();
+
+    Exchange getAlternateExchange();
+
+    void setAlternateExchange(Exchange exchange);
+
+    Map<String, Object> getArguments();
+
+    void checkCapacity(AMQChannel channel);
+
+    /**
+     * ExistingExclusiveSubscription signals a failure to create a subscription, because an exclusive subscription
+     * already exists.
+     *
+     * <p/><table id="crc"><caption>CRC Card</caption>
+     * <tr><th> Responsibilities <th> Collaborations
+     * <tr><td> Represent failure to create a subscription, because an exclusive subscription already exists.
+     * </table>
+     *
+     * @todo Not an AMQP exception as no status code.
+     *
+     * @todo Move to top level, used outside this class.
+     */
+    static final class ExistingExclusiveSubscription extends AMQException
+    {
+
+        public ExistingExclusiveSubscription()
+        {
+            super("");
+        }
+    }
+
+    /**
+     * ExistingSubscriptionPreventsExclusive signals a failure to create an exclusize subscription, as a subscription
+     * already exists.
+     *
+     * <p/><table id="crc"><caption>CRC Card</caption>
+     * <tr><th> Responsibilities <th> Collaborations
+     * <tr><td> Represent failure to create an exclusize subscription, as a subscription already exists.
+     * </table>
+     *
+     * @todo Not an AMQP exception as no status code.
+     *
+     * @todo Move to top level, used outside this class.
+     */
+    static final class ExistingSubscriptionPreventsExclusive extends AMQException
+    {
+        public ExistingSubscriptionPreventsExclusive()
+        {
+            super("");
+        }
+    }
+
+    static interface Task
+    {
+        public void doTask(AMQQueue queue) throws AMQException;
+    }
+
+    void configure(ConfigurationPlugin config);
+
+    ConfigurationPlugin getConfiguration();
+
+    ManagedObject getManagedObject();
+
+    void setExclusive(boolean exclusive) throws AMQException;
+}