blob: 4d94cec6868c91d8a845a139bddd6eaf68ea5bd3 [file] [log] [blame]
Jonathan Hart054da972015-02-18 17:30:28 -08001/*
2 * Copyright 2015 Open Networking Laboratory
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16package org.onosproject.store.service;
17
Madan Jampanibff6d8f2015-03-31 16:53:47 -070018import java.util.Collection;
Jonathan Hart054da972015-02-18 17:30:28 -080019import java.util.List;
Madan Jampanib5d72d52015-04-03 16:53:50 -070020import java.util.Map;
Jonathan Hart054da972015-02-18 17:30:28 -080021
Madan Jampanicadd70b2016-02-08 13:45:43 -080022import org.onosproject.store.primitives.TransactionId;
23
Jonathan Hart054da972015-02-18 17:30:28 -080024/**
25 * Service for administering storage instances.
26 */
27public interface StorageAdminService {
28
29 /**
30 * Returns information about all partitions in the system.
31 *
32 * @return list of partition information
Ray Milkeyea125322016-02-16 13:35:09 -080033 * @deprecated 1.5.0 Falcon Release
Jonathan Hart054da972015-02-18 17:30:28 -080034 */
Madan Jampanie14a09c2016-02-11 10:43:21 -080035 @Deprecated
Jonathan Hart054da972015-02-18 17:30:28 -080036 List<PartitionInfo> getPartitionInfo();
Madan Jampania89f8f92015-04-01 14:39:54 -070037
38 /**
39 * Returns information about all the consistent maps in the system.
40 *
41 * @return list of map information
Ray Milkeyea125322016-02-16 13:35:09 -080042 * @deprecated 1.5.0 Falcon Release
Madan Jampania89f8f92015-04-01 14:39:54 -070043 */
Madan Jampanie14a09c2016-02-11 10:43:21 -080044 @Deprecated
Madan Jampania89f8f92015-04-01 14:39:54 -070045 List<MapInfo> getMapInfo();
Madan Jampanibff6d8f2015-03-31 16:53:47 -070046
47 /**
Madan Jampanib5d72d52015-04-03 16:53:50 -070048 * Returns information about all the atomic counters in the system.
Kaouther Abrouguid8b565a2015-05-20 16:07:20 -070049 * If 2 counters belonging to 2 different databases have the same name,
50 * then only one counter from one database is returned.
Madan Jampanib5d72d52015-04-03 16:53:50 -070051 *
52 * @return mapping from counter name to that counter's next value
Ray Milkeyea125322016-02-16 13:35:09 -080053 * @deprecated 1.5.0 Falcon Release
Madan Jampanib5d72d52015-04-03 16:53:50 -070054 */
Madan Jampanie14a09c2016-02-11 10:43:21 -080055 @Deprecated
Madan Jampanib5d72d52015-04-03 16:53:50 -070056 Map<String, Long> getCounters();
57
58 /**
Kaouther Abrouguid8b565a2015-05-20 16:07:20 -070059 * Returns information about all the atomic partitioned database counters in the system.
60 *
61 * @return mapping from counter name to that counter's next value
Ray Milkeyea125322016-02-16 13:35:09 -080062 * @deprecated 1.5.0 Falcon Release
Kaouther Abrouguid8b565a2015-05-20 16:07:20 -070063 */
Madan Jampanie14a09c2016-02-11 10:43:21 -080064 @Deprecated
Kaouther Abrouguid8b565a2015-05-20 16:07:20 -070065 Map<String, Long> getPartitionedDatabaseCounters();
66
67 /**
68 * Returns information about all the atomic in-memory database counters in the system.
69 *
70 * @return mapping from counter name to that counter's next value
Ray Milkeyea125322016-02-16 13:35:09 -080071 * @deprecated 1.5.0 Falcon Release
Kaouther Abrouguid8b565a2015-05-20 16:07:20 -070072 */
Madan Jampanie14a09c2016-02-11 10:43:21 -080073 @Deprecated
Kaouther Abrouguid8b565a2015-05-20 16:07:20 -070074 Map<String, Long> getInMemoryDatabaseCounters();
75
76 /**
Madan Jampanicadd70b2016-02-08 13:45:43 -080077 * Returns all pending transactions.
Madan Jampanibff6d8f2015-03-31 16:53:47 -070078 *
Madan Jampanicadd70b2016-02-08 13:45:43 -080079 * @return collection of pending transaction identifiers.
Madan Jampanibff6d8f2015-03-31 16:53:47 -070080 */
Madan Jampanicadd70b2016-02-08 13:45:43 -080081 Collection<TransactionId> getPendingTransactions();
Jonathan Hart054da972015-02-18 17:30:28 -080082}