Satish K | f6d87cb | 2015-11-30 19:59:22 +0530 | [diff] [blame] | 1 | /* |
Brian O'Connor | a09fe5b | 2017-08-03 21:12:30 -0700 | [diff] [blame] | 2 | * Copyright 2015-present Open Networking Foundation |
Satish K | f6d87cb | 2015-11-30 19:59:22 +0530 | [diff] [blame] | 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.iptopology.api.device; |
| 17 | |
| 18 | import org.onosproject.iptopology.api.DeviceTed; |
| 19 | import org.onosproject.iptopology.api.IpDevice; |
| 20 | import org.onosproject.iptopology.api.IpDeviceIdentifier; |
| 21 | import org.onosproject.net.Description; |
| 22 | |
| 23 | |
| 24 | import java.net.URI; |
| 25 | |
| 26 | /** |
| 27 | * Carrier of immutable information about an ip device. |
| 28 | */ |
| 29 | public interface IpDeviceDescription extends Description { |
| 30 | |
| 31 | /** |
| 32 | * Protocol/provider specific URI that can be used to encode the identity |
| 33 | * information required to communicate with the ip device externally, e.g. |
| 34 | * datapath ID. |
| 35 | * |
| 36 | * @return provider specific URI for the ip device |
| 37 | */ |
Jonathan Hart | 51539b8 | 2015-10-29 09:53:04 -0700 | [diff] [blame] | 38 | URI deviceUri(); |
Satish K | f6d87cb | 2015-11-30 19:59:22 +0530 | [diff] [blame] | 39 | |
| 40 | /** |
Ray Milkey | c108a6b | 2017-08-23 15:23:50 -0700 | [diff] [blame] | 41 | * Returns the type of the ip device. For ex: Pseudo or actual |
Satish K | f6d87cb | 2015-11-30 19:59:22 +0530 | [diff] [blame] | 42 | * |
| 43 | * @return type of the device |
| 44 | */ |
| 45 | IpDevice.Type type(); |
| 46 | |
| 47 | /** |
| 48 | * Returns the device identifier details. |
| 49 | * |
| 50 | * @return identifier of the device |
| 51 | */ |
| 52 | IpDeviceIdentifier deviceIdentifier(); |
| 53 | |
| 54 | /** |
| 55 | * Returns the traffic engineering parameters of the device. |
| 56 | * |
| 57 | * @return traffic engineering parameters of the device |
| 58 | */ |
| 59 | DeviceTed deviceTed(); |
| 60 | |
| 61 | } |