summaryrefslogtreecommitdiffstats
path: root/framework/src/onos/core/api/src/main/java/org/onosproject/store/service/StorageAdminService.java
diff options
context:
space:
mode:
Diffstat (limited to 'framework/src/onos/core/api/src/main/java/org/onosproject/store/service/StorageAdminService.java')
-rw-r--r--framework/src/onos/core/api/src/main/java/org/onosproject/store/service/StorageAdminService.java75
1 files changed, 75 insertions, 0 deletions
diff --git a/framework/src/onos/core/api/src/main/java/org/onosproject/store/service/StorageAdminService.java b/framework/src/onos/core/api/src/main/java/org/onosproject/store/service/StorageAdminService.java
new file mode 100644
index 00000000..22591044
--- /dev/null
+++ b/framework/src/onos/core/api/src/main/java/org/onosproject/store/service/StorageAdminService.java
@@ -0,0 +1,75 @@
+/*
+ * Copyright 2015 Open Networking Laboratory
+ *
+ * Licensed 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.onosproject.store.service;
+
+import java.util.Collection;
+import java.util.List;
+import java.util.Map;
+
+/**
+ * Service for administering storage instances.
+ */
+public interface StorageAdminService {
+
+ /**
+ * Returns information about all partitions in the system.
+ *
+ * @return list of partition information
+ */
+ List<PartitionInfo> getPartitionInfo();
+
+ /**
+ * Returns information about all the consistent maps in the system.
+ *
+ * @return list of map information
+ */
+ List<MapInfo> getMapInfo();
+
+ /**
+ * Returns information about all the atomic counters in the system.
+ * If 2 counters belonging to 2 different databases have the same name,
+ * then only one counter from one database is returned.
+ *
+ * @return mapping from counter name to that counter's next value
+ */
+ Map<String, Long> getCounters();
+
+ /**
+ * Returns information about all the atomic partitioned database counters in the system.
+ *
+ * @return mapping from counter name to that counter's next value
+ */
+ Map<String, Long> getPartitionedDatabaseCounters();
+
+ /**
+ * Returns information about all the atomic in-memory database counters in the system.
+ *
+ * @return mapping from counter name to that counter's next value
+ */
+ Map<String, Long> getInMemoryDatabaseCounters();
+
+ /**
+ * Returns all the transactions in the system.
+ *
+ * @return collection of transactions
+ */
+ Collection<Transaction> getTransactions();
+
+ /**
+ * Redrives stuck transactions while removing those that are done.
+ */
+ void redriveTransactions();
+}