SLING-8065 - Introduce ReadOnlyDistributionQueue API
diff --git a/src/main/java/org/apache/sling/distribution/queue/spi/DistributionQueue.java b/src/main/java/org/apache/sling/distribution/queue/spi/DistributionQueue.java
index 7cff77e..ec57523 100644
--- a/src/main/java/org/apache/sling/distribution/queue/spi/DistributionQueue.java
+++ b/src/main/java/org/apache/sling/distribution/queue/spi/DistributionQueue.java
@@ -30,6 +30,8 @@
import org.jetbrains.annotations.Nullable;
/**
+ * An editable distribution queue holding {@link DistributionQueueEntry} distribution queue entries.
+ * <p/>
* A queue is responsible for collecting the {@link DistributionPackage}s
* exported by a {@link DistributionAgent} in
* order to be able to process them also when there are multiple (concurrent)
@@ -40,15 +42,7 @@
* strategy or in parallel, or some other way, via {@link DistributionQueueProcessor}s.
*/
@ConsumerType
-public interface DistributionQueue {
-
- /**
- * get this queue name
- *
- * @return the queue name
- */
- @NotNull
- String getName();
+public interface DistributionQueue extends ReadOnlyDistributionQueue {
/**
* add a distribution item to this queue
@@ -61,34 +55,6 @@
DistributionQueueEntry add(@NotNull DistributionQueueItem item);
/**
- * get the first item (in a FIFO strategy, the next to be processed) from the queue
- *
- * @return the first item into the queue or {@code null} if the queue is empty
- */
- @Nullable
- DistributionQueueEntry getHead();
-
- /**
- * get all the items in the queue
- *
- * @param skip the number of items to skip
- * @param limit the maximum number of items to return. use -1 to return all items.
- * @return a {@link java.lang.Iterable} of {@link DistributionQueueItem}s
- */
- @NotNull
- Iterable<DistributionQueueEntry> getItems(int skip, int limit);
-
- /**
- * gets an item from the queue by specifying its id
- *
- * @param itemId the id of the item as returned by {@link DistributionQueueItem#getPackageId()}
- * @return the item, or {@code null} if the item with the given id
- * doesn't exist
- */
- @Nullable
- DistributionQueueEntry getItem(@NotNull String itemId);
-
- /**
* remove an item from the queue by specifying its id
*
* @param itemId the id the item as returned by {@link DistributionQueueItem#getPackageId()}
@@ -98,17 +64,4 @@
@Nullable
DistributionQueueEntry remove(@NotNull String itemId);
- /**
- * get the status of the queue
- * @return the queue status
- */
- @NotNull
- DistributionQueueStatus getStatus();
-
- /**
- * get the type of this queue
- * @return the type
- */
- @NotNull
- DistributionQueueType getType();
}
diff --git a/src/main/java/org/apache/sling/distribution/queue/spi/ReadOnlyDistributionQueue.java b/src/main/java/org/apache/sling/distribution/queue/spi/ReadOnlyDistributionQueue.java
new file mode 100644
index 0000000..753d54d
--- /dev/null
+++ b/src/main/java/org/apache/sling/distribution/queue/spi/ReadOnlyDistributionQueue.java
@@ -0,0 +1,87 @@
+/*
+ * 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.sling.distribution.queue.spi;
+
+import aQute.bnd.annotation.ConsumerType;
+import org.apache.sling.distribution.queue.DistributionQueueEntry;
+import org.apache.sling.distribution.queue.DistributionQueueItem;
+import org.apache.sling.distribution.queue.DistributionQueueStatus;
+import org.apache.sling.distribution.queue.DistributionQueueType;
+import org.jetbrains.annotations.NotNull;
+import org.jetbrains.annotations.Nullable;
+
+/**
+ * A read only distribution queue holding {@link DistributionQueueEntry} distribution queue entries.
+ *
+ * @since 0.1.0
+ */
+@ConsumerType
+public interface ReadOnlyDistributionQueue {
+
+ /**
+ * get this queue name
+ *
+ * @return the queue name
+ */
+ @NotNull
+ String getName();
+
+ /**
+ * get the first queue entry (in a FIFO strategy, the next to be processed) from the queue
+ *
+ * @return the first entry into the queue or {@code null} if the queue is empty
+ */
+ @Nullable
+ DistributionQueueEntry getHead();
+
+ /**
+ * get all the entries in the queue
+ *
+ * @param skip the number of items to skip
+ * @param limit the maximum number of items to return. use -1 to return all items.
+ * @return a {@link java.lang.Iterable} of {@link DistributionQueueItem}s
+ */
+ @NotNull
+ Iterable<DistributionQueueEntry> getItems(int skip, int limit);
+
+ /**
+ * gets an entry from the queue by specifying its id
+ *
+ * @param itemId the id of the item as returned by {@link DistributionQueueItem#getPackageId()}
+ * @return the entry, or {@code null} if the entry with the given id
+ * doesn't exist
+ */
+ @Nullable
+ DistributionQueueEntry getItem(@NotNull String itemId);
+
+ /**
+ * get the status of the queue
+ * @return the queue status
+ */
+ @NotNull
+ DistributionQueueStatus getStatus();
+
+ /**
+ * get the type of this queue
+ * @return the type
+ */
+ @NotNull
+ DistributionQueueType getType();
+
+}
diff --git a/src/main/java/org/apache/sling/distribution/queue/spi/package-info.java b/src/main/java/org/apache/sling/distribution/queue/spi/package-info.java
index 96aa8bd..3a80790 100644
--- a/src/main/java/org/apache/sling/distribution/queue/spi/package-info.java
+++ b/src/main/java/org/apache/sling/distribution/queue/spi/package-info.java
@@ -17,7 +17,7 @@
* under the License.
*/
-@Version("0.0.1")
+@Version("0.1.0")
package org.apache.sling.distribution.queue.spi;
import aQute.bnd.annotation.Version;
