1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
|
/*
* Copyright 2014-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.mastership;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import org.onosproject.cluster.NodeId;
import org.onosproject.cluster.RoleInfo;
import org.onosproject.net.DeviceId;
import org.onosproject.net.MastershipRole;
import org.onosproject.store.Store;
/**
* Manages inventory of mastership roles for devices, across controller
* instances; not intended for direct use.
*/
public interface MastershipStore extends Store<MastershipEvent, MastershipStoreDelegate> {
// three things to map: NodeId, DeviceId, MastershipRole
/**
* Requests role of the local node for the specified device.
*
* @param deviceId device identifier
* @return established or newly negotiated mastership role
*/
CompletableFuture<MastershipRole> requestRole(DeviceId deviceId);
/**
* Returns the role of a device for a specific controller instance.
*
* @param nodeId the instance identifier
* @param deviceId the device identifiers
* @return the role
*/
MastershipRole getRole(NodeId nodeId, DeviceId deviceId);
/**
* Returns the master for a device.
*
* @param deviceId the device identifier
* @return the instance identifier of the master
*/
NodeId getMaster(DeviceId deviceId);
/**
* Returns the master and backup nodes for a device.
*
* @param deviceId the device identifier
* @return a RoleInfo containing controller IDs
*/
RoleInfo getNodes(DeviceId deviceId);
/**
* Returns the devices that a controller instance is master of.
*
* @param nodeId the instance identifier
* @return a set of device identifiers
*/
Set<DeviceId> getDevices(NodeId nodeId);
/**
* Sets a device's role for a specified controller instance.
*
* @param nodeId controller instance identifier
* @param deviceId device identifier
* @return a mastership event
*/
CompletableFuture<MastershipEvent> setMaster(NodeId nodeId, DeviceId deviceId);
/**
* Returns the current master and number of past mastership hand-offs
* (terms) for a device.
*
* @param deviceId the device identifier
* @return the current master's ID and the term value for device, or null
*/
MastershipTerm getTermFor(DeviceId deviceId);
/**
* Sets a controller instance's mastership role to STANDBY for a device.
* If the role is MASTER, another controller instance will be selected
* as a candidate master.
*
* @param nodeId the controller instance identifier
* @param deviceId device to revoke mastership role for
* @return a mastership event
*/
CompletableFuture<MastershipEvent> setStandby(NodeId nodeId, DeviceId deviceId);
/**
* Allows a controller instance to give up its current role for a device.
* If the role is MASTER, another controller instance will be selected
* as a candidate master.
*
* @param nodeId the controller instance identifier
* @param deviceId device to revoke mastership role for
* @return a mastership event
*/
CompletableFuture<MastershipEvent> relinquishRole(NodeId nodeId, DeviceId deviceId);
/**
* Removes all the roles for the specified controller instance.
* If the role was MASTER, another controller instance will be selected
* as a candidate master.
*
* @param nodeId the controller instance identifier
*/
void relinquishAllRole(NodeId nodeId);
}
|
