Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 1 | package org.onosproject.store.service; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 2 | |
Yuta HIGUCHI | 60731cb | 2014-11-11 01:34:46 -0800 | [diff] [blame] | 3 | import java.util.Collection; |
Yuta HIGUCHI | f0f2dfc | 2014-11-26 13:59:07 -0800 | [diff] [blame] | 4 | import java.util.Optional; |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 5 | import java.util.Set; |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 6 | |
Brian O'Connor | abafb50 | 2014-12-02 22:26:20 -0800 | [diff] [blame] | 7 | import org.onosproject.cluster.ControllerNode; |
Yuta HIGUCHI | 60731cb | 2014-11-11 01:34:46 -0800 | [diff] [blame] | 8 | |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 9 | /** |
Madan Jampani | 37c2e70 | 2014-11-04 18:11:10 -0800 | [diff] [blame] | 10 | * Service interface for running administrative tasks on a Database. |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 11 | */ |
| 12 | public interface DatabaseAdminService { |
| 13 | |
| 14 | /** |
| 15 | * Creates a new table. |
| 16 | * Table creation is idempotent. Attempting to create a table |
| 17 | * that already exists will be a noop. |
| 18 | * @param name table name. |
| 19 | * @return true if the table was created by this call, false otherwise. |
| 20 | */ |
| 21 | public boolean createTable(String name); |
| 22 | |
| 23 | /** |
Madan Jampani | def2c65 | 2014-11-12 13:50:10 -0800 | [diff] [blame] | 24 | * Creates a new table where last update time will be used to track and expire old entries. |
| 25 | * Table creation is idempotent. Attempting to create a table |
| 26 | * that already exists will be a noop. |
| 27 | * @param name table name. |
| 28 | * @param ttlMillis total duration in millis since last update time when entries will be expired. |
| 29 | * @return true if the table was created by this call, false otherwise. |
| 30 | */ |
| 31 | public boolean createTable(String name, int ttlMillis); |
| 32 | |
| 33 | /** |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 34 | * Lists all the tables in the database. |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 35 | * @return set of table names. |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 36 | */ |
Madan Jampani | f5d263b | 2014-11-13 10:04:40 -0800 | [diff] [blame] | 37 | public Set<String> listTables(); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 38 | |
| 39 | /** |
| 40 | * Deletes a table from the database. |
| 41 | * @param name name of the table to delete. |
| 42 | */ |
| 43 | public void dropTable(String name); |
| 44 | |
| 45 | /** |
| 46 | * Deletes all tables from the database. |
| 47 | */ |
| 48 | public void dropAllTables(); |
Yuta HIGUCHI | 60731cb | 2014-11-11 01:34:46 -0800 | [diff] [blame] | 49 | |
| 50 | |
| 51 | /** |
| 52 | * Add member to default Tablet. |
| 53 | * |
| 54 | * @param node to add |
| 55 | */ |
| 56 | public void addMember(ControllerNode node); |
| 57 | |
| 58 | /** |
| 59 | * Remove member from default Tablet. |
| 60 | * |
| 61 | * @param node node to remove |
| 62 | */ |
| 63 | public void removeMember(ControllerNode node); |
| 64 | |
| 65 | /** |
| 66 | * List members forming default Tablet. |
| 67 | * |
| 68 | * @return Copied collection of members forming default Tablet. |
| 69 | */ |
| 70 | public Collection<ControllerNode> listMembers(); |
Yuta HIGUCHI | f0f2dfc | 2014-11-26 13:59:07 -0800 | [diff] [blame] | 71 | |
| 72 | /** |
| 73 | * Returns the current Leader of the default Tablet. |
| 74 | * |
| 75 | * @return leader node |
| 76 | */ |
| 77 | public Optional<ControllerNode> leader(); |
Madan Jampani | 08822c4 | 2014-11-04 17:17:46 -0800 | [diff] [blame] | 78 | } |