1 files changed, 90 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/net/newresource/ResourceStore.java b/framework/src/onos/core/api/src/main/java/org/onosproject/net/newresource/ResourceStore.java
new file mode 100644
index 00000000..fc2eba70
--- /dev/null
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/net/newresource/ResourceStore.java
@@ -0,0 +1,90 @@
+package org.onosproject.net.newresource;
+
+import com.google.common.annotations.Beta;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Optional;
+
+/**
+ * Service for storing resource and consumer information.
+ */
+@Beta
+public interface ResourceStore {
+
+    /**
+     * Registers the resources in transactional way.
+     * Resource registration must be done before resource allocation. The state after completion
+     * of this method is all the resources are registered, or none of the given resources is registered.
+     * The whole registration fails when any one of the resource can't be registered.
+     *
+     * @param resources resources to be registered
+     * @return true if the registration succeeds, false otherwise
+     */
+    boolean register(List<ResourcePath> resources);
+
+    /**
+     * Unregisters the resources in transactional way.
+     * The state after completion of this method is all the resources are unregistered,
+     * or none of the given resources is unregistered. The whole unregistration fails when any one of the
+     * resource can't be unregistered.
+     *
+     * @param resources resources to be unregistered
+     * @return true if the registration succeeds, false otherwise
+     */
+    boolean unregister(List<ResourcePath> resources);
+
+    /**
+     * Allocates the specified resources to the specified consumer in transactional way.
+     * The state after completion of this method is all the resources are allocated to the consumer,
+     * or no resource is allocated to the consumer. The whole allocation fails when any one of
+     * the resource can't be allocated.
+     *
+     * @param resources resources to be allocated
+     * @param consumer resource consumer which the resources are allocated to
+     * @return true if the allocation succeeds, false otherwise.
+     */
+    boolean allocate(List<ResourcePath> resources, ResourceConsumer consumer);
+
+    /**
+     * Releases the specified resources allocated to the specified corresponding consumers
+     * in transactional way. The state after completion of this method is all the resources
+     * are released from the consumer, or no resource is released. The whole release fails
+     * when any one of the resource can't be released. The size of the list of resources and
+     * that of consumers must be equal. The resource and consumer with the same position from
+     * the head of each list correspond to each other.
+     *
+     * @param resources resources to be released
+     * @param consumers resource consumers to whom the resource allocated to
+     * @return true if succeeds, otherwise false
+     */
+    boolean release(List<ResourcePath> resources, List<ResourceConsumer> consumers);
+
+    /**
+     * Returns the resource consumer to whom the specified resource is allocated.
+     *
+     * @param resource resource whose allocated consumer to be returned
+     * @return resource consumer who are allocated the resource
+     */
+    Optional<ResourceConsumer> getConsumer(ResourcePath resource);
+
+    /**
+     * Returns a collection of the resources allocated to the specified consumer.
+     *
+     * @param consumer resource consumer whose allocated resource are searched for
+     * @return a collection of the resources allocated to the specified consumer
+     */
+    Collection<ResourcePath> getResources(ResourceConsumer consumer);
+
+    /**
+     * Returns a collection of the resources which are children of the specified parent and
+     * whose type is the specified class.
+     *
+     * @param parent parent of the resources to be returned
+     * @param cls class instance of the children
+     * @param <T> type of the resource
+     * @return a collection of the resources which belongs to the specified subject and
+     * whose type is the specified class.
+     */
+    <T> Collection<ResourcePath> getAllocatedResources(ResourcePath parent, Class<T> cls);
+}