Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 1 | package org.onlab.onos.cluster; |
| 2 | |
| 3 | import java.util.Set; |
| 4 | |
| 5 | import org.onlab.onos.net.DeviceId; |
| 6 | import org.onlab.onos.net.MastershipRole; |
| 7 | |
| 8 | /** |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 9 | * Manages inventory of mastership roles for devices, across controller |
| 10 | * instances; not intended for direct use. |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 11 | */ |
| 12 | public interface MastershipStore { |
| 13 | |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 14 | // three things to map: NodeId, DeviceId, MastershipRole |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 15 | |
| 16 | /** |
| 17 | * Sets a device's role for a specified controller instance. |
| 18 | * |
| 19 | * @param instance controller instance identifier |
| 20 | * @param deviceId device identifier |
| 21 | * @param role new role |
| 22 | * @return a mastership event |
| 23 | */ |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 24 | MastershipEvent setRole(NodeId instance, DeviceId deviceId, |
tom | fc9a4ff | 2014-09-22 18:22:47 -0700 | [diff] [blame] | 25 | MastershipRole role); |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 26 | |
| 27 | /** |
Ayaka Koshibe | 1660969 | 2014-09-23 12:46:15 -0700 | [diff] [blame^] | 28 | * Adds or updates mastership information for a device. |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 29 | * |
| 30 | * @param instance controller instance identifier |
| 31 | * @param deviceId device identifier |
| 32 | * @param role new role |
| 33 | * @return a mastership event |
| 34 | */ |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 35 | MastershipEvent addOrUpdateDevice(NodeId instance, DeviceId deviceId, |
tom | fc9a4ff | 2014-09-22 18:22:47 -0700 | [diff] [blame] | 36 | MastershipRole role); |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 37 | |
| 38 | /** |
| 39 | * Returns the master for a device. |
| 40 | * |
| 41 | * @param deviceId the device identifier |
| 42 | * @return the instance identifier of the master |
| 43 | */ |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 44 | NodeId getMaster(DeviceId deviceId); |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 45 | |
| 46 | /** |
| 47 | * Returns the devices that a controller instance is master of. |
| 48 | * |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 49 | * @param nodeId the instance identifier |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 50 | * @return a set of device identifiers |
| 51 | */ |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 52 | Set<DeviceId> getDevices(NodeId nodeId); |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 53 | |
| 54 | /** |
| 55 | * Returns the role of a device for a specific controller instance. |
| 56 | * |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 57 | * @param nodeId the instance identifier |
tom | fc9a4ff | 2014-09-22 18:22:47 -0700 | [diff] [blame] | 58 | * @param deviceId the device identifiers |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 59 | * @return the role |
| 60 | */ |
tom | e472987 | 2014-09-23 00:37:37 -0700 | [diff] [blame] | 61 | MastershipRole getRole(NodeId nodeId, DeviceId deviceId); |
Ayaka Koshibe | 8d504a9 | 2014-09-22 17:07:36 -0700 | [diff] [blame] | 62 | } |