sunish vk | 7bdf4d4 | 2016-06-24 12:29:43 +0530 | [diff] [blame] | 1 | /* |
| 2 | * Copyright 2016 Open Networking Laboratory |
| 3 | * |
| 4 | * Licensed under the Apache License, Version 2.0 (the "License"); |
| 5 | * you may not use this file except in compliance with the License. |
| 6 | * You may obtain a copy of the License at |
| 7 | * |
| 8 | * http://www.apache.org/licenses/LICENSE-2.0 |
| 9 | * |
| 10 | * Unless required by applicable law or agreed to in writing, software |
| 11 | * distributed under the License is distributed on an "AS IS" BASIS, |
| 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. |
| 13 | * See the License for the specific language governing permissions and |
| 14 | * limitations under the License. |
| 15 | */ |
| 16 | package org.onosproject.isis.controller.topology; |
| 17 | |
| 18 | import java.util.Map; |
| 19 | |
| 20 | /** |
| 21 | * Represents IP topology for ISIS device and link details. |
| 22 | */ |
| 23 | public interface TopologyForDeviceAndLink { |
| 24 | |
| 25 | /** |
| 26 | * Gets the device information. |
| 27 | * |
| 28 | * @return device information |
| 29 | */ |
| 30 | Map<String, DeviceInformation> deviceInformationMap(); |
| 31 | |
| 32 | /** |
| 33 | * Sets the device information. |
| 34 | * |
| 35 | * @param key system ID of the device as key |
| 36 | * @param deviceInformationMap device information instance |
| 37 | */ |
| 38 | void setDeviceInformationMap(String key, DeviceInformation deviceInformationMap); |
| 39 | |
| 40 | /** |
| 41 | * Gets the link information. |
| 42 | * |
| 43 | * @return link information |
| 44 | */ |
| 45 | Map<String, LinkInformation> linkInformationMap(); |
| 46 | |
| 47 | /** |
| 48 | * Sets link information. |
| 49 | * |
| 50 | * @param key system ID of the device as key |
| 51 | * @param linkInformationMap link information instance |
| 52 | */ |
| 53 | void setLinkInformationMap(String key, LinkInformation linkInformationMap); |
| 54 | |
| 55 | /** |
| 56 | * Removes link information. |
| 57 | * |
| 58 | * @param key key used to remove from map |
| 59 | */ |
| 60 | void removeLinkInformationMap(String key); |
| 61 | |
| 62 | /** |
| 63 | * Removes device information. |
| 64 | * |
| 65 | * @param key key used to remove from map |
| 66 | */ |
| 67 | void removeDeviceInformationMap(String key); |
| 68 | |
| 69 | /** |
| 70 | * Removes links from linkInformationMap. |
| 71 | * |
| 72 | * @param linkId ID |
| 73 | */ |
| 74 | void removeLinks(String linkId); |
| 75 | |
| 76 | /** |
| 77 | * Gets deviceInformation as map. |
| 78 | * |
| 79 | * @return deviceInformationMap to delete from core |
| 80 | */ |
| 81 | Map<String, DeviceInformation> deviceInformationMapToDelete(); |
| 82 | |
| 83 | /** |
| 84 | * Sets deviceInformation as map. |
| 85 | * |
| 86 | * @param key key used to add in map |
| 87 | * @param deviceInformationMapToDelete device information to delete from map |
| 88 | */ |
| 89 | void setDeviceInformationMapToDelete(String key, DeviceInformation deviceInformationMapToDelete); |
| 90 | |
| 91 | /** |
| 92 | * Removes Device Information from deviceInformationMapToDelete. |
| 93 | * |
| 94 | * @param key key to remove from map |
| 95 | */ |
| 96 | void removeDeviceInformationMapFromDeleteMap(String key); |
| 97 | |
| 98 | /** |
| 99 | * Gets deviceInformation as map for Point-To-Point. |
| 100 | * |
| 101 | * @return deviceInformationMap |
| 102 | */ |
| 103 | Map<String, DeviceInformation> deviceInformationMapForPointToPoint(); |
| 104 | |
| 105 | /** |
| 106 | * Sets deviceInformation as map for Point-To-Point.. |
| 107 | * |
| 108 | * @param key key to add to map |
| 109 | * @param deviceInformationMap device information map |
| 110 | */ |
| 111 | void setDeviceInformationMapForPointToPoint(String key, DeviceInformation deviceInformationMap); |
| 112 | |
| 113 | /** |
| 114 | * Gets linkInformation as map for PointToPoint. |
| 115 | * |
| 116 | * @return linkInformationMap |
| 117 | */ |
| 118 | Map<String, LinkInformation> linkInformationMapForPointToPoint(); |
| 119 | |
| 120 | /** |
| 121 | * Sets linkInformation as map for PointToPoint. |
| 122 | * |
| 123 | * @param key key to add link information to map |
| 124 | * @param linkInformationMap link information to add |
| 125 | */ |
| 126 | void setLinkInformationMapForPointToPoint(String key, LinkInformation linkInformationMap); |
| 127 | } |