blob: a709f5cfd9e6ab8b5298132aa0c66e4f3d31191a (
plain)
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
|
/*
* Copyright 2014 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 static org.onosproject.net.MastershipRole.MASTER;
import java.util.Set;
import java.util.concurrent.CompletableFuture;
import org.onosproject.cluster.NodeId;
import org.onosproject.cluster.RoleInfo;
import org.onosproject.event.ListenerService;
import org.onosproject.net.DeviceId;
import org.onosproject.net.MastershipRole;
/**
* Service responsible for determining the controller instance mastership of
* a device in a clustered environment. This is the central authority for
* determining mastership, but is not responsible for actually applying it
* to the devices; this falls on the device service.
*/
public interface MastershipService
extends ListenerService<MastershipEvent, MastershipListener> {
/**
* Returns the role of the local node for the specified device, without
* triggering master selection.
*
* @param deviceId the the identifier of the device
* @return role of the current node
*/
MastershipRole getLocalRole(DeviceId deviceId);
/**
* Returns true if the local controller is the Master for the specified deviceId.
*
* @param deviceId the the identifier of the device
* @return true if local node is master; false otherwise
*/
default boolean isLocalMaster(DeviceId deviceId) {
return getLocalRole(deviceId) == MASTER;
}
/**
* Returns the mastership status of the local controller for a given
* device forcing master selection if necessary.
*
* @param deviceId the the identifier of the device
* @return the role of this controller instance
*/
CompletableFuture<MastershipRole> requestRoleFor(DeviceId deviceId);
/**
* Abandons mastership of the specified device on the local node thus
* forcing selection of a new master. If the local node is not a master
* for this device, no master selection will occur.
*
* @param deviceId the identifier of the device
* @return future that is completed when relinquish is complete
*/
CompletableFuture<Void> relinquishMastership(DeviceId deviceId);
/**
* Returns the current master for a given device.
*
* @param deviceId the identifier of the device
* @return the ID of the master controller for the device
*/
NodeId getMasterFor(DeviceId deviceId);
/**
* Returns controllers connected to a given device, in order of
* preference. The first entry in the list is the current master.
*
* @param deviceId the identifier of the device
* @return a list of controller IDs
*/
RoleInfo getNodesFor(DeviceId deviceId);
/**
* Returns the devices for which a controller is master.
*
* @param nodeId the ID of the controller
* @return a set of device IDs
*/
Set<DeviceId> getDevicesOf(NodeId nodeId);
}
|
