blob: a39c9567dfd41ed57c4a28dea7d7caebe4d0208a (
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
|
/*
* 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.segmentrouting.config;
import java.util.List;
import java.util.Map;
import org.onlab.packet.Ip4Address;
import org.onlab.packet.Ip4Prefix;
import org.onlab.packet.MacAddress;
import org.onosproject.net.DeviceId;
import org.onosproject.net.PortNumber;
/**
* Mechanism through which group handler module retrieves
* the device specific attributes such as segment ID,
* Mac address...etc from group handler applications.
*/
public interface DeviceProperties {
/**
* Checks if the device is configured.
*
* @param deviceId device identifier
* @return true if the device is configured
*/
boolean isConfigured(DeviceId deviceId);
/**
* Returns the segment id of a device to be used in group creation.
*
* @param deviceId device identifier
* @throws DeviceConfigNotFoundException if the device configuration is not found
* @return segment id of a device
*/
int getSegmentId(DeviceId deviceId) throws DeviceConfigNotFoundException;
/**
* Returns the Mac address of a device to be used in group creation.
*
* @param deviceId device identifier
* @throws DeviceConfigNotFoundException if the device configuration is not found
* @return mac address of a device
*/
MacAddress getDeviceMac(DeviceId deviceId) throws DeviceConfigNotFoundException;
/**
* Returns the router ip address of a segment router.
*
* @param deviceId device identifier
* @throws DeviceConfigNotFoundException if the device configuration is not found
* @return router ip address
*/
Ip4Address getRouterIp(DeviceId deviceId) throws DeviceConfigNotFoundException;
/**
* Indicates whether a device is edge device or transit/core device.
*
* @param deviceId device identifier
* @throws DeviceConfigNotFoundException if the device configuration is not found
* @return boolean
*/
boolean isEdgeDevice(DeviceId deviceId) throws DeviceConfigNotFoundException;
/**
* Returns all segment IDs to be considered in building auto
*
* created groups.
* @return list of segment IDs
*/
List<Integer> getAllDeviceSegmentIds();
/**
* Returns subnet-to-ports mapping of given device.
*
* For each entry of the map
* Key: a subnet
* Value: a list of ports, which are bound to the subnet
*
* @param deviceId device identifier
* @return a map that contains all subnet-to-ports mapping of given device
*/
Map<Ip4Prefix, List<PortNumber>> getSubnetPortsMap(DeviceId deviceId);
}
|
